From mboxrd@z Thu Jan 1 00:00:00 1970 Delivery-date: Thu, 15 Dec 2022 08:35:51 +0100 Received: from metis.ext.pengutronix.de ([2001:67c:670:201:290:27ff:fe1d:cc33]) by lore.white.stw.pengutronix.de with esmtps (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1p5imV-004SPX-8b for lore@lore.pengutronix.de; Thu, 15 Dec 2022 08:35:51 +0100 Received: from localhost ([127.0.0.1] helo=metis.ext.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1p5imT-0001mR-3u; Thu, 15 Dec 2022 08:35:49 +0100 Received: from drehscheibe.grey.stw.pengutronix.de ([2a0a:edc0:0:c01:1d::a2]) by metis.ext.pengutronix.de with esmtps (TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1p5ilg-0000Mx-Jd; Thu, 15 Dec 2022 08:35:00 +0100 Received: from [2a0a:edc0:0:1101:1d::54] (helo=dude05.red.stw.pengutronix.de) by drehscheibe.grey.stw.pengutronix.de with esmtp (Exim 4.94.2) (envelope-from ) id 1p5ilf-004eWx-6y; Thu, 15 Dec 2022 08:35:00 +0100 Received: from mol by dude05.red.stw.pengutronix.de with local (Exim 4.94.2) (envelope-from ) id 1p5ilf-00AVgo-CI; Thu, 15 Dec 2022 08:34:59 +0100 From: Michael Olbrich To: ptxdist@pengutronix.de Date: Thu, 15 Dec 2022 08:34:59 +0100 Message-Id: <20221215073459.2505051-1-m.olbrich@pengutronix.de> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221206111211.3961424-2-rhi@pengutronix.de> References: <20221206111211.3961424-2-rhi@pengutronix.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: Re: [ptxdist] [APPLIED] doc: ref_make_macros: add missing synopses X-BeenThere: ptxdist@pengutronix.de X-Mailman-Version: 2.1.29 Precedence: list List-Id: PTXdist Development Mailing List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: ptxdist@pengutronix.de Cc: Roland Hieber Sender: "ptxdist" X-SA-Exim-Connect-IP: 127.0.0.1 X-SA-Exim-Mail-From: ptxdist-bounces@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false Thanks, applied as a0c33d0210161d49fe19c75ade31fe6d20817b14. Michael [sent from post-receive hook] On Thu, 15 Dec 2022 08:34:59 +0100, Roland Hieber wrote: > Signed-off-by: Roland Hieber > Message-Id: <20221206111211.3961424-2-rhi@pengutronix.de> > Signed-off-by: Michael Olbrich > > diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst > index 19efb11f1093..4c1ca2f0375f 100644 > --- a/doc/ref_make_macros.rst > +++ b/doc/ref_make_macros.rst > @@ -787,10 +787,15 @@ whereas if the respective variable is unset, they would expand to the opposite: > ptx/get-alternative > ~~~~~~~~~~~~~~~~~~~ > > +Usage: > + > +.. code-block:: make > + > + $(call ptx/get-alternative, , ) > + > This macro can be used to find files or directories in the BSP and PTXdist. > -There are two arguments, **prefix** and **file**. The search path is very > -similar to :ref:`install_alternative`. The first existing location of the > -following paths is returned: > +The search path is very similar to :ref:`install_alternative`. > +The first existing location of the following paths is returned: > > * ``$(PTXDIST_WORKSPACE)/$(prefix)$(PTXDIST_PLATFORMSUFFIX)/$(file)`` > * ``$(PTXDIST_WORKSPACE)/$(prefix)/$(file)$(PTXDIST_PLATFORMSUFFIX)`` > @@ -805,9 +810,14 @@ following paths is returned: > ptx/in-path > ~~~~~~~~~~~ > > +Usage: > + > +.. code-block:: make > + > + $(call ptx/in-path, , ) > + > This macro can be used to find files or directories in the BSP and PTXdist. > -There are two arguments, **path variable** and **file**. The **path > -variable** must be a variable name that is available in a shell called by > +The **path** must be a variable name that is available in a shell called by > **make**. The variable must contain a ``:`` separated list of directories. > The **file** will be searched in these directories and the first existing > path is returned. PTXdist defines several variables that can be used here. > @@ -831,8 +841,14 @@ directories for each of these variables. > ptx/in-platformconfigdir > ~~~~~~~~~~~~~~~~~~~~~~~~ > > -This macro is only useful with multiple layers. It has one argument > -**file**. The **file** is searched for in the platform directory in > +Usage: > + > +.. code-block:: make > + > + $(call ptx/in-platformconfigdir, ) > + > +This macro is only useful with multiple layers. > +The argument **file** is searched for in the platform directory in > all layers in the usual search order. It returns the first existing file. > If none exists it returns ``$(PTXDIST_PLATFORMCONFIGDIR)/$(file)``. This > avoids unexpected errors due to empty variables if a file is missing.