Skip to content

Commit f80ef9e

Browse files
committed
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
2 parents 9d6cf47 + 333b11e commit f80ef9e

File tree

5 files changed

+25
-13
lines changed

5 files changed

+25
-13
lines changed

Documentation/admin-guide/blockdev/drbd/figures.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ Sub graphs of DRBD's state transitions
2525
:alt: disk-states-8.dot
2626
:align: center
2727

28-
.. kernel-figure:: node-states-8.dot
29-
:alt: node-states-8.dot
28+
.. kernel-figure:: peer-states-8.dot
29+
:alt: peer-states-8.dot
3030
:align: center

Documentation/admin-guide/blockdev/drbd/node-states-8.dot renamed to Documentation/admin-guide/blockdev/drbd/peer-states-8.dot

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
digraph node_states {
2-
Secondary -> Primary [ label = "ioctl_set_state()" ]
3-
Primary -> Secondary [ label = "ioctl_set_state()" ]
4-
}
5-
61
digraph peer_states {
72
Secondary -> Primary [ label = "recv state packet" ]
83
Primary -> Secondary [ label = "recv state packet" ]

Documentation/conf.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,11 +249,16 @@
249249

250250
html_static_path = ['sphinx-static']
251251

252-
html_context = {
253-
'css_files': [
254-
'_static/theme_overrides.css',
255-
],
256-
}
252+
html_css_files = [
253+
'theme_overrides.css',
254+
]
255+
256+
if major <= 1 and minor < 8:
257+
html_context = {
258+
'css_files': [
259+
'_static/theme_overrides.css',
260+
],
261+
}
257262

258263
# Add any extra paths that contain custom files (such as robots.txt or
259264
# .htaccess) here, relative to this directory. These files are copied

Documentation/process/changes.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ GNU make 3.81 make --version
3535
binutils 2.23 ld -v
3636
flex 2.5.35 flex --version
3737
bison 2.0 bison --version
38+
pahole 1.16 pahole --version
3839
util-linux 2.10o fdformat --version
3940
kmod 13 depmod -V
4041
e2fsprogs 1.41.4 e2fsck -V
@@ -108,6 +109,16 @@ Bison
108109
Since Linux 4.16, the build system generates parsers
109110
during build. This requires bison 2.0 or later.
110111

112+
pahole:
113+
-------
114+
115+
Since Linux 5.2, if CONFIG_DEBUG_INFO_BTF is selected, the build system
116+
generates BTF (BPF Type Format) from DWARF in vmlinux, a bit later from kernel
117+
modules as well. This requires pahole v1.16 or later.
118+
119+
It is found in the 'dwarves' or 'pahole' distro packages or from
120+
https://fedorapeople.org/~acme/dwarves/.
121+
111122
Perl
112123
----
113124

Documentation/process/submitting-patches.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ works, see Documentation/process/development-process.rst. Also, read
1414
Documentation/process/submit-checklist.rst
1515
for a list of items to check before submitting code. If you are submitting
1616
a driver, also read Documentation/process/submitting-drivers.rst; for device
17-
tree binding patches, read Documentation/process/submitting-patches.rst.
17+
tree binding patches, read
18+
Documentation/devicetree/bindings/submitting-patches.rst.
1819

1920
This documentation assumes that you're using ``git`` to prepare your patches.
2021
If you're unfamiliar with ``git``, you would be well-advised to learn how to

0 commit comments

Comments
 (0)