Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-12-27 05:11:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

A few important documentation fixes, including breakage that comes with

Browse Source 
v1.0 of the ReadTheDocs theme.
 -----BEGIN PGP SIGNATURE-----
 
 iQFDBAABCAAtFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmGuS2oPHGNvcmJldEBs
 d24ubmV0AAoJEBdDWhNsDH5YYsEH/jyYembdY2dydJaVKqFgAa/IOG0SC7jfq3DQ
 sOcPMSVq4OTwPYGiki4Gn8raNOkoR5JhXJ7mvZgFP5cQJdVnsOkEL1sDKakxRkLk
 SvXYg3brLOjHRjRjmmbuLyZSwFquKr3lfOOLx2neTVk/xFSgTOlWY2OVEdToQ4CE
 wtntgL/kfmVBJor1ScwjnX27tB1dRC0cDrsD/NpuHitw9e3QxhvBGXnLAbGZV733
 1i/Ge//oD4yan/lM89et4HSbI6QCV5vdaCDtCGkZhTCXyY/AWjStcDDKPwZNjUjA
 NIqDg85qeUCrMqnye4Jyl7zno2C3KDPa0XtyjOmKqIdFZC4mwRc=
 =IXEs
 -----END PGP SIGNATURE-----

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

Pull documentation fixes from Jonathan Corbet:
 "A few important documentation fixes, including breakage that comes
  with v1.0 of the ReadTheDocs theme"

* tag 'docs-5.16-3' of git://git.lwn.net/linux:
  Documentation: Add minimum pahole version
  Documentation/process: fix self reference
  docs: admin-guide/blockdev: Remove digraph of node-states
  docs: conf.py: fix support for Readthedocs v 1.0.0
This commit is contained in:
Linus Torvalds 2021-12-06 10:46:20 -08:00
commit f80ef9e49f
5 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/admin-guide/blockdev/drbd/figures.rst
View File

@ -25,6 +25,6 @@ Sub graphs of DRBD's state transitions
:alt: disk-states-8.dot
:align: center
.. kernel-figure:: node-states-8.dot
:alt: node-states-8.dot
.. kernel-figure:: peer-states-8.dot
:alt: peer-states-8.dot
:align: center

5
Documentation/admin-guide/blockdev/drbd/node-states-8.dot → Documentation/admin-guide/blockdev/drbd/peer-states-8.dot
View File

@ -1,8 +1,3 @@
digraph node_states {
Secondary -> Primary [ label = "ioctl_set_state()" ]
Primary -> Secondary [ label = "ioctl_set_state()" ]
}
digraph peer_states {
Secondary -> Primary [ label = "recv state packet" ]
Primary -> Secondary [ label = "recv state packet" ]

5
Documentation/conf.py
View File

@ -249,6 +249,11 @@ except ImportError:
html_static_path = ['sphinx-static']
html_css_files = [
'theme_overrides.css',
]
if major <= 1 and minor < 8:
html_context = {
'css_files': [
'_static/theme_overrides.css',

11
Documentation/process/changes.rst
View File

@ -35,6 +35,7 @@ GNU make 3.81 make --version
binutils 2.23 ld -v
flex 2.5.35 flex --version
bison 2.0 bison --version
pahole 1.16 pahole --version
util-linux 2.10o fdformat --version
kmod 13 depmod -V
e2fsprogs 1.41.4 e2fsck -V
@ -108,6 +109,16 @@ Bison
Since Linux 4.16, the build system generates parsers
during build. This requires bison 2.0 or later.
pahole:
-------
Since Linux 5.2, if CONFIG_DEBUG_INFO_BTF is selected, the build system
generates BTF (BPF Type Format) from DWARF in vmlinux, a bit later from kernel
modules as well. This requires pahole v1.16 or later.
It is found in the 'dwarves' or 'pahole' distro packages or from
https://fedorapeople.org/~acme/dwarves/.
Perl
----

3
Documentation/process/submitting-patches.rst
View File

@ -14,7 +14,8 @@ works, see Documentation/process/development-process.rst. Also, read
Documentation/process/submit-checklist.rst
for a list of items to check before submitting code. If you are submitting
a driver, also read Documentation/process/submitting-drivers.rst; for device
tree binding patches, read Documentation/process/submitting-patches.rst.
tree binding patches, read
Documentation/devicetree/bindings/submitting-patches.rst.
This documentation assumes that you're using ``git`` to prepare your patches.
If you're unfamiliar with ``git``, you would be well-advised to learn how to