Commit 5e7b9212 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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
  ...
parents dbb2816f 44348e8a
...@@ -11,7 +11,7 @@ Description: ...@@ -11,7 +11,7 @@ Description:
Kernel code may export it for complete or partial access. Kernel code may export it for complete or partial access.
GPIOs are identified as they are inside the kernel, using integers in GPIOs are identified as they are inside the kernel, using integers in
the range 0..INT_MAX. See Documentation/gpio/gpio.txt for more information. the range 0..INT_MAX. See Documentation/gpio for more information.
/sys/class/gpio /sys/class/gpio
/export ... asks the kernel to export a GPIO to userspace /export ... asks the kernel to export a GPIO to userspace
......
...@@ -238,9 +238,6 @@ Description: Discover and change clock speed of CPUs ...@@ -238,9 +238,6 @@ Description: Discover and change clock speed of CPUs
See files in Documentation/cpu-freq/ for more information. See files in Documentation/cpu-freq/ for more information.
In particular, read Documentation/cpu-freq/user-guide.txt
to learn how to control the knobs.
What: /sys/devices/system/cpu/cpu#/cpufreq/freqdomain_cpus What: /sys/devices/system/cpu/cpu#/cpufreq/freqdomain_cpus
Date: June 2013 Date: June 2013
......
...@@ -256,7 +256,7 @@ ...@@ -256,7 +256,7 @@
(may crash computer or cause data corruption) (may crash computer or cause data corruption)
ALSA [HW,ALSA] ALSA [HW,ALSA]
See Documentation/sound/alsa/alsa-parameters.txt See Documentation/sound/alsa-configuration.rst
alignment= [KNL,ARM] alignment= [KNL,ARM]
Allow the default userspace alignment fault handler Allow the default userspace alignment fault handler
...@@ -2926,9 +2926,6 @@ ...@@ -2926,9 +2926,6 @@
This will also cause panics on machine check exceptions. This will also cause panics on machine check exceptions.
Useful together with panic=30 to trigger a reboot. Useful together with panic=30 to trigger a reboot.
OSS [HW,OSS]
See Documentation/sound/oss/oss-parameters.txt
page_owner= [KNL] Boot-time page_owner enabling option. page_owner= [KNL] Boot-time page_owner enabling option.
Storage of the information about who allocated Storage of the information about who allocated
each page is disabled in default. With this switch, each page is disabled in default. With this switch,
...@@ -4335,7 +4332,7 @@ ...@@ -4335,7 +4332,7 @@
[FTRACE] Set and start specified trace events in order [FTRACE] Set and start specified trace events in order
to facilitate early boot debugging. The event-list is a to facilitate early boot debugging. The event-list is a
comma separated list of trace events to enable. See comma separated list of trace events to enable. See
also Documentation/trace/events.txt also Documentation/trace/events.rst
trace_options=[option-list] trace_options=[option-list]
[FTRACE] Enable or disable tracer options at boot. [FTRACE] Enable or disable tracer options at boot.
...@@ -4350,7 +4347,7 @@ ...@@ -4350,7 +4347,7 @@
trace_options=stacktrace trace_options=stacktrace
See also Documentation/trace/ftrace.txt "trace options" See also Documentation/trace/ftrace.rst "trace options"
section. section.
tp_printk[FTRACE] tp_printk[FTRACE]
......
...@@ -8,11 +8,13 @@ The crypto engine API (CE), is a crypto queue manager. ...@@ -8,11 +8,13 @@ The crypto engine API (CE), is a crypto queue manager.
Requirement Requirement
----------- -----------
You have to put at start of your tfm_ctx the struct crypto_engine_ctx You have to put at start of your tfm_ctx the struct crypto_engine_ctx::
struct your_tfm_ctx {
struct your_tfm_ctx {
struct crypto_engine_ctx enginectx; struct crypto_engine_ctx enginectx;
... ...
}; };
Why: Since CE manage only crypto_async_request, it cannot know the underlying Why: Since CE manage only crypto_async_request, it cannot know the underlying
request_type and so have access only on the TFM. request_type and so have access only on the TFM.
So using container_of for accessing __ctx is impossible. So using container_of for accessing __ctx is impossible.
......
...@@ -31,10 +31,10 @@ This binding uses the common clock binding[1]. ...@@ -31,10 +31,10 @@ This binding uses the common clock binding[1].
Each subnode should use the binding described in [2]..[7] Each subnode should use the binding described in [2]..[7]
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
[3] Documentation/devicetree/bindings/clock/st,clkgen-mux.txt [3] Documentation/devicetree/bindings/clock/st/st,clkgen-mux.txt
[4] Documentation/devicetree/bindings/clock/st,clkgen-pll.txt [4] Documentation/devicetree/bindings/clock/st/st,clkgen-pll.txt
[7] Documentation/devicetree/bindings/clock/st,quadfs.txt [7] Documentation/devicetree/bindings/clock/st/st,quadfs.txt
[8] Documentation/devicetree/bindings/clock/st,flexgen.txt [8] Documentation/devicetree/bindings/clock/st/st,flexgen.txt
Required properties: Required properties:
......
...@@ -10,7 +10,7 @@ will be controlled instead and the corresponding hw-ops for ...@@ -10,7 +10,7 @@ will be controlled instead and the corresponding hw-ops for
that is used. that is used.
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
[2] Documentation/devicetree/bindings/clock/gate-clock.txt [2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
[3] Documentation/devicetree/bindings/clock/ti/clockdomain.txt [3] Documentation/devicetree/bindings/clock/ti/clockdomain.txt
Required properties: Required properties:
......
...@@ -9,7 +9,7 @@ companion clock finding (match corresponding functional gate ...@@ -9,7 +9,7 @@ companion clock finding (match corresponding functional gate
clock) and hardware autoidle enable / disable. clock) and hardware autoidle enable / disable.
[1] Documentation/devicetree/bindings/clock/clock-bindings.txt [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
[2] Documentation/devicetree/bindings/clock/gate-clock.txt [2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
Required properties: Required properties:
- compatible : shall be one of: - compatible : shall be one of:
......
...@@ -8,7 +8,7 @@ Required properties: ...@@ -8,7 +8,7 @@ Required properties:
"intermediate" - A parent of "cpu" clock which is used as "intermediate" clock "intermediate" - A parent of "cpu" clock which is used as "intermediate" clock
source (usually MAINPLL) when the original CPU PLL is under source (usually MAINPLL) when the original CPU PLL is under
transition and not stable yet. transition and not stable yet.
Please refer to Documentation/devicetree/bindings/clk/clock-bindings.txt for Please refer to Documentation/devicetree/bindings/clock/clock-bindings.txt for
generic clock consumer properties. generic clock consumer properties.
- operating-points-v2: Please refer to Documentation/devicetree/bindings/opp/opp.txt - operating-points-v2: Please refer to Documentation/devicetree/bindings/opp/opp.txt
for detail. for detail.
......
...@@ -12,7 +12,7 @@ Required properties: ...@@ -12,7 +12,7 @@ Required properties:
- clocks: Phandles for clock specified in "clock-names" property - clocks: Phandles for clock specified in "clock-names" property
- clock-names : The name of clock used by the DFI, must be - clock-names : The name of clock used by the DFI, must be
"pclk_ddr_mon"; "pclk_ddr_mon";
- operating-points-v2: Refer to Documentation/devicetree/bindings/power/opp.txt - operating-points-v2: Refer to Documentation/devicetree/bindings/opp/opp.txt
for details. for details.
- center-supply: DMC supply node. - center-supply: DMC supply node.
- status: Marks the node enabled/disabled. - status: Marks the node enabled/disabled.
......
...@@ -30,7 +30,7 @@ Optional properties: ...@@ -30,7 +30,7 @@ Optional properties:
- nxp,calib-gpios: calibration GPIO, which must correspond with the - nxp,calib-gpios: calibration GPIO, which must correspond with the
gpio used for the TDA998x interrupt pin. gpio used for the TDA998x interrupt pin.
[1] Documentation/sound/alsa/soc/DAI.txt [1] Documentation/sound/soc/dai.rst
[2] include/dt-bindings/display/tda998x.h [2] include/dt-bindings/display/tda998x.h
Example: Example:
......
...@@ -34,7 +34,7 @@ Optional properties: ...@@ -34,7 +34,7 @@ Optional properties:
- mali-supply : Phandle to regulator for the Mali device. Refer to - mali-supply : Phandle to regulator for the Mali device. Refer to
Documentation/devicetree/bindings/regulator/regulator.txt for details. Documentation/devicetree/bindings/regulator/regulator.txt for details.
- operating-points-v2 : Refer to Documentation/devicetree/bindings/power/opp.txt - operating-points-v2 : Refer to Documentation/devicetree/bindings/opp/opp.txt
for details. for details.
......
...@@ -44,7 +44,7 @@ Optional properties: ...@@ -44,7 +44,7 @@ Optional properties:
- memory-region: - memory-region:
Memory region to allocate from, as defined in Memory region to allocate from, as defined in
Documentation/devicetree/bindi/reserved-memory/reserved-memory.txt Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt
- mali-supply: - mali-supply:
Phandle to regulator for the Mali device, as defined in Phandle to regulator for the Mali device, as defined in
......
...@@ -12,7 +12,7 @@ Additional documentation for F11 can be found at: ...@@ -12,7 +12,7 @@ Additional documentation for F11 can be found at:
http://www.synaptics.com/sites/default/files/511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf http://www.synaptics.com/sites/default/files/511-000136-01-Rev-E-RMI4-Interfacing-Guide.pdf
Optional Touch Properties: Optional Touch Properties:
Description in Documentation/devicetree/bindings/input/touch Description in Documentation/devicetree/bindings/input/touchscreen
- touchscreen-inverted-x - touchscreen-inverted-x
- touchscreen-inverted-y - touchscreen-inverted-y
- touchscreen-swapped-x-y - touchscreen-swapped-x-y
......
...@@ -28,7 +28,7 @@ Deprecated properties: ...@@ -28,7 +28,7 @@ Deprecated properties:
This property is deprecated. Instead, a 'steps-per-period ' value should This property is deprecated. Instead, a 'steps-per-period ' value should
be used, such as "rotary-encoder,steps-per-period = <2>". be used, such as "rotary-encoder,steps-per-period = <2>".
See Documentation/input/rotary-encoder.txt for more information. See Documentation/input/devices/rotary-encoder.rst for more information.
Example: Example:
......
...@@ -28,7 +28,7 @@ See: Documentation/devicetree/bindings/clock/clock-bindings.txt ...@@ -28,7 +28,7 @@ See: Documentation/devicetree/bindings/clock/clock-bindings.txt
- pinctrl-names : a pinctrl state named tsin%d-serial or tsin%d-parallel (where %d is tsin-num) - pinctrl-names : a pinctrl state named tsin%d-serial or tsin%d-parallel (where %d is tsin-num)
must be defined for each tsin child node. must be defined for each tsin child node.
- pinctrl-0 : phandle referencing pin configuration for this tsin configuration - pinctrl-0 : phandle referencing pin configuration for this tsin configuration
See: Documentation/devicetree/bindings/pinctrl/pinctrl-binding.txt See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
Required properties (tsin (child) node): Required properties (tsin (child) node):
......
...@@ -46,7 +46,7 @@ is required: ...@@ -46,7 +46,7 @@ is required:
Following properties are require if pin control setting is required Following properties are require if pin control setting is required
at boot. at boot.
- pinctrl-names: A pinctrl state named "default" be defined, using the - pinctrl-names: A pinctrl state named "default" be defined, using the
bindings in pinctrl/pinctrl-binding.txt. bindings in pinctrl/pinctrl-bindings.txt.
- pinctrl[0...n]: Properties to contain the phandle that refer to - pinctrl[0...n]: Properties to contain the phandle that refer to
different nodes of pin control settings. These nodes represents different nodes of pin control settings. These nodes represents
the pin control setting of state 0 to state n. Each of these the pin control setting of state 0 to state n. Each of these
......
...@@ -12,7 +12,7 @@ MT6397/MT6323 is a multifunction device with the following sub modules: ...@@ -12,7 +12,7 @@ MT6397/MT6323 is a multifunction device with the following sub modules:
It is interfaced to host controller using SPI interface by a proprietary hardware It is interfaced to host controller using SPI interface by a proprietary hardware
called PMIC wrapper or pwrap. MT6397/MT6323 MFD is a child device of pwrap. called PMIC wrapper or pwrap. MT6397/MT6323 MFD is a child device of pwrap.
See the following for pwarp node definitions: See the following for pwarp node definitions:
Documentation/devicetree/bindings/soc/pwrap.txt Documentation/devicetree/bindings/soc/mediatek/pwrap.txt
This document describes the binding for MFD device and its sub module. This document describes the binding for MFD device and its sub module.
......
...@@ -8,8 +8,8 @@ Required properties: ...@@ -8,8 +8,8 @@ Required properties:
- reg: The PRCM registers range - reg: The PRCM registers range
The prcm node may contain several subdevices definitions: The prcm node may contain several subdevices definitions:
- see Documentation/devicetree/clk/sunxi.txt for clock devices - see Documentation/devicetree/bindings/clock/sunxi.txt for clock devices
- see Documentation/devicetree/reset/allwinner,sunxi-clock-reset.txt for reset - see Documentation/devicetree/bindings/reset/allwinner,sunxi-clock-reset.txt for reset
controller devices controller devices
......
...@@ -62,7 +62,7 @@ Required properties for a slot (Deprecated - Recommend to use one slot per host) ...@@ -62,7 +62,7 @@ Required properties for a slot (Deprecated - Recommend to use one slot per host)
rest of the gpios (depending on the bus-width property) are the data lines in rest of the gpios (depending on the bus-width property) are the data lines in
no particular order. The format of the gpio specifier depends on the gpio no particular order. The format of the gpio specifier depends on the gpio
controller. controller.
(Deprecated - Refer to Documentation/devicetree/binding/pinctrl/samsung-pinctrl.txt) (Deprecated - Refer to Documentation/devicetree/bindings/pinctrl/samsung-pinctrl.txt)
Example: Example:
......
...@@ -12,7 +12,7 @@ Required properties: ...@@ -12,7 +12,7 @@ Required properties:
See: Documentation/devicetree/bindings/clock/clock-bindings.txt See: Documentation/devicetree/bindings/clock/clock-bindings.txt
- pinctrl-names: A pinctrl state names "default" must be defined. - pinctrl-names: A pinctrl state names "default" must be defined.
- pinctrl-0: Phandle referencing pin configuration of the SDHCI controller. - pinctrl-0: Phandle referencing pin configuration of the SDHCI controller.
See: Documentation/devicetree/bindings/pinctrl/pinctrl-binding.txt See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
Example: Example:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment