bitbake-user-manual: fix backslash issues

Message ID 20211119170554.1972442-1-michael.opdenacker@bootlin.com
State Accepted, archived
Commit ffd87a89393f25924f53dbc86dcf5a98c3a8d0ff
Headers show
Series bitbake-user-manual: fix backslash issues | expand

Commit Message

Michael Opdenacker Nov. 19, 2021, 5:05 p.m. UTC
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 .../bitbake-user-manual-fetching.rst          | 20 +++++++++----------
 .../bitbake-user-manual-metadata.rst          | 10 +++++-----
 2 files changed, 15 insertions(+), 15 deletions(-)

Comments

Peter Kjellerstedt Nov. 20, 2021, 5:53 p.m. UTC | #1
> -----Original Message-----
> From: bitbake-devel@lists.openembedded.org <bitbake-devel@lists.openembedded.org> On Behalf Of Michael Opdenacker
> Sent: den 19 november 2021 18:06
> To: bitbake-devel@lists.openembedded.org
> Cc: docs@lists.yoctoproject.org; Michael Opdenacker <michael.opdenacker@bootlin.com>
> Subject: [bitbake-devel] [PATCH] bitbake-user-manual: fix backslash issues
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  .../bitbake-user-manual-fetching.rst          | 20 +++++++++----------
>  .../bitbake-user-manual-metadata.rst          | 10 +++++-----
>  2 files changed, 15 insertions(+), 15 deletions(-)
> 
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
> index 4396830a..260d43ab 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
> @@ -84,18 +84,18 @@ fetcher does know how to use HTTP as a transport.
>  Here are some examples that show commonly used mirror definitions::
> 
>     PREMIRRORS ?= "\
> -      bzr://.*/.\*  http://somemirror.org/sources/ \\n \
> -      cvs://.*/.\*  http://somemirror.org/sources/ \\n \
> -      git://.*/.\*  http://somemirror.org/sources/ \\n \
> -      hg://.*/.\*   http://somemirror.org/sources/ \\n \
> -      osc://.*/.\*  http://somemirror.org/sources/ \\n \
> -      p4://.*/.\*   http://somemirror.org/sources/ \\n \
> -     svn://.*/.\*   http://somemirror.org/sources/ \\n"
> +      bzr://.*/.\*  http://somemirror.org/sources/ \n \
> +      cvs://.*/.\*  http://somemirror.org/sources/ \n \
> +      git://.*/.\*  http://somemirror.org/sources/ \n \
> +      hg://.*/.\*   http://somemirror.org/sources/ \n \
> +      osc://.*/.\*  http://somemirror.org/sources/ \n \
> +      p4://.*/.\*   http://somemirror.org/sources/ \n \
> +     svn://.*/.\*   http://somemirror.org/sources/ \n"
> 
>     MIRRORS =+ "\
> -      ftp://.*/.\*   http://somemirror.org/sources/ \\n \
> -      http://.*/.\*  http://somemirror.org/sources/ \\n \
> -      https://.*/.\* http://somemirror.org/sources/ \\n"
> +      ftp://.*/.\*   http://somemirror.org/sources/ \n \
> +      http://.*/.\*  http://somemirror.org/sources/ \n \
> +      https://.*/.\* http://somemirror.org/sources/ \n"

These were all recently corrected in OE-Core to remove the \n as they 
have not been needed for a long time, so I suggest you do the same here.

>  It is useful to note that BitBake
>  supports cross-URLs. It is possible to mirror a Git repository on an
> diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> index 119720d5..46bcfa60 100644
> --- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> +++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
> @@ -104,15 +104,15 @@ Line Joining
> 
>  Outside of :ref:`functions <bitbake-user-manual/bitbake-user-manual-metadata:functions>`,
>  BitBake joins any line ending in
> -a backslash character ("\") with the following line before parsing
> -statements. The most common use for the "\" character is to split
> +a backslash character ("\\") with the following line before parsing
> +statements. The most common use for the "\\" character is to split
>  variable assignments over multiple lines, as in the following example::
> 
>     FOO = "bar \
>            baz \
>            qaz"
> 
> -Both the "\" character and the newline
> +Both the "\\" character and the newline
>  character that follow it are removed when joining lines. Thus, no
>  newline characters end up in the value of ``FOO``.
> 
> @@ -125,7 +125,7 @@ Consider this additional example where the two assignments both assign
> 
>  .. note::
> 
> -   BitBake does not interpret escape sequences like "\n" in variable
> +   BitBake does not interpret escape sequences like "\\n" in variable
>     values. For these to have an effect, the value must be passed to some
>     utility that interprets escape sequences, such as
>     ``printf`` or ``echo -n``.
> @@ -159,7 +159,7 @@ behavior::
>     C = "qux"
>     *At this point, ${A} equals "qux bar baz"*
>     B = "norf"
> -   *At this point, ${A} equals "norf baz"\*
> +   *At this point, ${A} equals "norf baz"*
> 
>  Contrast this behavior with the
>  :ref:`bitbake-user-manual/bitbake-user-manual-metadata:immediate variable
> --
> 2.25.1

//Peter

Patch

diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 4396830a..260d43ab 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -84,18 +84,18 @@  fetcher does know how to use HTTP as a transport.
 Here are some examples that show commonly used mirror definitions::
 
    PREMIRRORS ?= "\
-      bzr://.*/.\*  http://somemirror.org/sources/ \\n \
-      cvs://.*/.\*  http://somemirror.org/sources/ \\n \
-      git://.*/.\*  http://somemirror.org/sources/ \\n \
-      hg://.*/.\*   http://somemirror.org/sources/ \\n \
-      osc://.*/.\*  http://somemirror.org/sources/ \\n \
-      p4://.*/.\*   http://somemirror.org/sources/ \\n \
-     svn://.*/.\*   http://somemirror.org/sources/ \\n"
+      bzr://.*/.\*  http://somemirror.org/sources/ \n \
+      cvs://.*/.\*  http://somemirror.org/sources/ \n \
+      git://.*/.\*  http://somemirror.org/sources/ \n \
+      hg://.*/.\*   http://somemirror.org/sources/ \n \
+      osc://.*/.\*  http://somemirror.org/sources/ \n \
+      p4://.*/.\*   http://somemirror.org/sources/ \n \
+     svn://.*/.\*   http://somemirror.org/sources/ \n"
 
    MIRRORS =+ "\
-      ftp://.*/.\*   http://somemirror.org/sources/ \\n \
-      http://.*/.\*  http://somemirror.org/sources/ \\n \
-      https://.*/.\* http://somemirror.org/sources/ \\n"
+      ftp://.*/.\*   http://somemirror.org/sources/ \n \
+      http://.*/.\*  http://somemirror.org/sources/ \n \
+      https://.*/.\* http://somemirror.org/sources/ \n"
 
 It is useful to note that BitBake
 supports cross-URLs. It is possible to mirror a Git repository on an
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index 119720d5..46bcfa60 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -104,15 +104,15 @@  Line Joining
 
 Outside of :ref:`functions <bitbake-user-manual/bitbake-user-manual-metadata:functions>`,
 BitBake joins any line ending in
-a backslash character ("\") with the following line before parsing
-statements. The most common use for the "\" character is to split
+a backslash character ("\\") with the following line before parsing
+statements. The most common use for the "\\" character is to split
 variable assignments over multiple lines, as in the following example::
 
    FOO = "bar \
           baz \
           qaz"
 
-Both the "\" character and the newline
+Both the "\\" character and the newline
 character that follow it are removed when joining lines. Thus, no
 newline characters end up in the value of ``FOO``.
 
@@ -125,7 +125,7 @@  Consider this additional example where the two assignments both assign
 
 .. note::
 
-   BitBake does not interpret escape sequences like "\n" in variable
+   BitBake does not interpret escape sequences like "\\n" in variable
    values. For these to have an effect, the value must be passed to some
    utility that interprets escape sequences, such as
    ``printf`` or ``echo -n``.
@@ -159,7 +159,7 @@  behavior::
    C = "qux"
    *At this point, ${A} equals "qux bar baz"*
    B = "norf"
-   *At this point, ${A} equals "norf baz"\*
+   *At this point, ${A} equals "norf baz"*
 
 Contrast this behavior with the
 :ref:`bitbake-user-manual/bitbake-user-manual-metadata:immediate variable