Commit e9a83bd2 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

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

Pull Documentation updates from Jonathan Corbet:
 "It's been a relatively busy cycle for docs:

   - A fair pile of RST conversions, many from Mauro. These create more
     than the usual number of simple but annoying merge conflicts with
     other trees, unfortunately. He has a lot more of these waiting on
     the wings that, I think, will go to you directly later on.

   - A new document on how to use merges and rebases in kernel repos,
     and one on Spectre vulnerabilities.

   - Various improvements to the build system, including automatic
     markup of function() references because some people, for reasons I
     will never understand, were of the opinion that
     :c:func:``function()`` is unattractive and not fun to type.

   - We now recommend using sphinx 1.7, but still support back to 1.4.

   - Lots of smaller improvements, warning fixes, typo fixes, etc"

* tag 'docs-5.3' of git://git.lwn.net/linux: (129 commits)
  docs: automarkup.py: ignore exceptions when seeking for xrefs
  docs: Move binderfs to admin-guide
  Disable Sphinx SmartyPants in HTML output
  doc: RCU callback locks need only _bh, not necessarily _irq
  docs: format kernel-parameters -- as code
  Doc : doc-guide : Fix a typo
  platform: x86: get rid of a non-existent document
  Add the RCU docs to the core-api manual
  Documentation: RCU: Add TOC tree hooks
  Documentation: RCU: Rename txt files to rst
  Documentation: RCU: Convert RCU UP systems to reST
  Documentation: RCU: Convert RCU linked list to reST
  Documentation: RCU: Convert RCU basic concepts to reST
  docs: filesystems: Remove uneeded .rst extension on toctables
  scripts/sphinx-pre-install: fix out-of-tree build
  docs: zh_CN: submitting-drivers.rst: Remove a duplicated Documentation/
  Documentation: PGP: update for newer HW devices
  Documentation: Add section about CPU vulnerabilities for Spectre
  Documentation: platform: Delete x86-laptop-drivers.txt
  docs: Note that :c:func: should no longer be used
  ...
parents 7011b7e1 454f96f2
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -137,7 +137,8 @@ Description: Discover cpuidle policy and mechanism
		current_governor: (RW) displays current idle policy. Users can
		switch the governor at runtime by writing to this file.

		See files in Documentation/cpuidle/ for more information.
		See Documentation/admin-guide/pm/cpuidle.rst and
		Documentation/driver-api/pm/cpuidle.rst for more information.


What:		/sys/devices/system/cpu/cpuX/cpuidle/stateN/name
+1 −1
Original line number Diff line number Diff line
@@ -11,4 +11,4 @@ Description:
		example would be, if User A has shares = 1024 and user
		B has shares = 2048, User B will get twice the CPU
		bandwidth user A will. For more details refer
		Documentation/scheduler/sched-design-CFS.txt
		Documentation/scheduler/sched-design-CFS.rst
+1 −1
Original line number Diff line number Diff line
@@ -198,7 +198,7 @@ call to set the mask to the value returned.
::

	size_t
	dma_direct_max_mapping_size(struct device *dev);
	dma_max_mapping_size(struct device *dev);

Returns the maximum size of a mapping for the device. The size parameter
of the mapping functions like dma_map_single(), dma_map_page() and
+22 −13
Original line number Diff line number Diff line
:orphan:

====
EDID
====

In the good old days when graphics parameters were configured explicitly
in a file called xorg.conf, even broken hardware could be managed.

@@ -34,10 +40,13 @@ Makefile. Please note that the EDID data structure expects the timing
values in a different way as compared to the standard X11 format.

X11:
HTimings:  hdisp hsyncstart hsyncend htotal
VTimings:  vdisp vsyncstart vsyncend vtotal
  HTimings:
    hdisp hsyncstart hsyncend htotal
  VTimings:
    vdisp vsyncstart vsyncend vtotal

EDID::

EDID:
  #define XPIX hdisp
  #define XBLANK htotal-hdisp
  #define XOFFSET hsyncstart-hdisp

Documentation/Kconfig

0 → 100644
+13 −0
Original line number Diff line number Diff line
config WARN_MISSING_DOCUMENTS

	bool "Warn if there's a missing documentation file"
	depends on COMPILE_TEST
	help
	   It is not uncommon that a document gets renamed.
	   This option makes the Kernel to check for missing dependencies,
	   warning when something is missing. Works only if the Kernel
	   is built from a git tree.

	   If unsure, select 'N'.

Loading