Skip to contentSkip to conversation

manual/configure.txt: fix C++ escaping

PATCH New Thomas De Schampheleire 2 participants 2 messages May 2, 2014

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 manual/configure.txt: fix C++ escaping

For asciidoc, a string like '+these are some words+' will be displayed in monospace font. Such sequences are identified by searching for a matching pair of + signs in the same block.

The string 'C++' also contains such + signs. In most cases, this does not pose a problem and no escaping is necessary. However, if 'C++' occurs twice in the same block, the + signs will be matched to each other, and asciidoc formats all text between them as monospaced text. In this case, escaping of one of these 'C++' occurances is necessary to get the right formatting.

In one place of the manual, there is a sentence that causes such a problem:
"you only have to tell whether your toolchain supports C++ or not and whether it has built-in RPC support. If your external toolchain uses the 'uClibc' library, then you have to tell Buildroot if it supports largefile, IPv6, RPC, wide-char, locale, program invocation, threads and C++."

Commit 082dec8ce440236b1477e568f0965f05ad241adb was based on a patch fixing this problem in one place of the manual, but was incorrectly changed while committing.

This patch reverts the incorrect changes in that commit, and solves the problem correctly.

---
v4:
- (ThomasDS) update commit message
v3:
- rebase on top of the master
v2:
- remove only one backslash

 docs/manual/configure.txt |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
docs/manual/configure.txt +2 -2
@@ -100,7 +100,7 @@ most important ones allow to:
    toolchain should have largefile support (i.e. support for files
    larger than 2 GB on 32 bits systems), IPv6 support, RPC support
    (used mainly for NFS), wide-char support, locale support (for
-   internationalization), C\++ support or thread support. Depending on
+   internationalization), C++ support or thread support. Depending on
    which options you choose, the number of userspace applications and
    libraries visible in Buildroot menus will change: many applications
    and libraries require certain toolchain options to be enabled. Most
@@ -165,7 +165,7 @@ Then, you have three solutions to use an
   prefix+ and +External toolchain C library+ options. Then, you have
   to tell Buildroot what your external toolchain supports. If your
   external toolchain uses the 'glibc' library, you only have to tell
-  whether your toolchain supports C++ or not and whether it has
+  whether your toolchain supports C\++ or not and whether it has
   built-in RPC support. If your external toolchain uses the 'uClibc'
   library, then you have to tell Buildroot if it supports largefile,
   IPv6, RPC, wide-char, locale, program invocation, threads and
#1 lore raw

PATCH v4 1/1 manual/configure.txt: fix C++ escaping

Quoted 26 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"Thomas" == Thomas De Schampheleire <[email protected]> writes:

For asciidoc, a string like '+these are some words+' will be displayed in monospace font. Such sequences are identified by searching for a matching pair of + signs in the same block.

The string 'C++' also contains such + signs. In most cases, this does not pose a problem and no escaping is necessary. However, if 'C++' occurs twice in the same block, the + signs will be matched to each other, and asciidoc formats all text between them as monospaced text. In this case, escaping of one of these 'C++' occurances is necessary to get the right formatting.

In one place of the manual, there is a sentence that causes such a problem:
"you only have to tell whether your toolchain supports C++ or not and whether it has built-in RPC support. If your external toolchain uses the 'uClibc' library, then you have to tell Buildroot if it supports largefile, IPv6, RPC, wide-char, locale, program invocation, threads and C++."

Commit 082dec8ce440236b1477e568f0965f05ad241adb was based on a patch fixing this problem in one place of the manual, but was incorrectly changed while committing.

This patch reverts the incorrect changes in that commit, and solves the problem correctly.

Quoted 6 lines

---
v4:
- (ThomasDS) update commit message

Committed, thanks.

Signature · 1 line
Bye, Peter Korsgaard