Skip to contentSkip to conversation

Documentation for 4.16

GIT PULL Jonathan Corbet 1 participant 1 message Jan 29, 2018

lore
Share & tools
lore
#0 lore raw

The following changes since commit
50c4c4e268a2d7a3e58ebb698ac74da0de40ae36:

Linux 4.15-rc3 (2017-12-10 17:56:26 -0800)

are available in the Git repository at:

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

for you to fetch changes up to ae17a87dd7c79fa742ef5dcf06d1095eec4e1925:

linux-next: docs-rst: Fix typos in kfigure.py (2018-01-17 16:49:05 -0700)

----------------------------------------------------------------
Documentation updates for 4.16. New stuff includes refcount_t documentation, errseq documentation, kernel-doc support for nested structure definitions, the removal of lots of crufty kernel-doc support for unused formats, SPDX tag documentation, the beginnings of a manual for subsystem maintainers, and lots of fixes and updates.

As usual, some of the changesets reach outside of Documentation/ to effect kerneldoc comment fixes. It also adds the new LICENSES directory, of which Thomas promises I do not need to be the maintainer.

Expect a somewhat unpleasant conflict with the printk tree, which also has changes to printk-formats.rst. The resolution in linux-next is good; please say the word if you'd like me to create a separate resolution for you to apply.

----------------------------------------------------------------
Adam Borowski (2):
Documentation/filesystems/vfat.txt: fix a remark that implies UCS2 fs/*/Kconfig: drop links to 404-compliant http://acl.bestbits.at

Cengiz C (1):
i2c: update i2c-dev.h warning in documentation

Darren Hart (VMware) (2):
Documentation/kbuild: Add guidance for the use of default Documentation/process: Add CONFIG default value to submit-checklist

David Sterba (1):
Documentation: Add myself to the enforcement statement list

Elena Reshetova (1):
docs: refcount_t documentation

Fabio Estevam (1):
doc: usb: chipidea: Fix typo in 'enumerate'

Gergo Huszty (1):
Fixed typo in onewire generic doc

Jonathan Corbet (3):
docs: Add an intro note to the maintainers handbook
docs: Remove "could not extract kernel version" warning
vsprintf: Fix a dangling documentation reference

Jonathan Neuschäfer (1):
Documentation: mono: Update links and s/CVS/Git/

Kees Cook (1):
Documentation: Add Kees Cook to list of enforcement statement endorsers

Lu Baolu (1):
usb: doc: Update document for USB3 debug port usage

Luis R. Rodriguez (1):
Documentation: Add Luis R. Rodriguez to list of enforcement statement endorsers

Marco Donato Torsello (1):
Documentation: kernel-hacking: corrected a typo

Markus Heiser (2):
docs: ftrace-uses.rst fix varios code-block directives
docs: fix process/submit-checklist.rst Sphinx warning

Masanari Iida (3):
doc: md: Fix a file name to md-fault.c in fault-injection.txt
linux-next: DOC: HWPOISON: Fix path to debugfs in hwpoison.txt
linux-next: docs-rst: Fix typos in kfigure.py

Matthew Wilcox (2):
errseq: Add to documentation tree
Documentation: Fix misconversion of #if

Mauro Carvalho Chehab (20):
kernel-doc: parse DECLARE_KFIFO and DECLARE_KFIFO_PTR()
docs: kernel-doc.rst: better describe kernel-doc arguments
docs: kernel-doc.rst: improve private members description
docs: kernel-doc.rst: improve function documentation section
docs: kernel-doc.rst: improve structs chapter
docs: kernel-doc.rst: improve typedef documentation
docs: kernel-doc.rst: add documentation about man pages
docs: get rid of kernel-doc-nano-HOWTO.txt
scripts: kernel-doc: get rid of unused output formats
scripts: kernel-doc: improve argument handling
scripts: kernel-doc: change default to ReST format
scripts: kernel-doc: replace tabs by spaces
scripts: kernel-doc: parse next structs/unions
scripts: kernel-doc: get rid of $nested parameter
scripts: kernel-doc: print the declaration name on warnings
scripts: kernel-doc: handle nested struct function arguments
scripts: kernel-doc: improve nested logic to handle multiple identifiers
scripts: kernel-doc: apply filtering rules to warnings w1_netlink.h: add support for nested structs
scripts: kernel_doc: better handle show warnings logic

NeilBrown (1):
Documentation: security/credentials.rst: explain need to sort group_list

Randy Dunlap (2):
Documentation: add Sorting section to kernel-api
Documentation: add UUID/GUID to kernel-api

Scott Wood (1):
Documentation: Better document the hardlockup_panic sysctl

Stefan Tatschner (1):
Documentation/driver-api/usb: Replace dead link

Thomas Gleixner (11):
Documentation: Add license-rules.rst to describe how to properly identify file licenses
LICENSES: Add the GPL 2.0 license
LICENSES: Add the LGPL 2.0 license
LICENSES: Add the LGPL-2.1 license
LICENSES: Add the BSD 2-clause "Simplified" license
LICENSES: Add the BSD 3-clause "New" or "Revised" License
LICENSES: Add the BSD-3-clause "Clear" license
LICENSES: Add the MIT license
LICENSES: Add Linux syscall note exception
LICENSES: Add the GPL 1.0 license
LICENSES: Add MPL-1.1 license

Tobin C. Harding (5):
doc: add maintainer book
doc: convert printk-formats.txt to rst
doc: update kptr_restrict documentation
doc: add documentation on printing kernel addresses
docs: add index entry for networking/msg_zerocopy

 Documentation/00-INDEX                             |    4 -
 Documentation/admin-guide/kernel-parameters.txt    |    3 +
 Documentation/admin-guide/mono.rst                 |    6 +-
 Documentation/conf.py                              |    1 -
 Documentation/{ => core-api}/errseq.rst            |   20 +-
 Documentation/core-api/index.rst                   |    3 +
 Documentation/core-api/kernel-api.rst              |   15 +
 .../printk-formats.rst}                            |  227 +--
 Documentation/core-api/refcount-vs-atomic.rst      |  150 ++
 Documentation/doc-guide/kernel-doc.rst             |  360 +++--
 Documentation/driver-api/basics.rst                |   21 +-
 Documentation/driver-api/usb/usb3-debug-port.rst   |   52 +
 .../driver-api/usb/writing_usb_driver.rst          |    2 +-
 Documentation/fault-injection/fault-injection.txt  |    2 +-
 Documentation/filesystems/ext2.txt                 |    2 -
 Documentation/filesystems/ext4.txt                 |    7 +-
 Documentation/filesystems/vfat.txt                 |    2 +-
 Documentation/i2c/dev-interface                    |   17 +-
 Documentation/index.rst                            |   13 +
 Documentation/kbuild/kconfig-language.txt          |   21 +
 Documentation/kernel-doc-nano-HOWTO.txt            |  322 -----
 Documentation/kernel-hacking/hacking.rst           |    6 +-
 Documentation/maintainer/conf.py                   |   10 +
 Documentation/maintainer/configure-git.rst         |   34 +
 Documentation/maintainer/index.rst                 |   14 +
 Documentation/maintainer/pull-requests.rst         |  178 +++
 Documentation/networking/index.rst                 |    1 +
 .../process/kernel-enforcement-statement.rst       |    3 +
 Documentation/process/license-rules.rst            |  370 +++++
 Documentation/process/submit-checklist.rst         |    4 +-
 Documentation/security/credentials.rst             |    7 +
 Documentation/security/self-protection.rst         |   15 +
 Documentation/sphinx/kfigure.py                    |    6 +-
 Documentation/sysctl/kernel.txt                    |   17 +-
 Documentation/trace/ftrace-uses.rst                |   60 +-
 Documentation/usb/chipidea.txt                     |   12 +-
 Documentation/vm/hwpoison.txt                      |    2 +-
 Documentation/w1/w1.generic                        |    2 +-
 LICENSES/exceptions/Linux-syscall-note             |   25 +
 LICENSES/other/GPL-1.0                             |  260 ++++
 LICENSES/other/MPL-1.1                             |  478 +++++++
 LICENSES/preferred/BSD-2-Clause                    |   32 +
 LICENSES/preferred/BSD-3-Clause                    |   36 +
 LICENSES/preferred/BSD-3-Clause-Clear              |   41 +
 LICENSES/preferred/GPL-2.0                         |  353 +++++
 LICENSES/preferred/LGPL-2.0                        |  487 +++++++
 LICENSES/preferred/LGPL-2.1                        |  503 +++++++
 LICENSES/preferred/MIT                             |   30 +
 drivers/w1/w1_netlink.h                            |    6 +-
 fs/9p/Kconfig                                      |    3 -
 fs/Kconfig                                         |    6 +-
 fs/btrfs/Kconfig                                   |    3 -
 fs/ceph/Kconfig                                    |    3 -
 fs/cifs/Kconfig                                    |   15 +-
 fs/ext2/Kconfig                                    |    6 +-
 fs/ext4/Kconfig                                    |    3 -
 fs/f2fs/Kconfig                                    |    6 +-
 fs/hfsplus/Kconfig                                 |    3 -
 fs/jffs2/Kconfig                                   |    6 +-
 fs/jfs/Kconfig                                     |    3 -
 fs/reiserfs/Kconfig                                |    6 +-
 fs/xfs/Kconfig                                     |    3 -
 include/linux/errseq.h                             |    2 +-
 include/linux/refcount.h                           |    2 +-
 lib/errseq.c                                       |   37 +-
 lib/uuid.c                                         |   34 +-
 lib/vsprintf.c                                     |    5 +-
 scripts/kernel-doc                                 | 1506 +++-----------------
 68 files changed, 3888 insertions(+), 2006 deletions(-)
 rename Documentation/{ => core-api}/errseq.rst (92%)
 rename Documentation/{printk-formats.txt => core-api/printk-formats.rst} (64%)
 create mode 100644 Documentation/core-api/refcount-vs-atomic.rst
 delete mode 100644 Documentation/kernel-doc-nano-HOWTO.txt
 create mode 100644 Documentation/maintainer/conf.py
 create mode 100644 Documentation/maintainer/configure-git.rst
 create mode 100644 Documentation/maintainer/index.rst
 create mode 100644 Documentation/maintainer/pull-requests.rst
 create mode 100644 Documentation/process/license-rules.rst
 create mode 100644 LICENSES/exceptions/Linux-syscall-note
 create mode 100644 LICENSES/other/GPL-1.0
 create mode 100644 LICENSES/other/MPL-1.1
 create mode 100644 LICENSES/preferred/BSD-2-Clause
 create mode 100644 LICENSES/preferred/BSD-3-Clause
 create mode 100644 LICENSES/preferred/BSD-3-Clause-Clear
 create mode 100644 LICENSES/preferred/GPL-2.0
 create mode 100644 LICENSES/preferred/LGPL-2.0
 create mode 100644 LICENSES/preferred/LGPL-2.1
 create mode 100644 LICENSES/preferred/MIT