[PULL] Docs for 4.12

From: Jonathan Corbet
Date: Mon May 01 2017 - 11:53:13 EST

The following changes since commit
c1ae3cfa0e89fa1a7ecc4c99031f5e9ae99d9201:

Linux 4.11-rc1 (2017-03-05 12:59:56 -0800)

are available in the git repository at:

git://git.lwn.net/linux.git tags/docs-4.12

for you to fetch changes up to 9bb0e9cb04c82d6bf0e72f3207307d621083b801:

docs: Fix a couple typos (2017-04-27 15:54:39 -0600)

----------------------------------------------------------------
A reasonably busy cycle for documentation this time around. There is a new
guide for user-space API documents, rather sparsely populated at the
moment, but it's a start. Markus improved the infrastructure for
converting diagrams. Mauro has converted much of the USB documentation
over to RST. Plus the usual set of fixes, improvements, and tweaks.

There's a bit more than the usual amount of reaching out of Documentation/
to fix comments elsewhere in the tree; I have acks for those where I could
get them.

There will be minor conflicts with the input and USB trees due to the
(probably substandard) way in which documentation changes were split
across those trees and docs-next. I'll have another small pull after
input is merged to wire up the newly converted input docs.

---------------------------------------------------------------- Andrew
Clayton (1): docs: process/4.Coding.rst: Fix a couple of document refs

Baruch Siach (1):
doc: ABI: vdso: update parse_vdso.c reference

Cao jin (2):
pci-error-recovery: doc cleanup
sparse doc: fix reference path

Daniel Vetter (1):
doc: Explain light-handed markup preference a bit better

Hans Holmberg (1):
lib/Kconfig.debug: correct documentation paths

Herton R. Krzesinski (1):
Documentation: allow installing man pages to a user defined directory

Jacob Pan (1):
Doc/PM: Sync with intel_powerclamp code behavior

Johan Hovold (1):
Documentation: stable-kernel-rules: fix stable-tag format

Jonathan Corbet (4):
Merge tag 'v4.11-rc1' into docs-next
docs: Create a user-space API guide
docs: Convert unshare.txt to RST and add to the user-space API manual
Merge branch 'user-space-api' into docs-next

Kees Cook (1):
docs: Clarify details for reporting security bugs

Markus Heiser (1):
docs-rst: automatically convert Graphviz and SVG images

Martin Kepplinger (4):
Documentation: hid: fix path to input bus definitions
Documentation: input: fix path to input code defnitions
Documentation: admin-guide: fix path to input key definitions
Documentation: input: fix path to struct ff_effect's definition

Mauro Carvalho Chehab (36):
docs-rst: Don't use explicit Makefile rules to build SVG and DOT files
scripts/kernel-doc: fix parser for apostrophes
scripts/kernel-doc: fix handling of parameters with parenthesis
genericirq.tmpl: convert it to ReST
genericirq.rst: add cross-reference links and use monospaced fonts
kernel-api.tmpl: convert it to ReST
kernel-api.rst: make it handle lib/crc32.c
docs-rst: core_api: move driver-specific stuff to drivers_api
kernel-api.rst: fix output of the vsnprintf() documentation
kernel-api.rst: fix some complex tags at lib/bitmap.c
kernel-api.rst: fix a series of errors when parsing C files
tmplcvt: make the tool more robust
driver-api/basics.rst: add device table header
docs-rst: convert usb docbooks to ReST
usb.rst: Enrich its ReST representation
gadget.rst: Enrich its ReST representation and add kernel-doc tag
writing_usb_driver.rst: Enrich its ReST representation
writing_musb_glue_layer.rst: Enrich its ReST representation
usb/anchors.txt: convert to ReST and add to driver-api book
usb/bulk-streams.txt: convert to ReST and add to driver-api book
usb/callbacks.txt: convert to ReST and add to driver-api book
usb/power-management.txt: convert to ReST and add to driver-api book
usb/dma.txt: convert to ReST and add to driver-api book
error-codes.rst: convert to ReST and add to driver-api book
usb/hotplug.txt: convert to ReST and add to driver-api book
usb/persist.txt: convert to ReST and add to driver-api book
usb/URB.txt: convert to ReST and update it
usb.rst: get rid of some Sphinx errors
usb: get rid of some ReST doc build errors
usb: composite.h: fix two warnings when building docs
usb: gadget.h: be consistent at kernel doc macros
docs-rst: fix usb cross-references
docs-rst: usb: update old usbfs-related documentation
convert philips.txt to ReST and add to media docs
usb.rst: move documentation from proc_usb_info.txt to USB ReST book
zr364xx.rst: usb/devices is now at /sys/kernel/debug/

Perr Zhang (1):
arm: Documentation: update a path name

Rafael J. Wysocki (1):
cpufreq: User/admin documentation update and consolidation

RÃmy LÃone (1):
Use sphinx.version_info directly instead of parsing

SeongJae Park (1):
Documentation: Fix dead URLs to ftp.kernel.org

Stan Drozd (3):
docs: Fix a spelling error in ioctl-number.txt
docs: Fix a spelling error in vfio-mediated-device.txt
docs: Fix a couple typos

Tamara Diaconita (7):
Documentation: admin-guide: Fix typos
Documentation: acpi: Fix typos
Documentation: sync_file.txt: Fix typos
Documentation: vfio-mediated-device.txt: Fix typos
Documentaion: leds: leds-lp55xx.txt: Fix typos
Documentation: mmc: mmc-dev-attrs.txt: Fix typos
Documentation: md: md-cluster.txt: Fix typos

Tobias Klauser (1):
MAINTAINERS: update file entry for HSI subsystem

Tsugikazu Shibata (1):
Documentation: Add HOWTO Japanese translation into rst based build system

sayli karnik (5):
Documentation: phy: Fix repetition of word 'the'
Documentation: ABI: testing: sysfs-bus-pci: Fix repetition of word 'the'
Documentation: cpu-freq: cpu-drivers: Fix repetition of word 'to'
Documentation: device-mapper: cache.txt: Fix typos
Documentation: Add flexible-arrays.rst to the documentation tree

Documentation/ABI/stable/sysfs-bus-usb | 2 +-
Documentation/ABI/stable/vdso | 3 +-
Documentation/ABI/testing/sysfs-bus-pci | 2 +-
Documentation/DocBook/Makefile | 22 +-
Documentation/DocBook/gadget.tmpl | 793 -------------------
Documentation/DocBook/genericirq.tmpl | 520 ------------
Documentation/DocBook/kernel-api.tmpl | 331 --------
Documentation/DocBook/writing_musb_glue_layer.tmpl | 873 ---------------------
Documentation/DocBook/writing_usb_driver.tmpl | 412 ----------
Documentation/PCI/pci-error-recovery.txt | 12 +-
Documentation/acpi/aml-debugger.txt | 2 +-
Documentation/acpi/enumeration.txt | 6 +-
Documentation/acpi/linuxized-acpica.txt | 6 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.rst | 4 +-
Documentation/admin-guide/pm/cpufreq.rst | 700 +++++++++++++++++
Documentation/admin-guide/pm/index.rst | 15 +
Documentation/admin-guide/ras.rst | 12 +-
Documentation/admin-guide/security-bugs.rst | 39 +-
Documentation/admin-guide/sysrq.rst | 3 +-
Documentation/arm/mem_alignment | 2 +-
Documentation/conf.py | 6 +-
Documentation/core-api/flexible-arrays.rst | 130 +++
Documentation/core-api/genericirq.rst | 440 +++++++++++
Documentation/core-api/index.rst | 3 +
Documentation/core-api/kernel-api.rst | 346 ++++++++
Documentation/cpu-freq/boost.txt | 93 ---
Documentation/cpu-freq/cpu-drivers.txt | 2 +-
Documentation/cpu-freq/governors.txt | 301 -------
Documentation/cpu-freq/index.txt | 7 -
Documentation/cpu-freq/user-guide.txt | 228 ------
Documentation/cputopology.txt | 2 +-
Documentation/debugging-via-ohci1394.txt | 4 +-
Documentation/device-mapper/cache.txt | 2 +-
Documentation/doc-guide/hello.dot | 3 +
Documentation/doc-guide/sphinx.rst | 115 ++-
Documentation/doc-guide/svg_image.svg | 10 +
Documentation/driver-api/basics.rst | 6 +
Documentation/driver-api/firmware/index.rst | 1 +
.../driver-api/firmware/other_interfaces.rst | 15 +
Documentation/driver-api/index.rst | 4 +-
Documentation/driver-api/misc_devices.rst | 5 +
Documentation/driver-api/pci.rst | 50 ++
.../{usb/URB.txt => driver-api/usb/URB.rst} | 223 +++---
.../anchors.txt => driver-api/usb/anchors.rst} | 36 +-
.../usb/bulk-streams.rst} | 13 +-
.../callbacks.txt => driver-api/usb/callbacks.rst} | 65 +-
.../{usb/dma.txt => driver-api/usb/dma.rst} | 51 +-
Documentation/driver-api/usb/error-codes.rst | 207 +++++
Documentation/driver-api/usb/gadget.rst | 510 ++++++++++++
.../hotplug.txt => driver-api/usb/hotplug.rst} | 68 +-
Documentation/driver-api/usb/index.rst | 26 +
.../persist.txt => driver-api/usb/persist.rst} | 22 +-
.../usb/power-management.rst} | 404 +++++-----
Documentation/driver-api/{ => usb}/usb.rst | 827 ++++++++++++-------
.../driver-api/usb/writing_musb_glue_layer.rst | 723 +++++++++++++++++
.../driver-api/usb/writing_usb_driver.rst | 326 ++++++++
Documentation/early-userspace/README | 2 +-
Documentation/filesystems/ext4.txt | 2 +-
Documentation/filesystems/nfs/nfs-rdma.txt | 4 +-
Documentation/hid/hidraw.txt | 2 +-
Documentation/index.rst | 20 +
Documentation/input/ff.txt | 6 +-
Documentation/input/input-programming.txt | 4 +-
Documentation/ioctl/ioctl-number.txt | 2 +-
Documentation/leds/leds-lp55xx.txt | 2 +-
Documentation/md/md-cluster.txt | 2 +-
Documentation/media/Makefile | 47 +-
Documentation/media/intro.rst | 6 +-
Documentation/media/uapi/dvb/intro.rst | 6 +-
Documentation/media/uapi/v4l/crop.rst | 4 +-
Documentation/media/uapi/v4l/dev-raw-vbi.rst | 22 +-
Documentation/media/uapi/v4l/dev-subdev.rst | 22 +-
Documentation/media/uapi/v4l/field-order.rst | 11 +-
Documentation/media/uapi/v4l/pixfmt-nv12mt.rst | 8 +-
Documentation/media/uapi/v4l/selection-api-003.rst | 6 +-
Documentation/media/uapi/v4l/subdev-formats.rst | 4 +-
Documentation/media/v4l-drivers/index.rst | 1 +
.../media/v4l-drivers/philips.rst | 21 +-
Documentation/media/v4l-drivers/zr364xx.rst | 2 +-
Documentation/mmc/mmc-dev-attrs.txt | 4 +-
Documentation/networking/cdc_mbim.txt | 2 +-
Documentation/networking/e100.txt | 2 +-
Documentation/networking/e1000.txt | 2 +-
Documentation/networking/e1000e.txt | 2 +-
Documentation/networking/igb.txt | 2 +-
Documentation/networking/igbvf.txt | 2 +-
Documentation/networking/ixgb.txt | 2 +-
Documentation/networking/ixgbe.txt | 2 +-
Documentation/phy.txt | 2 +-
Documentation/power/swsusp.txt | 2 +-
Documentation/process/4.Coding.rst | 17 +-
Documentation/process/applying-patches.rst | 12 +-
Documentation/process/changes.rst | 17 +-
Documentation/process/stable-kernel-rules.rst | 2 +-
Documentation/sphinx/cdomain.py | 2 +-
Documentation/sphinx/kfigure.py | 551 +++++++++++++
Documentation/sphinx/tmplcvt | 13 +-
Documentation/static-keys.txt | 2 +-
Documentation/sync_file.txt | 2 +-
Documentation/thermal/intel_powerclamp.txt | 20 +-
.../translations/ja_JP/{HOWTO => howto.rst} | 596 +++++++-------
Documentation/translations/ja_JP/index.rst | 12 +
Documentation/translations/zh_CN/sparse.txt | 4 +-
Documentation/usb/acm.txt | 2 +-
Documentation/usb/error-codes.txt | 175 -----
Documentation/usb/gadget_serial.txt | 4 +-
Documentation/usb/proc_usb_info.txt | 390 ---------
Documentation/userspace-api/conf.py | 10 +
Documentation/userspace-api/index.rst | 26 +
.../{unshare.txt => userspace-api/unshare.rst} | 195 +++--
Documentation/vfio-mediated-device.txt | 8 +-
Documentation/zorro.txt | 2 +-
MAINTAINERS | 2 +-
Makefile | 4 +-
block/genhd.c | 7 +-
drivers/pci/irq.c | 2 +-
drivers/staging/most/hdm-usb/hdm_usb.c | 2 +-
drivers/usb/core/Kconfig | 2 +-
drivers/usb/core/message.c | 1 +
include/linux/clk.h | 4 +-
include/linux/flex_array.h | 67 ++
include/linux/usb/composite.h | 6 +-
include/linux/usb/gadget.h | 2 +-
ipc/util.c | 12 +-
lib/Kconfig.debug | 9 +-
lib/bitmap.c | 28 +-
lib/string.c | 2 +-
lib/vsprintf.c | 6 +-
mm/filemap.c | 18 +-
mm/page_alloc.c | 3 +-
mm/vmalloc.c | 2 +-
scripts/kernel-doc | 19 +-
security/security.c | 12 +-
134 files changed, 6115 insertions(+), 5421 deletions(-)
delete mode 100644 Documentation/DocBook/gadget.tmpl
delete mode 100644 Documentation/DocBook/genericirq.tmpl
delete mode 100644 Documentation/DocBook/kernel-api.tmpl
delete mode 100644 Documentation/DocBook/writing_musb_glue_layer.tmpl
delete mode 100644 Documentation/DocBook/writing_usb_driver.tmpl
create mode 100644 Documentation/admin-guide/pm/cpufreq.rst
create mode 100644 Documentation/admin-guide/pm/index.rst
create mode 100644 Documentation/core-api/flexible-arrays.rst
create mode 100644 Documentation/core-api/genericirq.rst
create mode 100644 Documentation/core-api/kernel-api.rst
delete mode 100644 Documentation/cpu-freq/boost.txt
delete mode 100644 Documentation/cpu-freq/governors.txt
delete mode 100644 Documentation/cpu-freq/user-guide.txt
create mode 100644 Documentation/doc-guide/hello.dot
create mode 100644 Documentation/doc-guide/svg_image.svg
create mode 100644 Documentation/driver-api/firmware/other_interfaces.rst
create mode 100644 Documentation/driver-api/misc_devices.rst
create mode 100644 Documentation/driver-api/pci.rst
rename Documentation/{usb/URB.txt => driver-api/usb/URB.rst} (50%)
rename Documentation/{usb/anchors.txt => driver-api/usb/anchors.rst} (75%)
rename Documentation/{usb/bulk-streams.txt => driver-api/usb/bulk-streams.rst} (94%)
rename Documentation/{usb/callbacks.txt => driver-api/usb/callbacks.rst} (76%)
rename Documentation/{usb/dma.txt => driver-api/usb/dma.rst} (79%)
create mode 100644 Documentation/driver-api/usb/error-codes.rst
create mode 100644 Documentation/driver-api/usb/gadget.rst
rename Documentation/{usb/hotplug.txt => driver-api/usb/hotplug.rst} (76%)
create mode 100644 Documentation/driver-api/usb/index.rst
rename Documentation/{usb/persist.txt => driver-api/usb/persist.rst} (94%)
rename Documentation/{usb/power-management.txt => driver-api/usb/power-management.rst} (69%)
rename Documentation/driver-api/{ => usb}/usb.rst (50%)
create mode 100644 Documentation/driver-api/usb/writing_musb_glue_layer.rst
create mode 100644 Documentation/driver-api/usb/writing_usb_driver.rst
rename drivers/media/usb/pwc/philips.txt => Documentation/media/v4l-drivers/philips.rst (95%)
create mode 100644 Documentation/sphinx/kfigure.py
rename Documentation/translations/ja_JP/{HOWTO => howto.rst} (53%)
create mode 100644 Documentation/translations/ja_JP/index.rst
delete mode 100644 Documentation/usb/error-codes.txt
delete mode 100644 Documentation/usb/proc_usb_info.txt
create mode 100644 Documentation/userspace-api/conf.py
create mode 100644 Documentation/userspace-api/index.rst
rename Documentation/{unshare.txt => userspace-api/unshare.rst} (67%)