Skip to content

Commit e6b0bd6

Browse files
committed
Merge tag 'docs-5.10-warnings' of git://git.lwn.net/linux
Pull documentation build warning fixes from Jonathan Corbet: "This contains a series of warning fixes from Mauro; once applied, the number of warnings from the once-noisy docs build process is nearly zero. Getting to this point has required a lot of work; once there, hopefully we can keep things that way. I have packaged this as a separate pull because it does a fair amount of reaching outside of Documentation/. The changes are all in comments and in code placement. It's all been in linux-next since last week" * tag 'docs-5.10-warnings' of git://git.lwn.net/linux: (24 commits) docs: SafeSetID: fix a warning amdgpu: fix a few kernel-doc markup issues selftests: kselftest_harness.h: fix kernel-doc markups drm: amdgpu_dm: fix a typo gpu: docs: amdgpu.rst: get rid of wrong kernel-doc markups drm: amdgpu: kernel-doc: update some adev parameters docs: fs: api-summary.rst: get rid of kernel-doc include IB/srpt: docs: add a description for cq_size member locking/refcount: move kernel-doc markups to the proper place docs: lockdep-design: fix some warning issues MAINTAINERS: fix broken doc refs due to yaml conversion ice: docs fix a devlink info that broke a table crypto: sun8x-ce*: update entries to its documentation net: phy: remove kernel-doc duplication mm: pagemap.h: fix two kernel-doc markups blk-mq: docs: add kernel-doc description for a new struct member docs: userspace-api: add iommu.rst to the index file docs: hwmon: mp2975.rst: address some html build warnings docs: net: statistics.rst: remove a duplicated kernel-doc docs: kasan.rst: add two missing blank lines ...
2 parents ce2e33b + 6fee937 commit e6b0bd6

31 files changed

Lines changed: 196 additions & 201 deletions

File tree

Documentation/admin-guide/LSM/SafeSetID.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ for a UID/GID will prevent that UID/GID from obtaining auxiliary setid
107107
privileges, such as allowing a user to set up user namespace UID/GID mappings.
108108

109109
Note on GID policies and setgroups()
110-
==================
110+
====================================
111111
In v5.9 we are adding support for limiting CAP_SETGID privileges as was done
112112
previously for CAP_SETUID. However, for compatibility with common sandboxing
113113
related code conventions in userspace, we currently allow arbitrary

Documentation/admin-guide/sysctl/net.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,7 @@ Note:
300300
0: 0 1 2 3 4 5 6 7
301301
RSS hash key:
302302
84:50:f4:00:a8:15:d1:a7:e9:7f:1d:60:35:c7:47:25:42:97:74:ca:56:bb:b6:a1:d8:43:e3:c9:0c:fd:17:55:c2:3a:4d:69:ed:f1:42:89
303+
303304
netdev_tstamp_prequeue
304305
----------------------
305306

Documentation/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
support for Sphinx v3.0 and above is brand new. Be prepared for
5252
possible issues in the generated output.
5353
''')
54-
if minor > 0 or patch >= 2:
54+
if (major > 3) or (minor > 0 or patch >= 2):
5555
# Sphinx c function parser is more pedantic with regards to type
5656
# checking. Due to that, having macros at c:function cause problems.
5757
# Those needed to be scaped by using c_id_attributes[] array

Documentation/dev-tools/kasan.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,11 +295,13 @@ print the number of the test and the status of the test:
295295
pass::
296296

297297
ok 28 - kmalloc_double_kzfree
298+
298299
or, if kmalloc failed::
299300

300301
# kmalloc_large_oob_right: ASSERTION FAILED at lib/test_kasan.c:163
301302
Expected ptr is not null, but is
302303
not ok 4 - kmalloc_large_oob_right
304+
303305
or, if a KASAN report was expected, but not found::
304306

305307
# kmalloc_double_kzfree: EXPECTATION FAILED at lib/test_kasan.c:629

Documentation/devicetree/bindings/clock/hi6220-clock.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Clock control registers reside in different Hi6220 system controllers,
44
please refer the following document to know more about the binding rules
55
for these system controllers:
66

7-
Documentation/devicetree/bindings/arm/hisilicon/hisilicon.txt
7+
Documentation/devicetree/bindings/arm/hisilicon/hisilicon.yaml
88

99
Required Properties:
1010

Documentation/filesystems/api-summary.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,6 @@ Other Functions
8686
.. kernel-doc:: fs/dax.c
8787
:export:
8888

89-
.. kernel-doc:: fs/direct-io.c
90-
:export:
91-
9289
.. kernel-doc:: fs/libfs.c
9390
:export:
9491

Documentation/gpu/amdgpu.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,6 @@ AMDGPU XGMI Support
8383
===================
8484

8585
.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
86-
:doc: AMDGPU XGMI Support
87-
88-
.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
89-
:internal:
9086

9187
AMDGPU RAS Support
9288
==================
@@ -124,9 +120,6 @@ RAS VRAM Bad Pages sysfs Interface
124120
.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
125121
:doc: AMDGPU RAS sysfs gpu_vram_bad_pages Interface
126122

127-
.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
128-
:internal:
129-
130123
Sample Code
131124
-----------
132125
Sample code for testing error injection can be found here:

Documentation/hwmon/adm1266.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ADM1266 is a sequencer that features voltage readback from 17 channels via an
2020
integrated 12 bit SAR ADC, accessed using a PMBus interface.
2121

2222
The driver is a client driver to the core PMBus driver. Please see
23-
Documentation/hwmon/pmbus for details on PMBus client drivers.
23+
Documentation/hwmon/pmbus.rst for details on PMBus client drivers.
2424

2525

2626
Sysfs entries

Documentation/hwmon/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ Hardware Monitoring Kernel Drivers
132132
mcp3021
133133
menf21bmc
134134
mlxreg-fan
135+
mp2975
135136
nct6683
136137
nct6775
137138
nct7802

Documentation/hwmon/mp2975.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This driver implements support for Monolithic Power Systems, Inc. (MPS)
2020
vendor dual-loop, digital, multi-phase controller MP2975.
2121

2222
This device:
23+
2324
- Supports up to two power rail.
2425
- Provides 8 pulse-width modulations (PWMs), and can be configured up
2526
to 8-phase operation for rail 1 and up to 4-phase operation for rail
@@ -32,10 +33,12 @@ This device:
3233
10-mV DAC, IMVP9 mode with 5-mV DAC.
3334

3435
Device supports:
36+
3537
- SVID interface.
3638
- AVSBus interface.
3739

3840
Device complaint with:
41+
3942
- PMBus rev 1.3 interface.
4043

4144
Device supports direct format for reading output current, output voltage,
@@ -45,11 +48,14 @@ Device supports VID and direct formats for reading output voltage.
4548
The below VID modes are supported: VR12, VR13, IMVP9.
4649

4750
The driver provides the next attributes for the current:
51+
4852
- for current in: input, maximum alarm;
4953
- for current out input, maximum alarm and highest values;
5054
- for phase current: input and label.
51-
attributes.
55+
attributes.
56+
5257
The driver exports the following attributes via the 'sysfs' files, where
58+
5359
- 'n' is number of telemetry pages (from 1 to 2);
5460
- 'k' is number of configured phases (from 1 to 8);
5561
- indexes 1, 1*n for "iin";
@@ -65,11 +71,14 @@ The driver exports the following attributes via the 'sysfs' files, where
6571
**curr[1-{2n+k}]_label**
6672

6773
The driver provides the next attributes for the voltage:
74+
6875
- for voltage in: input, high critical threshold, high critical alarm, all only
6976
from page 0;
7077
- for voltage out: input, low and high critical thresholds, low and high
7178
critical alarms, from pages 0 and 1;
79+
7280
The driver exports the following attributes via the 'sysfs' files, where
81+
7382
- 'n' is number of telemetry pages (from 1 to 2);
7483
- indexes 1 for "iin";
7584
- indexes n+1, n+2 for "vout";
@@ -87,9 +96,12 @@ The driver exports the following attributes via the 'sysfs' files, where
8796
**in[2-{n+1}1_lcrit_alarm**
8897

8998
The driver provides the next attributes for the power:
99+
90100
- for power in alarm and input.
91101
- for power out: highest and input.
102+
92103
The driver exports the following attributes via the 'sysfs' files, where
104+
93105
- 'n' is number of telemetry pages (from 1 to 2);
94106
- indexes 1 for "pin";
95107
- indexes n+1, n+2 for "pout";

0 commit comments

Comments
 (0)