Skip to content

Commit 5e7b921

Browse files
torvaldstorvalds
committed
Merge tag 'docs-broken-links' of git://linuxtv.org/mchehab/experimental
Pull documentation fixes from Mauro Carvalho Chehab: "This solves a series of broken links for files under Documentation, and improves a script meant to detect such broken links (see scripts/documentation-file-ref-check). The changes on this series are: - can.rst: fix a footnote reference; - crypto_engine.rst: Fix two parsing warnings; - Fix a lot of broken references to Documentation/*; - improve the scripts/documentation-file-ref-check script, in order to help detecting/fixing broken references, preventing false-positives. After this patch series, only 33 broken references to doc files are detected by scripts/documentation-file-ref-check" * tag 'docs-broken-links' of git://linuxtv.org/mchehab/experimental: (26 commits) fix a series of Documentation/ broken file name references Documentation: rstFlatTable.py: fix a broken reference ABI: sysfs-devices-system-cpu: remove a broken reference devicetree: fix a series of wrong file references devicetree: fix name of pinctrl-bindings.txt devicetree: fix some bindings file names MAINTAINERS: fix location of DT npcm files MAINTAINERS: fix location of some display DT bindings kernel-parameters.txt: fix pointers to sound parameters bindings: nvmem/zii: Fix location of nvmem.txt docs: Fix more broken references scripts/documentation-file-ref-check: check tools/*/Documentation scripts/documentation-file-ref-check: get rid of false-positives scripts/documentation-file-ref-check: hint: dash or underline scripts/documentation-file-ref-check: add a fix logic for DT scripts/documentation-file-ref-check: accept more wildcards at filenames scripts/documentation-file-ref-check: fix help message media: max2175: fix location of driver's companion documentation media: v4l: fix broken video4linux docs locations media: dvb: point to the location of the old README.dvb-usb file ...
2 parents dbb2816 + 44348e8 commit 5e7b921

File tree

206 files changed

+372
-339
lines changed

Some content is hidden

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

206 files changed

+372
-339
lines changed

‎Documentation/ABI/obsolete/sysfs-gpio

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Description:
1111
Kernel code may export it for complete or partial access.
1212

1313
GPIOs are identified as they are inside the kernel, using integers in
14-
the range 0..INT_MAX. See Documentation/gpio/gpio.txt for more information.
14+
the range 0..INT_MAX. See Documentation/gpio for more information.
1515

1616
/sys/class/gpio
1717
/export ... asks the kernel to export a GPIO to userspace

‎Documentation/ABI/testing/sysfs-devices-system-cpu

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,9 +238,6 @@ Description: Discover and change clock speed of CPUs
238238

239239
See files in Documentation/cpu-freq/ for more information.
240240

241-
In particular, read Documentation/cpu-freq/user-guide.txt
242-
to learn how to control the knobs.
243-
244241

245242
What: /sys/devices/system/cpu/cpu#/cpufreq/freqdomain_cpus
246243
Date: June 2013

‎Documentation/admin-guide/kernel-parameters.txt

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@
256256
(may crash computer or cause data corruption)
257257

258258
ALSA [HW,ALSA]
259-
See Documentation/sound/alsa/alsa-parameters.txt
259+
See Documentation/sound/alsa-configuration.rst
260260

261261
alignment= [KNL,ARM]
262262
Allow the default userspace alignment fault handler
@@ -2926,9 +2926,6 @@
29262926
This will also cause panics on machine check exceptions.
29272927
Useful together with panic=30 to trigger a reboot.
29282928

2929-
OSS [HW,OSS]
2930-
See Documentation/sound/oss/oss-parameters.txt
2931-
29322929
page_owner= [KNL] Boot-time page_owner enabling option.
29332930
Storage of the information about who allocated
29342931
each page is disabled in default. With this switch,
@@ -4335,7 +4332,7 @@
43354332
[FTRACE] Set and start specified trace events in order
43364333
to facilitate early boot debugging. The event-list is a
43374334
comma separated list of trace events to enable. See
4338-
also Documentation/trace/events.txt
4335+
also Documentation/trace/events.rst
43394336

43404337
trace_options=[option-list]
43414338
[FTRACE] Enable or disable tracer options at boot.
@@ -4350,7 +4347,7 @@
43504347

43514348
trace_options=stacktrace
43524349

4353-
See also Documentation/trace/ftrace.txt "trace options"
4350+
See also Documentation/trace/ftrace.rst "trace options"
43544351
section.
43554352

43564353
tp_printk[FTRACE]

‎Documentation/crypto/crypto_engine.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ The crypto engine API (CE), is a crypto queue manager.
88

99
Requirement
1010
-----------
11-
You have to put at start of your tfm_ctx the struct crypto_engine_ctx
12-
struct your_tfm_ctx {
11+
You have to put at start of your tfm_ctx the struct crypto_engine_ctx::
12+
13+
struct your_tfm_ctx {
1314
struct crypto_engine_ctx enginectx;
1415
...
15-
};
16+
};
17+
1618
Why: Since CE manage only crypto_async_request, it cannot know the underlying
1719
request_type and so have access only on the TFM.
1820
So using container_of for accessing __ctx is impossible.

‎Documentation/devicetree/bindings/clock/st/st,clkgen.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ This binding uses the common clock binding[1].
3131
Each subnode should use the binding described in [2]..[7]
3232

3333
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
34-
[3] Documentation/devicetree/bindings/clock/st,clkgen-mux.txt
35-
[4] Documentation/devicetree/bindings/clock/st,clkgen-pll.txt
36-
[7] Documentation/devicetree/bindings/clock/st,quadfs.txt
37-
[8] Documentation/devicetree/bindings/clock/st,flexgen.txt
34+
[3] Documentation/devicetree/bindings/clock/st/st,clkgen-mux.txt
35+
[4] Documentation/devicetree/bindings/clock/st/st,clkgen-pll.txt
36+
[7] Documentation/devicetree/bindings/clock/st/st,quadfs.txt
37+
[8] Documentation/devicetree/bindings/clock/st/st,flexgen.txt
3838

3939

4040
Required properties:

‎Documentation/devicetree/bindings/clock/ti/gate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ will be controlled instead and the corresponding hw-ops for
1010
that is used.
1111

1212
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
13-
[2] Documentation/devicetree/bindings/clock/gate-clock.txt
13+
[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
1414
[3] Documentation/devicetree/bindings/clock/ti/clockdomain.txt
1515

1616
Required properties:

‎Documentation/devicetree/bindings/clock/ti/interface.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ companion clock finding (match corresponding functional gate
99
clock) and hardware autoidle enable / disable.
1010

1111
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
12-
[2] Documentation/devicetree/bindings/clock/gate-clock.txt
12+
[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
1313

1414
Required properties:
1515
- compatible : shall be one of:

‎Documentation/devicetree/bindings/cpufreq/cpufreq-mediatek.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Required properties:
88
"intermediate" - A parent of "cpu" clock which is used as "intermediate" clock
99
source (usually MAINPLL) when the original CPU PLL is under
1010
transition and not stable yet.
11-
Please refer to Documentation/devicetree/bindings/clk/clock-bindings.txt for
11+
Please refer to Documentation/devicetree/bindings/clock/clock-bindings.txt for
1212
generic clock consumer properties.
1313
- operating-points-v2: Please refer to Documentation/devicetree/bindings/opp/opp.txt
1414
for detail.

‎Documentation/devicetree/bindings/devfreq/rk3399_dmc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Required properties:
1212
- clocks: Phandles for clock specified in "clock-names" property
1313
- clock-names : The name of clock used by the DFI, must be
1414
"pclk_ddr_mon";
15-
- operating-points-v2: Refer to Documentation/devicetree/bindings/power/opp.txt
15+
- operating-points-v2: Refer to Documentation/devicetree/bindings/opp/opp.txt
1616
for details.
1717
- center-supply: DMC supply node.
1818
- status: Marks the node enabled/disabled.

‎Documentation/devicetree/bindings/display/bridge/tda998x.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Optional properties:
3030
- nxp,calib-gpios: calibration GPIO, which must correspond with the
3131
gpio used for the TDA998x interrupt pin.
3232

33-
[1] Documentation/sound/alsa/soc/DAI.txt
33+
[1] Documentation/sound/soc/dai.rst
3434
[2] include/dt-bindings/display/tda998x.h
3535

3636
Example:

0 commit comments

Comments
 (0)