[ptxdist] [PATCH] doc: ref_make_macros: unify and fix label names

[ptxdist] [PATCH] doc: ref_make_macros: unify and fix label names

[Roland Hieber]

The install_copy label was in the wrong place, remove it. We already
had install_copy,reference too. Remove the ',reference' part from the
already existing to be in line with the other labels in the same file.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 doc/daily_work.inc      | 2 +-
 doc/ref_make_macros.rst | 8 +++-----
 2 files changed, 4 insertions(+), 6 deletions(-)

diff --git a/doc/daily_work.inc b/doc/daily_work.inc
index ca3ea6903db6..8fe7739aa0c8 100644
--- a/doc/daily_work.inc
+++ b/doc/daily_work.inc
@@ -1366,7 +1366,7 @@ permissions related to file permission masks.
 PTXdist requires a ``umask`` of ``0022`` to be able to create files accessible
 by regular users. This is important at build-time, since it propagates to the
 generated target filesystem images as well. For example the ``install_tree``
-macro (refer :ref:`install_tree,reference`) uses the file permissions it finds
+macro (refer :ref:`install_tree`) uses the file permissions it finds
 in the build machine's filesystem also for the target filesystem image. With
 a different ``umask`` than ``0022`` at build-time this may fail badly at
 run-time with strange erroneous behaviour (for example some daemons with
diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst
index b4e181a76c43..6f056adf3e7d 100644
--- a/doc/ref_make_macros.rst
+++ b/doc/ref_make_macros.rst
@@ -80,8 +80,6 @@ Usage:
 
 Removes the given directory ``<directory path>``
 
-.. _install_copy:
-
 world/get, world/extract, world/prepare, world/compile, world/install
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -150,7 +148,7 @@ For ``install`` the package directory is deleted.
 When ``--verbose`` is used then the full command is logged. With
 ``--quiet`` both stdout and stderr are redirected to the logfile.
 
-.. _install_copy,reference:
+.. _install_copy:
 
 install_copy
 ~~~~~~~~~~~~~
@@ -252,7 +250,7 @@ Copy a file from the package install directory to the root filesystem:
 
  $(call install_copy, foo, 0, 0, 0755, -, /usr/bin/foo)
 
-.. _install_tree,reference:
+.. _install_tree:
 
 install_tree
 ~~~~~~~~~~~~
@@ -284,7 +282,7 @@ Some of the parameters have fixed meanings:
 **<destination dir>**
   The basename of the to-be-installed tree in the root filesystem
 **<strip>**
-  same as for :ref:`install_copy,reference`.
+  same as for :ref:`install_copy`.
 
 Note: This installation macro
 
-- 
2.28.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de

Re: [ptxdist] [APPLIED] doc: ref_make_macros: unify and fix label names

[Michael Olbrich]

Thanks, applied as 2460a1d9bf6e475a579c8bccc98c62b12df8a4cc.

Michael

[sent from post-receive hook]

On Fri, 04 Sep 2020 19:01:25 +0200, Roland Hieber <rhi@pengutronix.de> wrote:
> The install_copy label was in the wrong place, remove it. We already
> had install_copy,reference too. Remove the ',reference' part from the
> already existing to be in line with the other labels in the same file.
> 
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>
> Message-Id: <20200819105144.17850-1-rhi@pengutronix.de>
> Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
> 
> diff --git a/doc/daily_work.inc b/doc/daily_work.inc
> index ca3ea6903db6..8fe7739aa0c8 100644
> --- a/doc/daily_work.inc
> +++ b/doc/daily_work.inc
> @@ -1366,7 +1366,7 @@ permissions related to file permission masks.
>  PTXdist requires a ``umask`` of ``0022`` to be able to create files accessible
>  by regular users. This is important at build-time, since it propagates to the
>  generated target filesystem images as well. For example the ``install_tree``
> -macro (refer :ref:`install_tree,reference`) uses the file permissions it finds
> +macro (refer :ref:`install_tree`) uses the file permissions it finds
>  in the build machine's filesystem also for the target filesystem image. With
>  a different ``umask`` than ``0022`` at build-time this may fail badly at
>  run-time with strange erroneous behaviour (for example some daemons with
> diff --git a/doc/ref_make_macros.rst b/doc/ref_make_macros.rst
> index b4e181a76c43..6f056adf3e7d 100644
> --- a/doc/ref_make_macros.rst
> +++ b/doc/ref_make_macros.rst
> @@ -80,8 +80,6 @@ Usage:
>  
>  Removes the given directory ``<directory path>``
>  
> -.. _install_copy:
> -
>  world/get, world/extract, world/prepare, world/compile, world/install
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
> @@ -150,7 +148,7 @@ For ``install`` the package directory is deleted.
>  When ``--verbose`` is used then the full command is logged. With
>  ``--quiet`` both stdout and stderr are redirected to the logfile.
>  
> -.. _install_copy,reference:
> +.. _install_copy:
>  
>  install_copy
>  ~~~~~~~~~~~~~
> @@ -252,7 +250,7 @@ Copy a file from the package install directory to the root filesystem:
>  
>   $(call install_copy, foo, 0, 0, 0755, -, /usr/bin/foo)
>  
> -.. _install_tree,reference:
> +.. _install_tree:
>  
>  install_tree
>  ~~~~~~~~~~~~
> @@ -284,7 +282,7 @@ Some of the parameters have fixed meanings:
>  **<destination dir>**
>    The basename of the to-be-installed tree in the root filesystem
>  **<strip>**
> -  same as for :ref:`install_copy,reference`.
> +  same as for :ref:`install_copy`.
>  
>  Note: This installation macro
>  

_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de
To unsubscribe, send a mail with subject "unsubscribe" to ptxdist-request@pengutronix.de