lkml.org 
[lkml]   [2021]   [May]   [12]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v2 27/40] docs: x86: Use ASCII subset instead of UTF-8 alternate symbols
    Date
    The conversion tools used during DocBook/LaTeX/Markdown->ReST conversion
    and some automatic rules which exists on certain text editors like
    LibreOffice turned ASCII characters into some UTF-8 alternatives that
    are better displayed on html and PDF.

    While it is OK to use UTF-8 characters in Linux, it is better to
    use the ASCII subset instead of using an UTF-8 equivalent character
    as it makes life easier for tools like grep, and are easier to edit
    with the some commonly used text/source code editors.

    Also, Sphinx already do such conversion automatically outside literal blocks:
    https://docutils.sourceforge.io/docs/user/smartquotes.html

    So, replace the occurences of the following UTF-8 characters:

    - U+201c ('“'): LEFT DOUBLE QUOTATION MARK
    - U+201d ('”'): RIGHT DOUBLE QUOTATION MARK

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    Documentation/x86/resctrl.rst | 2 +-
    Documentation/x86/sgx.rst | 4 ++--
    2 files changed, 3 insertions(+), 3 deletions(-)

    diff --git a/Documentation/x86/resctrl.rst b/Documentation/x86/resctrl.rst
    index 71a531061e4e..511cd5b76ed1 100644
    --- a/Documentation/x86/resctrl.rst
    +++ b/Documentation/x86/resctrl.rst
    @@ -519,7 +519,7 @@ Cache pseudo-locking increases the probability that data will remain
    in the cache via carefully configuring the CAT feature and controlling
    application behavior. There is no guarantee that data is placed in
    cache. Instructions like INVD, WBINVD, CLFLUSH, etc. can still evict
    -“locked” data from cache. Power management C-states may shrink or
    +"locked" data from cache. Power management C-states may shrink or
    power off cache. Deeper C-states will automatically be restricted on
    pseudo-locked region creation.

    diff --git a/Documentation/x86/sgx.rst b/Documentation/x86/sgx.rst
    index dd0ac96ff9ef..7ccf63d0d083 100644
    --- a/Documentation/x86/sgx.rst
    +++ b/Documentation/x86/sgx.rst
    @@ -88,7 +88,7 @@ Enclave build functions
    -----------------------

    In addition to the traditional compiler and linker build process, SGX has a
    -separate enclave “build” process. Enclaves must be built before they can be
    +separate enclave "build" process. Enclaves must be built before they can be
    executed (entered). The first step in building an enclave is opening the
    **/dev/sgx_enclave** device. Since enclave memory is protected from direct
    access, special privileged instructions are Then used to copy data into enclave
    @@ -147,7 +147,7 @@ Page reclaimer

    Similar to the core kswapd, ksgxd, is responsible for managing the
    overcommitment of enclave memory. If the system runs out of enclave memory,
    -*ksgxwapd* “swaps” enclave memory to normal memory.
    +*ksgxwapd* "swaps" enclave memory to normal memory.

    Launch Control
    ==============
    --
    2.30.2
    \
     
     \ /
      Last update: 2021-05-12 14:54    [W:4.541 / U:0.096 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site