Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

Documentation/ABI/obsolete/sysfs-gpio

+1 −1
Original line number Original line Diff line number Diff line
@@ -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

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

+0 −3
Original line number Original line Diff line number Diff line
@@ -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

Documentation/admin-guide/kernel-parameters.txt

+3 −6
Original line number Original line Diff line number Diff line
@@ -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 @@ 
			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 @@ 
			[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 @@ 




			      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]

Documentation/crypto/crypto_engine.rst

+5 −3
Original line number Original line Diff line number Diff line
@@ -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.

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

+4 −4
Original line number Original line Diff line number Diff line
@@ -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: