Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3ea54d9b authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-5.3-1' of git://git.lwn.net/linux 

Pull documentation fixes from Jonathan Corbet:
 "This is mostly a set of follow-on fixes from Mauro fixing various
  fallout from the massive RST conversion; a few other small fixes as
  well"

* tag 'docs-5.3-1' of git://git.lwn.net/linux: (21 commits)
  docs: phy: Drop duplicate 'be made'
  doc:it_IT: translations in process/
  docs/vm: transhuge: fix typo in madvise reference
  doc:it_IT: rephrase statement
  doc:it_IT: align translation to mainline
  docs: load_config.py: ensure subdirs end with "/"
  docs: virtual: add it to the documentation body
  docs: remove extra conf.py files
  docs: load_config.py: avoid needing a conf.py just due to LaTeX docs
  scripts/sphinx-pre-install: seek for Noto CJK fonts for pdf output
  scripts/sphinx-pre-install: cleanup Gentoo checks
  scripts/sphinx-pre-install: fix latexmk dependencies
  scripts/sphinx-pre-install: don't use LaTeX with CentOS 7
  scripts/sphinx-pre-install: fix script for RHEL/CentOS
  docs: conf.py: only use CJK if the font is available
  docs: conf.py: add CJK package needed by translations
  docs: pdf: add all Documentation/*/index.rst to PDF output
  docs: fix broken doc references due to renames
  docs: power: add it to to the main documentation index
  docs: powerpc: convert docs to ReST and rename to *.rst
  ...
parents 0ed28866 d2eba640

Documentation/PCI/pci-error-recovery.rst

+4 −1
Original line number Diff line number Diff line
@@ -403,7 +403,7 @@ That is, the recovery API only requires that: 
.. note::



   Implementation details for the powerpc platform are discussed in

   the file Documentation/powerpc/eeh-pci-error-recovery.txt

   the file Documentation/powerpc/eeh-pci-error-recovery.rst



   As of this writing, there is a growing list of device drivers with

   patches implementing error recovery. Not all of these patches are in
@@ -422,3 +422,6 @@ That is, the recovery API only requires that: 
   - drivers/net/cxgb3

   - drivers/net/s2io.c

   - drivers/net/qlge



The End

-------

Documentation/RCU/rculist_nulls.txt

+1 −1
Original line number Diff line number Diff line 
Using hlist_nulls to protect read-mostly linked lists and

objects using SLAB_TYPESAFE_BY_RCU allocations.



Please read the basics in Documentation/RCU/listRCU.txt

Please read the basics in Documentation/RCU/listRCU.rst



Using special makers (called 'nulls') is a convenient way

to solve following problem :

Documentation/admin-guide/conf.py

deleted100644 → 0
+0 −10
Original line number Diff line number Diff line 
# -*- coding: utf-8; mode: python -*-



project = 'Linux Kernel User Documentation'



tags.add("subproject")



latex_documents = [

    ('index', 'linux-user.tex', 'Linux Kernel User Documentation',

     'The kernel development community', 'manual'),

]

Documentation/admin-guide/mm/transhuge.rst

+1 −1
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ disabled, there is ``khugepaged`` daemon that scans memory and 
collapses sequences of basic pages into huge pages.



The THP behaviour is controlled via :ref:`sysfs <thp_sysfs>`

interface and using madivse(2) and prctl(2) system calls.

interface and using madvise(2) and prctl(2) system calls.



Transparent Hugepage Support maximizes the usefulness of free memory

if compared to the reservation approach of hugetlbfs by allowing all

Documentation/conf.py

+29 −1
Original line number Diff line number Diff line
@@ -16,6 +16,8 @@ import sys 
import os

import sphinx



from subprocess import check_output



# Get Sphinx version

major, minor, patch = sphinx.version_info[:3]
@@ -276,10 +278,21 @@ latex_elements = { 
        \\setsansfont{DejaVu Sans}

        \\setromanfont{DejaVu Serif}

        \\setmonofont{DejaVu Sans Mono}



     '''

}



# At least one book (translations) may have Asian characters

# with are only displayed if xeCJK is used



cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore')

if cjk_cmd.find("Noto Sans CJK SC") >= 0:

    print ("enabling CJK for LaTeX builder")

    latex_elements['preamble']  += '''

	% This is needed for translations

        \\usepackage{xeCJK}

        \\setCJKmainfont{Noto Sans CJK SC}

     '''



# Fix reference escape troubles with Sphinx 1.4.x

if major == 1 and minor > 3:

    latex_elements['preamble']  += '\\renewcommand*{\\DUrole}[2]{ #2 }\n'
@@ -410,6 +423,21 @@ latex_documents = [ 
     'The kernel development community', 'manual'),

]



# Add all other index files from Documentation/ subdirectories

for fn in os.listdir('.'):

    doc = os.path.join(fn, "index")

    if os.path.exists(doc + ".rst"):

        has = False

        for l in latex_documents:

            if l[0] == doc:

                has = True

                break

        if not has:

            latex_documents.append((doc, fn + '.tex',

                                    'Linux %s Documentation' % fn.capitalize(),

                                    'The kernel development community',

                                    'manual'))



# The name of an image file (relative to this directory) to place at the top of

# the title page.

#latex_logo = None