Commit 4ae275bc authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-5.16-2' of git://git.lwn.net/linux 

Pull documentation fixes from Jonathan Corbet:
 "A handful of documentation fixes for 5.16"

* tag 'docs-5.16-2' of git://git.lwn.net/linux:
  Documentation/process: fix a cross reference
  Documentation: update vcpu-requests.rst reference
  docs: accounting: update delay-accounting.rst reference
  libbpf: update index.rst reference
  docs: filesystems: Fix grammatical error "with" to "which"
  doc/zh_CN: fix a translation error in management-style
  docs: ftrace: fix the wrong path of tracefs
  Documentation: arm: marvell: Fix link to armada_1000_pb.pdf document
  Documentation: arm: marvell: Put Armada XP section between Armada 370 and 375
  Documentation: arm: marvell: Add some links to homepage / product infos
  docs: Update Sphinx requirements
parents 7d5775d4 b96ff02a

Documentation/admin-guide/sysctl/kernel.rst

+1 −1
Original line number Diff line number Diff line
@@ -1099,7 +1099,7 @@ task_delayacct 
===============



Enables/disables task delay accounting (see

:doc:`accounting/delay-accounting.rst`). Enabling this feature incurs

Documentation/accounting/delay-accounting.rst. Enabling this feature incurs

a small amount of overhead in the scheduler but is useful for debugging

and performance tuning. It is required by some tools such as iotop.

Documentation/arm/marvell.rst

+24 −24
Original line number Diff line number Diff line
@@ -104,6 +104,8 @@ Discovery family 


                Not supported by the Linux kernel.



  Homepage:

        https://web.archive.org/web/20110924171043/http://www.marvell.com/embedded-processors/discovery-innovation/

  Core:

	Feroceon 88fr571-vd ARMv5 compatible
@@ -120,6 +122,7 @@ EBU Armada family 
        - 88F6707

        - 88F6W11



    - Product infos:   https://web.archive.org/web/20141002083258/http://www.marvell.com/embedded-processors/armada-370/

    - Product Brief:   https://web.archive.org/web/20121115063038/http://www.marvell.com/embedded-processors/armada-300/assets/Marvell_ARMADA_370_SoC.pdf

    - Hardware Spec:   https://web.archive.org/web/20140617183747/http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-datasheet.pdf

    - Functional Spec: https://web.archive.org/web/20140617183701/http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA370-FunctionalSpec-datasheet.pdf
@@ -127,9 +130,29 @@ EBU Armada family 
  Core:

	Sheeva ARMv7 compatible PJ4B



  Armada XP Flavors:

        - MV78230

        - MV78260

        - MV78460



    NOTE:

	not to be confused with the non-SMP 78xx0 SoCs



    - Product infos:   https://web.archive.org/web/20150101215721/http://www.marvell.com/embedded-processors/armada-xp/

    - Product Brief:   https://web.archive.org/web/20121021173528/http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf

    - Functional Spec: https://web.archive.org/web/20180829171131/http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf

    - Hardware Specs:

        - https://web.archive.org/web/20141127013651/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF

        - https://web.archive.org/web/20141222000224/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78260_OS.PDF

        - https://web.archive.org/web/20141222000230/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF



  Core:

	Sheeva ARMv7 compatible Dual-core or Quad-core PJ4B-MP



  Armada 375 Flavors:

	- 88F6720



    - Product infos: https://web.archive.org/web/20140108032402/http://www.marvell.com/embedded-processors/armada-375/

    - Product Brief: https://web.archive.org/web/20131216023516/http://www.marvell.com/embedded-processors/armada-300/assets/ARMADA_375_SoC-01_product_brief.pdf



  Core:
@@ -162,29 +185,6 @@ EBU Armada family 
  Core:

	ARM Cortex-A9



  Armada XP Flavors:

        - MV78230

        - MV78260

        - MV78460



    NOTE:

	not to be confused with the non-SMP 78xx0 SoCs



    Product Brief:

	https://web.archive.org/web/20121021173528/http://www.marvell.com/embedded-processors/armada-xp/assets/Marvell-ArmadaXP-SoC-product%20brief.pdf



    Functional Spec:

	https://web.archive.org/web/20180829171131/http://www.marvell.com/embedded-processors/armada-xp/assets/ARMADA-XP-Functional-SpecDatasheet.pdf



    - Hardware Specs:



        - https://web.archive.org/web/20141127013651/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78230_OS.PDF

        - https://web.archive.org/web/20141222000224/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78260_OS.PDF

        - https://web.archive.org/web/20141222000230/http://www.marvell.com/embedded-processors/armada-xp/assets/HW_MV78460_OS.PDF



  Core:

	Sheeva ARMv7 compatible Dual-core or Quad-core PJ4B-MP



  Linux kernel mach directory:

	arch/arm/mach-mvebu

  Linux kernel plat directory:
@@ -436,7 +436,7 @@ Berlin family (Multimedia Solutions) 
  - Flavors:

	- 88DE3010, Armada 1000 (no Linux support)

		- Core:		Marvell PJ1 (ARMv5TE), Dual-core

		- Product Brief:	http://www.marvell.com.cn/digital-entertainment/assets/armada_1000_pb.pdf

		- Product Brief:	https://web.archive.org/web/20131103162620/http://www.marvell.com/digital-entertainment/assets/armada_1000_pb.pdf

	- 88DE3005, Armada 1500 Mini

		- Design name:	BG2CD

		- Core:		ARM Cortex-A9, PL310 L2CC

Documentation/bpf/index.rst

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ that goes into great technical depth about the BPF Architecture. 
libbpf

======



Documentation/bpf/libbpf/libbpf.rst is a userspace library for loading and interacting with bpf programs.

Documentation/bpf/libbpf/index.rst is a userspace library for loading and interacting with bpf programs.



BPF Type Format (BTF)

=====================

Documentation/doc-guide/sphinx.rst

+9 −13
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ Sphinx Install 
==============



The ReST markups currently used by the Documentation/ files are meant to be

built with ``Sphinx`` version 1.3 or higher.

built with ``Sphinx`` version 1.7 or higher.



There's a script that checks for the Sphinx requirements. Please see

:ref:`sphinx-pre-install` for further details.
@@ -43,10 +43,6 @@ or ``virtualenv``, depending on how your distribution packaged Python 3. 


.. note::



   #) Sphinx versions below 1.5 don't work properly with Python's

      docutils version 0.13.1 or higher. So, if you're willing to use

      those versions, you should run ``pip install 'docutils==0.12'``.



   #) It is recommended to use the RTD theme for html output. Depending

      on the Sphinx version, it should be installed separately,

      with ``pip install sphinx_rtd_theme``.
@@ -55,13 +51,13 @@ or ``virtualenv``, depending on how your distribution packaged Python 3. 
      those expressions are written using LaTeX notation. It needs texlive

      installed with amsfonts and amsmath in order to evaluate them.



In summary, if you want to install Sphinx version 1.7.9, you should do::

In summary, if you want to install Sphinx version 2.4.4, you should do::



       $ virtualenv sphinx_1.7.9

       $ . sphinx_1.7.9/bin/activate

       (sphinx_1.7.9) $ pip install -r Documentation/sphinx/requirements.txt

       $ virtualenv sphinx_2.4.4

       $ . sphinx_2.4.4/bin/activate

       (sphinx_2.4.4) $ pip install -r Documentation/sphinx/requirements.txt



After running ``. sphinx_1.7.9/bin/activate``, the prompt will change,

After running ``. sphinx_2.4.4/bin/activate``, the prompt will change,

in order to indicate that you're using the new environment. If you

open a new shell, you need to rerun this command to enter again at

the virtual environment before building the documentation.
@@ -81,7 +77,7 @@ output. 
PDF and LaTeX builds

--------------------



Such builds are currently supported only with Sphinx versions 1.4 and higher.

Such builds are currently supported only with Sphinx versions 2.4 and higher.



For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265.
@@ -104,8 +100,8 @@ command line options for your distro:: 
	You should run:



		sudo dnf install -y texlive-luatex85

		/usr/bin/virtualenv sphinx_1.7.9

		. sphinx_1.7.9/bin/activate

		/usr/bin/virtualenv sphinx_2.4.4

		. sphinx_2.4.4/bin/activate

		pip install -r Documentation/sphinx/requirements.txt



	Can't build as 1 mandatory dependency is missing at ./scripts/sphinx-pre-install line 468.

Documentation/filesystems/autofs.rst

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ This document describes only the kernel module and the interactions 
required with any user-space program.  Subsequent text refers to this

as the "automount daemon" or simply "the daemon".



"autofs" is a Linux kernel module with provides the "autofs"

"autofs" is a Linux kernel module which provides the "autofs"

filesystem type.  Several "autofs" filesystems can be mounted and they

can each be managed separately, or all managed by the same daemon.