]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
doc/MANUAL.adoc: Don't use non-ASCII quotes (#761)
authorSergei Trofimovich <slyfox@inbox.ru>
Mon, 11 Jan 2021 20:17:47 +0000 (20:17 +0000)
committerGitHub <noreply@github.com>
Mon, 11 Jan 2021 20:17:47 +0000 (21:17 +0100)
Some locales like "LANG=fr_FR.iso885915@euro make" can't
handle UTF-8 single- and double-quotes:

$ LANG=fr_FR.iso885915@euro make
...
asciidoc: FAILED: MANUAL.adoc: line 529: unexpected error:
...
  File "/usr/lib/python3.8/encodings/iso8859_15.py", line 19, in encode
    return codecs.charmap_encode(input,self.errors,encoding_table)[0]
UnicodeEncodeError: 'charmap' codec can't encode character '\u201c'
  in position 54: character maps to <undefined>

To avoid it the patch uses ASCII equivalents of symbols.

The patch is generated as:

$ sed \
    -e 's/\xE2\x80\x99/'\''/g' \
    -e 's/\xE2\x80\x9C/'\`\`'/g' \
    -e 's/\xE2\x80\x9D/'\'\''/g' \
    -i doc/MANUAL.adoc

Reported-by: Christophe PEREZ
Bug: https://bugs.gentoo.org/762814
Signed-off-by: Sergei Trofimovich <slyfox@gentoo.org>
doc/MANUAL.adoc

index 591650e6e8da806cac9b1eb61a37e9985f4588a1..d4486fcf4ac71f16e0d7760876cf000e505f8d91 100644 (file)
@@ -522,9 +522,9 @@ Semantics of *compression_level*:
     levels are however useful when recompressing the cache with command line
     option *-X/--recompress*.
 *< 0*::
-    A negative value corresponds to Zstandard's “ultra-fast” compression
+    A negative value corresponds to Zstandard's ``ultra-fast'' compression
     levels, which are even faster than level 1 but with less good compression
-    ratios. For instance, level *-3* corresponds to “--fast=3” for the *zstd*
+    ratios. For instance, level *-3* corresponds to ``--fast=3'' for the *zstd*
     command line tool. In practice, there is little use for levels lower than
     *-5* or so.
 *0* (default)::
@@ -586,8 +586,8 @@ See the http://zstd.net[Zstandard documentation] for more information.
 
 [[config_file_clone]] *file_clone* (*CCACHE_FILECLONE* or *CCACHE_NOFILECLONE*, see _<<_boolean_values,Boolean values>>_ above)::
 
-    If true, ccache will attempt to use file cloning (also known as copy on
-    write”, “CoW” or “reflinks”) to store and fetch cached compiler results.
+    If true, ccache will attempt to use file cloning (also known as ``copy on
+    write'', ``CoW'' or ``reflinks'') to store and fetch cached compiler results.
     *file_clone* has priority over <<config_hard_link,*hard_link*>>. The
     default is false.
 +
@@ -946,11 +946,11 @@ Incompressible data:      3.5 GB
 
 Notes:
 
-* The “disk blocks” size is the cache size when taking disk block size into
-  account. This value should match the “cache size” value from “ccache
-  --show-stats. The other size numbers refer to actual content sizes.
-* “Compressed data” refers to result and manifest files stored in the cache.
-* “Incompressible data” refers to files that are always stored uncompressed
+* The ``disk blocks'' size is the cache size when taking disk block size into
+  account. This value should match the ``cache size'' value from ``ccache
+  --show-stats''. The other size numbers refer to actual content sizes.
+* ``Compressed data'' refers to result and manifest files stored in the cache.
+* ``Incompressible data'' refers to files that are always stored uncompressed
   (triggered by enabling <<config_file_clone,*file_clone*>> or
   <<config_hard_link,*hard_link*>>) or unknown files (for instance files
   created by older ccache versions).
@@ -1267,11 +1267,11 @@ In the direct mode, ccache uses the 160 bit BLAKE3 hash of the
 the *ccache-input-c* + *ccache-input-p* data is used in the preprocessor mode.
 
 The *ccache-input-text* file is a combined text version of the three
-binary input files. It has three sections (“COMMON”, “DIRECT MODE” and
-“PREPROCESSOR MODE”), which is turn contain annotations that say what kind of
+binary input files. It has three sections (``COMMON'', ``DIRECT MODE'' and
+``PREPROCESSOR MODE''), which is turn contain annotations that say what kind of
 data comes next.
 
-To debug why you dont get an expected cache hit for an object file, you can do
+To debug why you don't get an expected cache hit for an object file, you can do
 something like this:
 
 1. Build with debug mode enabled.