[PULL] Documentation changes for 4.15

From: Jonathan Corbet
Date: Sun Nov 12 2017 - 16:47:02 EST

Next message: James Morris: "[GIT PULL] Security subsystem general updates for 4.15"
Previous message: SF Markus Elfring: "[PATCH 2/2] ALSA: au88x0: Use common error handling code in two functions"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

The following changes since commit
e19b205be43d11bff638cad4487008c48d21c103:

Linux 4.14-rc2 (2017-09-24 16:38:56 -0700)

are available in the git repository at:

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

for you to fetch changes up to 47427379ea80f1368ccec6ba20874fc19a9f0cc4:

documentation: fb: update list of available compiled-in fonts (2017-11-08 03:39:52 -0700)

----------------------------------------------------------------
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.

There is one conflict that I know you'll see: Greg's driver-statement
patch conflicts with Greg's enforcement-statement patch that went into
4.14. The fix is obvious: just take both sides.

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. Please let me know
if you would like such changes to be handled differently.

----------------------------------------------------------------
Adam Borowski (1):
Documentation/features/KASAN: mark KASAN as supported only on 64-bit on x86

Borislav Petkov (1):
Documentation: Improve softlockup_panic= description text

Christophe JAILLET (1):
bug-hunting.rst: Fix an example and a typo in a Sphinx tag

Daniel Xu (1):
console: Update to reflect new default value

Finn Thain (1):
documentation: Update ide-cd documentation to reflect CONFIG_BLK_DEV_HD_IDE removal

Greg Kroah-Hartman (1):
Documentation: add Kernel Driver Statement to the kernel

Jani Nikula (1):
Documentation: add script and build target to check for broken file references

Johannes Berg (1):
scripts/kernel-doc: warn on excess enum value descriptions

Jonathan Corbet (1):
Merge branch 'refs' into docs-next

Julia Lawall (1):
docs: dev-tools: correct Coccinelle version number

Junio C Hamano (2):
Documentation/process: fix the canonical patch format description
Documentation/process: phrasofix

Kees Cook (1):
samples: Convert timers to use timer_setup()

Pavel Machek (1):
Documentation: fix little inconsistencies

Rafael J. Wysocki (1):
PM: docs: Fix stale reference in kernel-parameters.txt

Randy Dunlap (10):
Documentation: kernel-api: drop "Data Types" section
Documentation: kernel-api: add bitmap operations from linux/bitmap.h
docs: clean up and add rest of CRC functions to kernel-api.rst
linux/log2.h: fix kernel-doc notation
div64: add missing kernel-doc
math64: add missing kernel-doc notation
lib/gcd: add kernel-doc notation
Documentation: add kernel-api section on Math functions
documentation: kernel-api: add more info on bitmap functions
documentation: fb: update list of available compiled-in fonts

Shuah Khan (3):
doc: dev-tools: kselftest.rst: update to include make O=dir support
doc: enhance dochelp include default output location for doc build
Makefile: enable dochelp run from main make level

Steven Rostedt (1):
ftrace/docs: Add documentation on how to use ftrace from within the kernel

Tom Saeger (16):
docs: Update binfmt_misc links
Documentation: fix driver-api doc refs
Documentation: fix admin-guide doc refs
Documentation: fix input related doc refs
Documentation: fix security related doc refs
Documentation: fix media related doc refs
Documentation: fix sound related doc refs
Documentation: fix usb related doc refs
Documentation: fix networking related doc refs.
Documentation: fix locking rt-mutex doc refs
Documentation: fix ref to sphinx/kerneldoc.py
Documentation: fix ref to workqueue content
Documentation: fix ref to coccinelle content
Documentation: fix ref to trace stm content
Documentation: fix ref to power basic-pm-debugging
Documentation: fix selftests related file refs

Vinod Koul (6):
dmaengine: doc: Add ReST style dmaengine document
dmaengine: doc: ReSTize provider doc
dmaengine: doc: ReSTize client API doc
dmaengine: doc: ReSTize dmatest doc
dmaengine: doc: ReSTize pxa_dma doc
MAINTAINERS: update DMAengine documentation location

sayli karnik (1):
scripts: Add a script to find unused documentation

stephen lu (1):
docs: highres: fix broken urls

Documentation/ABI/stable/sysfs-devices | 2 +-
Documentation/ABI/testing/evm | 4 +-
Documentation/ABI/testing/sysfs-devices-system-cpu | 6 +-
Documentation/ABI/testing/sysfs-power | 6 +-
Documentation/Makefile | 6 +
.../Expedited-Grace-Periods.html | 2 +-
Documentation/admin-guide/README.rst | 2 +-
Documentation/admin-guide/bug-hunting.rst | 8 +-
Documentation/admin-guide/kernel-parameters.txt | 28 +-
Documentation/admin-guide/reporting-bugs.rst | 4 +-
Documentation/cdrom/ide-cd | 6 +-
Documentation/core-api/kernel-api.rst | 55 ++-
Documentation/dev-tools/coccinelle.rst | 2 +-
Documentation/dev-tools/kselftest.rst | 34 +-
Documentation/dmaengine/00-INDEX | 8 -
Documentation/dmaengine/client.txt | 222 ---------
Documentation/dmaengine/provider.txt | 424 -----------------
Documentation/dmaengine/pxa_dma.txt | 153 -------
Documentation/doc-guide/kernel-doc.rst | 2 +-
Documentation/driver-api/dmaengine/client.rst | 275 +++++++++++
.../dmaengine/dmatest.rst} | 96 ++--
Documentation/driver-api/dmaengine/index.rst | 55 +++
Documentation/driver-api/dmaengine/provider.rst | 508 +++++++++++++++++++++
Documentation/driver-api/dmaengine/pxa_dma.rst | 190 ++++++++
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/usb/usb.rst | 4 +-
Documentation/fb/fbcon.txt | 4 +-
.../features/debug/KASAN/arch-support.txt | 2 +-
Documentation/filesystems/dnotify.txt | 2 +-
Documentation/filesystems/ext4.txt | 8 +-
Documentation/hid/hiddev.txt | 2 +-
Documentation/input/devices/xpad.rst | 3 +-
Documentation/laptops/laptop-mode.txt | 6 +-
Documentation/locking/rt-mutex-design.txt | 2 +-
Documentation/media/dvb-drivers/bt8xx.rst | 8 +-
Documentation/media/uapi/v4l/dev-sliced-vbi.rst | 2 +-
Documentation/media/uapi/v4l/extended-controls.rst | 2 +-
Documentation/media/uapi/v4l/pixfmt-reserved.rst | 2 +-
Documentation/media/v4l-drivers/bttv.rst | 2 +-
Documentation/media/v4l-drivers/max2175.rst | 2 +-
Documentation/networking/cdc_mbim.txt | 4 +-
Documentation/networking/checksum-offloads.txt | 2 +-
Documentation/networking/packet_mmap.txt | 2 +-
Documentation/pi-futex.txt | 2 +-
Documentation/power/interface.txt | 5 +-
Documentation/power/pci.txt | 10 +-
Documentation/power/runtime_pm.txt | 2 +-
Documentation/process/3.Early-stage.rst | 2 +-
Documentation/process/4.Coding.rst | 2 +-
Documentation/process/index.rst | 1 +
Documentation/process/kernel-driver-statement.rst | 199 ++++++++
Documentation/process/submitting-drivers.rst | 2 +-
Documentation/process/submitting-patches.rst | 8 +-
Documentation/security/LSM.rst | 2 +-
Documentation/security/credentials.rst | 2 +-
Documentation/security/keys/request-key.rst | 2 +-
Documentation/sound/cards/joystick.rst | 2 +-
Documentation/sound/hd-audio/notes.rst | 2 +-
.../sound/kernel-api/writing-an-alsa-driver.rst | 2 +-
Documentation/sysctl/README | 2 +-
Documentation/sysctl/fs.txt | 2 +-
Documentation/timers/highres.txt | 4 +-
Documentation/trace/ftrace-uses.rst | 293 ++++++++++++
Documentation/trace/intel_th.txt | 2 +-
Documentation/usb/gadget-testing.txt | 2 +-
Documentation/watchdog/hpwdt.txt | 2 +-
Documentation/watchdog/pcwd-watchdog.txt | 2 +-
MAINTAINERS | 2 +-
Makefile | 3 +-
include/asm-generic/div64.h | 14 +
include/linux/bitmap.h | 114 ++---
include/linux/log2.h | 42 +-
include/linux/math64.h | 27 ++
lib/bitmap.c | 4 +-
lib/crc32.c | 2 +-
lib/crc4.c | 2 +-
lib/crc8.c | 22 +-
lib/div64.c | 6 +
lib/gcd.c | 6 +
samples/connector/cn_test.c | 6 +-
scripts/documentation-file-ref-check | 15 +
scripts/find-unused-docs.sh | 62 +++
scripts/kernel-doc | 17 +-
83 files changed, 2015 insertions(+), 1041 deletions(-)
delete mode 100644 Documentation/dmaengine/00-INDEX
delete mode 100644 Documentation/dmaengine/client.txt
delete mode 100644 Documentation/dmaengine/provider.txt
delete mode 100644 Documentation/dmaengine/pxa_dma.txt
create mode 100644 Documentation/driver-api/dmaengine/client.rst
rename Documentation/{dmaengine/dmatest.txt => driver-api/dmaengine/dmatest.rst} (50%)
create mode 100644 Documentation/driver-api/dmaengine/index.rst
create mode 100644 Documentation/driver-api/dmaengine/provider.rst
create mode 100644 Documentation/driver-api/dmaengine/pxa_dma.rst
create mode 100644 Documentation/process/kernel-driver-statement.rst
create mode 100644 Documentation/trace/ftrace-uses.rst
create mode 100755 scripts/documentation-file-ref-check
create mode 100755 scripts/find-unused-docs.sh

Next message: James Morris: "[GIT PULL] Security subsystem general updates for 4.15"
Previous message: SF Markus Elfring: "[PATCH 2/2] ALSA: au88x0: Use common error handling code in two functions"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]