mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Michael Olbrich <m.olbrich@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Roland Hieber <rhi@pengutronix.de>
Subject: Re: [ptxdist] [APPLIED] doc: ref_make_macros: add missing synopses
Date: Thu, 15 Dec 2022 08:34:59 +0100	[thread overview]
Message-ID: <20221215073459.2505051-1-m.olbrich@pengutronix.de> (raw)
In-Reply-To: <20221206111211.3961424-2-rhi@pengutronix.de>

Thanks, applied as a0c33d0210161d49fe19c75ade31fe6d20817b14.

Michael

[sent from post-receive hook]

On Thu, 15 Dec 2022 08:34:59 +0100, Roland Hieber <rhi@pengutronix.de> wrote:
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> Message-Id: <20221206111211.3961424-2-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> 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, <prefix>, <file>)
> +
>  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, <path>, <file>)
> +
>  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, <file>)
> +
> +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.



  reply	other threads:[~2022-12-15  7:35 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-06 11:12 [ptxdist] [PATCH 1/3] doc: ref_make_macros: fix jump target Roland Hieber
2022-12-06 11:12 ` [ptxdist] [PATCH 2/3] doc: ref_make_macros: add missing synopses Roland Hieber
2022-12-15  7:34   ` Michael Olbrich [this message]
2022-12-06 11:12 ` [ptxdist] [PATCH 3/3] doc: ref: document config hash macros and variables Roland Hieber
2022-12-15  7:35   ` [ptxdist] [APPLIED] " Michael Olbrich
2022-12-15  7:34 ` [ptxdist] [APPLIED] doc: ref_make_macros: fix jump target Michael Olbrich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20221215073459.2505051-1-m.olbrich@pengutronix.de \
    --to=m.olbrich@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    --cc=rhi@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox