After a fair amount of churn in the last couple of cycles, docs are taking
it easier this time around. Lots of fixes and some new documentation, but
nothing all that radical. Perhaps the most interesting change for many is
the scripts/sphinx-pre-install tool from Mauro; it will tell you exactly
which packages you need to install to get a working docs toolchain on your
system.
There are two little patches reaching outside of Documentation/; both just
tweak kerneldoc comments to eliminate warnings and fix some dangling doc
pointers.
jon
The following changes since commit 5771a8c08880cdca3bfb4a3fc6d309d6bba20877:
Linux v4.13-rc1 (2017-07-15 15:22:10 -0700)
are available in the git repository at:
git://git.lwn.net/linux.git docs-next
for you to fetch changes up to 86c0f046a8b0c23fca65f77333c233a06c25ef9a:
Documentation/sphinx: fix kernel-doc decode for non-utf-8 locale (2017-08-31 13:36:28 -0600)
----------------------------------------------------------------
Alex Shi (2):
rtmutex: update rt-mutex-design
rtmutex: update rt-mutex
Alexander Kuleshov (1):
assoc_array: fix path to assoc_array documentation
Andrii Bordunov (1):
Documentation: stable-kernel-rules: fix broken git urls
Frank Rowand (1):
docs: submitting-patches - change non-ascii character to ascii
Geert Uytterhoeven (1):
Documentation: arm: Replace use of virt_to_phys with __pa_symbol
James Hogan (1):
docs/features: parisc implements tracehook
Jani Nikula (1):
Documentation/sphinx: fix kernel-doc decode for non-utf-8 locale
Jian-Hong Pan (1):
doc: linux-wpan: Change the old function names to the lastest function names
John de la Garza (1):
Documentation:input: fix typo
Jonathan Corbet (10):
docs: Get module_init() docs from module.h
docs: Do not include kerneldoc comments from kernel/sys.c
docs: Do not include from .../seqno-fence.c
docs: Get the struct cmbdata kernel doc from the right file
docs: Do not include from drivers/scsi/constants.c
Merge branch 'install' into docs-next
docs: Use :internal: for include/drm/drm_syncobj.h
Merge branch 'warning-fixes' into docs-next
doc: Add documentation for the genalloc subsystem
genalloc: Fix an incorrect kerneldoc comment
Josh Holland (2):
docs: Fix paths in security/keys
docs: ReSTify table of contents in core.rst
Markus Heiser (5):
docs RDT theme: fix bottom margin of lists items
docs RTD theme: code-block with line nos - lines and line numbers don't line up.
docs: fix nested numbering in the TOC
docs: fix minimal sphinx version in conf.py
kernel-doc parser mishandles declarations split into lines
Mauro Carvalho Chehab (20):
changes.rst: Update Sphinx minimal requirements
docs-rst: move Sphinx install instructions to sphinx.rst
sphinx.rst: explain the usage of virtual environment
sphinx.rst: fix unknown reference
sphinx.rst: describe the install requirements for kfigure
sphinx.rst: better organize the documentation about PDF build
docs: Makefile: remove no-ops targets
scripts/sphinx-pre-install: add a script to check Sphinx install
sphinx-pre-install: detect an existing virtualenv
sphinx-pre-install: use a requirements file
sphinx-pre-install: check for the need of graphviz-gd
sphinx-pre-install: add dependencies for ImageMagick to work with svg
sphinx-pre-install: fix USE needs for GraphViz and ImageMagick
sphinx.rst: document scripts/sphinx-pre-install script
sphinx-pre-install: add support for Mageia
scripts/sphinx-pre-install: add minimum support for RHEL
doc: Makefile: if sphinx is not found, run a check script
docs-rst: pdf: use same vertical margin on all Sphinx versions
docs-rst: fix verbatim font size on tables
sphinx.rst: Allow Sphinx version 1.6 at the docs
Naren (1):
NVMEM documentation fix: A minor typo
Nikolay Borisov (1):
swap: Remove obsolete sentence
Randy Dunlap (1):
docs: process: drop git snapshots from applying-patches.rst
Sedat Dilek (1):
kbuild: Update example for ccflags-y usage
Thierry Reding (1):
docs: driver-api: Remove trailing blank line
Zhouyi Zhou (2):
docs: disable KASLR when debugging kernel
docs: disable KASLR when debugging kernel
Documentation/Makefile | 12 +-
Documentation/arm/firmware.txt | 2 +-
Documentation/conf.py | 6 +-
Documentation/core-api/genalloc.rst | 144 +++++
Documentation/core-api/index.rst | 1 +
Documentation/dev-tools/gdb-kernel-debugging.rst | 6 +-
Documentation/dev-tools/kgdb.rst | 11 +-
Documentation/doc-guide/sphinx.rst | 107 +++-
Documentation/driver-api/basics.rst | 5 +-
Documentation/driver-api/dma-buf.rst | 3 -
Documentation/driver-api/miscellaneous.rst | 1 -
Documentation/driver-api/s390-drivers.rst | 2 +-
Documentation/driver-api/scsi.rst | 8 -
.../features/core/tracehook/arch-support.txt | 2 +-
Documentation/filesystems/vfs.txt | 4 +-
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/input/input.rst | 2 +-
Documentation/input/joydev/index.rst | 1 -
Documentation/kbuild/makefiles.txt | 6 +-
Documentation/locking/rt-mutex-design.txt | 432 ++++-----------
Documentation/locking/rt-mutex.txt | 58 +-
Documentation/media/uapi/cec/cec-funcs.rst | 1 -
Documentation/networking/ieee802154.txt | 16 +-
Documentation/nvmem/nvmem.txt | 2 +-
Documentation/process/applying-patches.rst | 43 +-
Documentation/process/changes.rst | 16 +-
Documentation/process/stable-kernel-rules.rst | 4 +-
Documentation/process/submitting-patches.rst | 2 +-
Documentation/security/keys/core.rst | 16 +-
Documentation/security/keys/request-key.rst | 2 +-
Documentation/security/keys/trusted-encrypted.rst | 2 +-
Documentation/sphinx-static/theme_overrides.css | 17 +
Documentation/sphinx/kerneldoc.py | 8 +-
Documentation/sphinx/requirements.txt | 3 +
Documentation/translations/zh_CN/HOWTO | 2 -
Makefile | 2 +-
include/linux/genalloc.h | 5 +-
lib/assoc_array.c | 2 +-
scripts/kernel-doc | 4 +
scripts/sphinx-pre-install | 609 +++++++++++++++++++++
40 files changed, 1073 insertions(+), 498 deletions(-)
create mode 100644 Documentation/core-api/genalloc.rst
create mode 100644 Documentation/sphinx/requirements.txt
create mode 100755 scripts/sphinx-pre-install
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
