Commit 7832681b authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-4.15' of git://git.lwn.net/linux 

Pull documentation updates from Jonathan Corbet:
 "A relatively calm cycle for the docs tree again.

  - The old driver statement has been added to the kernel docs.

  - We have a couple of new helper scripts. find-unused-docs.sh from
    Sayli Karnic will point out kerneldoc comments that are not actually
    used in the documentation. Jani Nikula's
    documentation-file-ref-check finds references to non-existing files.

  - A new ftrace document from Steve Rostedt.

  - Vinod Koul converted the dmaengine docs to RST

  Beyond that, it's mostly simple fixes.

  This set reaches outside of Documentation/ a bit more than most. In
  all cases, the changes are to comment docs, mostly from Randy, in
  places where there didn't seem to be anybody better to take them"

* tag 'docs-4.15' of git://git.lwn.net/linux: (52 commits)
  documentation: fb: update list of available compiled-in fonts
  MAINTAINERS: update DMAengine documentation location
  dmaengine: doc: ReSTize pxa_dma doc
  dmaengine: doc: ReSTize dmatest doc
  dmaengine: doc: ReSTize client API doc
  dmaengine: doc: ReSTize provider doc
  dmaengine: doc: Add ReST style dmaengine document
  ftrace/docs: Add documentation on how to use ftrace from within the kernel
  bug-hunting.rst: Fix an example and a typo in a Sphinx tag
  scripts: Add a script to find unused documentation
  samples: Convert timers to use timer_setup()
  documentation: kernel-api: add more info on bitmap functions
  Documentation: fix selftests related file refs
  Documentation: fix ref to power basic-pm-debugging
  Documentation: fix ref to trace stm content
  Documentation: fix ref to coccinelle content
  Documentation: fix ref to workqueue content
  Documentation: fix ref to sphinx/kerneldoc.py
  Documentation: fix locking rt-mutex doc refs
  docs: dev-tools: correct Coccinelle version number
  ...
parents 516fb7f2 47427379

Documentation/ABI/stable/sysfs-devices

+1 −1
Original line number Diff line number Diff line 
# Note: This documents additional properties of any device beyond what

# is documented in Documentation/sysfs-rules.txt

# is documented in Documentation/admin-guide/sysfs-rules.rst



What:		/sys/devices/*/of_node

Date:		February 2015

Documentation/ABI/testing/evm

+2 −2
Original line number Diff line number Diff line
@@ -18,6 +18,6 @@ Description: 
		in the initramfs, which has already been measured as part

		of the trusted boot.  For more information on creating and

		loading existing trusted/encrypted keys, refer to:

		Documentation/keys-trusted-encrypted.txt.  (A sample dracut

		patch, which loads the trusted/encrypted key and enables

		Documentation/security/keys/trusted-encrypted.rst.  (A sample

		dracut patch, which loads the trusted/encrypted key and enables

		EVM, is available from http://linux-ima.sourceforge.net/#EVM.)

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

+4 −2
Original line number Diff line number Diff line
@@ -187,7 +187,8 @@ Description: Processor frequency boosting control 
		This switch controls the boost setting for the whole system.

		Boosting allows the CPU and the firmware to run at a frequency

		beyound it's nominal limit.

		More details can be found in Documentation/cpu-freq/boost.txt

		More details can be found in

		Documentation/admin-guide/pm/cpufreq.rst





What:		/sys/devices/system/cpu/cpu#/crash_notes
@@ -223,7 +224,8 @@ Description: Parameters for the Intel P-state driver 
		no_turbo: limits the driver to selecting P states below the turbo

		frequency range.



		More details can be found in Documentation/cpu-freq/intel-pstate.txt

		More details can be found in

		Documentation/admin-guide/pm/intel_pstate.rst



What:		/sys/devices/system/cpu/cpu*/cache/index*/<set_of_attributes_mentioned_below>

Date:		July 2014(documented, existed before August 2008)

Documentation/ABI/testing/sysfs-power

+4 −2
Original line number Diff line number Diff line
@@ -18,7 +18,8 @@ Description: 
		Writing one of the above strings to this file causes the system

		to transition into the corresponding state, if available.



		See Documentation/power/states.txt for more information.

		See Documentation/admin-guide/pm/sleep-states.rst for more

		information.



What:		/sys/power/mem_sleep

Date:		November 2016
@@ -35,7 +36,8 @@ Description: 
		represented by it to be used on subsequent attempts to suspend

		the system.



		See Documentation/power/states.txt for more information.

		See Documentation/admin-guide/pm/sleep-states.rst for more

		information.



What:		/sys/power/disk

Date:		September 2006

Documentation/Makefile

+6 −0
Original line number Diff line number Diff line
@@ -97,6 +97,9 @@ endif # HAVE_SPHINX 
# The following targets are independent of HAVE_SPHINX, and the rules should

# work or silently pass without Sphinx.



refcheckdocs:

	$(Q)cd $(srctree);scripts/documentation-file-ref-check



cleandocs:

	$(Q)rm -rf $(BUILDDIR)

	$(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean
@@ -109,6 +112,7 @@ dochelp: 
	@echo  '  epubdocs        - EPUB'

	@echo  '  xmldocs         - XML'

	@echo  '  linkcheckdocs   - check for broken external links (will connect to external hosts)'

	@echo  '  refcheckdocs    - check for references to non-existing files under Documentation'

	@echo  '  cleandocs       - clean all generated files'

	@echo

	@echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
@@ -116,3 +120,5 @@ dochelp: 
	@echo

	@echo  '  make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'

	@echo  '  configuration. This is e.g. useful to build with nit-picking config.'

	@echo

	@echo  '  Default location for the generated documents is Documentation/output'

CRA Git | Maintained and supported by SUSTech CRA and CCSE