Skip to content

Commit 481ed29

Browse files
committed
Merge tag 'docs-5.7' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet: "This has been a busy cycle for documentation work. Highlights include: - Lots of RST conversion work by Mauro, Daniel ALmeida, and others. Maybe someday we'll get to the end of this stuff...maybe... - Some organizational work to bring some order to the core-api manual. - Various new docs and additions to the existing documentation. - Typo fixes, warning fixes, ..." * tag 'docs-5.7' of git://git.lwn.net/linux: (123 commits) Documentation: x86: exception-tables: document CONFIG_BUILDTIME_TABLE_SORT MAINTAINERS: adjust to filesystem doc ReST conversion docs: deprecated.rst: Add BUG()-family doc: zh_CN: add translation for virtiofs doc: zh_CN: index files in filesystems subdirectory docs: locking: Drop :c:func: throughout docs: locking: Add 'need' to hardirq section docs: conf.py: avoid thousands of duplicate label warning on Sphinx docs: prevent warnings due to autosectionlabel docs: fix reference to core-api/namespaces.rst docs: fix pointers to io-mapping.rst and io_ordering.rst files Documentation: Better document the softlockup_panic sysctl docs: hw-vuln: tsx_async_abort.rst: get rid of an unused ref docs: perf: imx-ddr.rst: get rid of a warning docs: filesystems: fuse.rst: supress a Sphinx warning docs: translations: it: avoid duplicate refs at programming-language.rst docs: driver.rst: supress two ReSt warnings docs: trace: events.rst: convert some new stuff to ReST format Documentation: Add io_ordering.rst to driver-api manual Documentation: Add io-mapping.rst to driver-api manual ...
2 parents e59cd88 + abcb1e0 commit 481ed29

File tree

141 files changed

+4570
-3292
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

141 files changed

+4570
-3292
lines changed

Documentation/ABI/testing/sysfs-kernel-uids renamed to Documentation/ABI/removed/sysfs-kernel-uids

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
What: /sys/kernel/uids/<uid>/cpu_shares
2-
Date: December 2007
2+
Date: December 2007, finally removed in kernel v2.6.34-rc1
33
Contact: Dhaval Giani <[email protected]>
44
Srivatsa Vaddagiri <[email protected]>
55
Description:

Documentation/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ endif
1313
SPHINXBUILD = sphinx-build
1414
SPHINXOPTS =
1515
SPHINXDIRS = .
16-
_SPHINXDIRS = $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst))
16+
_SPHINXDIRS = $(sort $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst)))
1717
SPHINX_CONF = conf.py
1818
PAPER =
1919
BUILDDIR = $(obj)/output

Documentation/PCI/pci.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ from the PCI device config space. Use the values in the pci_dev structure
239239
as the PCI "bus address" might have been remapped to a "host physical"
240240
address by the arch/chip-set specific kernel support.
241241

242-
See Documentation/io-mapping.txt for how to access device registers
242+
See Documentation/driver-api/io-mapping.rst for how to access device registers
243243
or device memory.
244244

245245
The device driver needs to call pci_request_region() to verify

Documentation/accounting/psi.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _psi:
2+
13
================================
24
PSI - Pressure Stall Information
35
================================

Documentation/admin-guide/binfmt-misc.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Kernel Support for miscellaneous (your favourite) Binary Formats v1.1
2-
=====================================================================
1+
Kernel Support for miscellaneous Binary Formats (binfmt_misc)
2+
=============================================================
33

44
This Kernel feature allows you to invoke almost (for restrictions see below)
55
every program by simply typing its name in the shell.

Documentation/admin-guide/blockdev/zram.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,6 @@ line of text and contains the following stats separated by whitespace:
251251

252252
================ =============================================================
253253
orig_data_size uncompressed size of data stored in this disk.
254-
This excludes same-element-filled pages (same_pages) since
255-
no memory is allocated for them.
256254
Unit: bytes
257255
compr_data_size compressed size of data stored in this disk
258256
mem_used_total the amount of memory allocated for this disk. This

Documentation/admin-guide/bootconfig.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ of dot-connected-words, and key and value are connected by ``=``. The value
2323
has to be terminated by semi-colon (``;``) or newline (``\n``).
2424
For array value, array entries are separated by comma (``,``). ::
2525

26-
KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
26+
KEY[.WORD[...]] = VALUE[, VALUE2[...]][;]
2727

2828
Unlike the kernel command line syntax, spaces are OK around the comma and ``=``.
2929

Documentation/admin-guide/cgroup-v1/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _cgroup-v1:
2+
13
========================
24
Control Groups version 1
35
========================

Documentation/admin-guide/cgroup-v2.rst

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This is the authoritative documentation on the design, interface and
99
conventions of cgroup v2. It describes all userland-visible aspects
1010
of cgroup including core and specific controller behaviors. All
1111
future changes must be reflected in this document. Documentation for
12-
v1 is available under Documentation/admin-guide/cgroup-v1/.
12+
v1 is available under :ref:`Documentation/admin-guide/cgroup-v1/index.rst <cgroup-v1>`.
1313

1414
.. CONTENTS
1515
@@ -1023,7 +1023,7 @@ All time durations are in microseconds.
10231023
A read-only nested-key file which exists on non-root cgroups.
10241024

10251025
Shows pressure stall information for CPU. See
1026-
Documentation/accounting/psi.rst for details.
1026+
:ref:`Documentation/accounting/psi.rst <psi>` for details.
10271027

10281028
cpu.uclamp.min
10291029
A read-write single value file which exists on non-root cgroups.
@@ -1103,7 +1103,7 @@ PAGE_SIZE multiple when read back.
11031103
proportionally to the overage, reducing reclaim pressure for
11041104
smaller overages.
11051105

1106-
Effective min boundary is limited by memory.min values of
1106+
Effective min boundary is limited by memory.min values of
11071107
all ancestor cgroups. If there is memory.min overcommitment
11081108
(child cgroup or cgroups are requiring more protected memory
11091109
than parent will allow), then each child cgroup will get
@@ -1313,53 +1313,41 @@ PAGE_SIZE multiple when read back.
13131313
Number of major page faults incurred
13141314

13151315
workingset_refault
1316-
13171316
Number of refaults of previously evicted pages
13181317

13191318
workingset_activate
1320-
13211319
Number of refaulted pages that were immediately activated
13221320

13231321
workingset_nodereclaim
1324-
13251322
Number of times a shadow node has been reclaimed
13261323

13271324
pgrefill
1328-
13291325
Amount of scanned pages (in an active LRU list)
13301326

13311327
pgscan
1332-
13331328
Amount of scanned pages (in an inactive LRU list)
13341329

13351330
pgsteal
1336-
13371331
Amount of reclaimed pages
13381332

13391333
pgactivate
1340-
13411334
Amount of pages moved to the active LRU list
13421335

13431336
pgdeactivate
1344-
13451337
Amount of pages moved to the inactive LRU list
13461338

13471339
pglazyfree
1348-
13491340
Amount of pages postponed to be freed under memory pressure
13501341

13511342
pglazyfreed
1352-
13531343
Amount of reclaimed lazyfree pages
13541344

13551345
thp_fault_alloc
1356-
13571346
Number of transparent hugepages which were allocated to satisfy
13581347
a page fault, including COW faults. This counter is not present
13591348
when CONFIG_TRANSPARENT_HUGEPAGE is not set.
13601349

13611350
thp_collapse_alloc
1362-
13631351
Number of transparent hugepages which were allocated to allow
13641352
collapsing an existing range of pages. This counter is not
13651353
present when CONFIG_TRANSPARENT_HUGEPAGE is not set.
@@ -1403,7 +1391,7 @@ PAGE_SIZE multiple when read back.
14031391
A read-only nested-key file which exists on non-root cgroups.
14041392

14051393
Shows pressure stall information for memory. See
1406-
Documentation/accounting/psi.rst for details.
1394+
:ref:`Documentation/accounting/psi.rst <psi>` for details.
14071395

14081396

14091397
Usage Guidelines
@@ -1478,7 +1466,7 @@ IO Interface Files
14781466
dios Number of discard IOs
14791467
====== =====================
14801468

1481-
An example read output follows:
1469+
An example read output follows::
14821470

14831471
8:16 rbytes=1459200 wbytes=314773504 rios=192 wios=353 dbytes=0 dios=0
14841472
8:0 rbytes=90430464 wbytes=299008000 rios=8950 wios=1252 dbytes=50331648 dios=3021
@@ -1643,7 +1631,7 @@ IO Interface Files
16431631
A read-only nested-key file which exists on non-root cgroups.
16441632

16451633
Shows pressure stall information for IO. See
1646-
Documentation/accounting/psi.rst for details.
1634+
:ref:`Documentation/accounting/psi.rst <psi>` for details.
16471635

16481636

16491637
Writeback
@@ -1853,7 +1841,7 @@ Cpuset Interface Files
18531841
from the requested CPUs.
18541842

18551843
The CPU numbers are comma-separated numbers or ranges.
1856-
For example:
1844+
For example::
18571845

18581846
# cat cpuset.cpus
18591847
0-4,6,8-10
@@ -1892,7 +1880,7 @@ Cpuset Interface Files
18921880
from the requested memory nodes.
18931881

18941882
The memory node numbers are comma-separated numbers or ranges.
1895-
For example:
1883+
For example::
18961884

18971885
# cat cpuset.mems
18981886
0-1,3

Documentation/driver-api/edid.rst renamed to Documentation/admin-guide/edid.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ Today, with the advent of Kernel Mode Setting, a graphics board is
1111
either correctly working because all components follow the standards -
1212
or the computer is unusable, because the screen remains dark after
1313
booting or it displays the wrong area. Cases when this happens are:
14+
1415
- The graphics board does not recognize the monitor.
1516
- The graphics board is unable to detect any EDID data.
1617
- The graphics board incorrectly forwards EDID data to the driver.
1718
- The monitor sends no or bogus EDID data.
1819
- A KVM sends its own EDID data instead of querying the connected monitor.
20+
1921
Adding the kernel parameter "nomodeset" helps in most cases, but causes
2022
restrictions later on.
2123

@@ -32,7 +34,7 @@ individual data for a specific misbehaving monitor, commented sources
3234
and a Makefile environment are given here.
3335

3436
To create binary EDID and C source code files from the existing data
35-
material, simply type "make".
37+
material, simply type "make" in tools/edid/.
3638

3739
If you want to create your own EDID file, copy the file 1024x768.S,
3840
replace the settings with your own data and add a new target to the

0 commit comments

Comments
 (0)