| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <20161003152952.2ac0ce65@lwn.net>
Date: Mon, 3 Oct 2016 15:29:52 -0600
From: Jonathan Corbet <corbet@....net>
To: Linus Torvalds <torvalds@...ux-foundation.org>
Cc: LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org
Subject: [PULL] Documentation for 4.9
[Note you'll get a small conflict with
Documentation/sphinx-static/theme_overrides.css; just take the docs-4.9
side. That's entirely the result of me still figuring out the best
fix-vs-features workflow, shouldn't happen again.]
The following changes since commit
29b4817d4018df78086157ea3a55c1d9424a7cfc:
Linux 4.8-rc1 (2016-08-07 18:18:00 -0700)
are available in the git repository at:
git://git.lwn.net/linux.git tags/docs-4.9
for you to fetch changes up to 3c76ff4765fbd382c095acc37f87e136a8dfc73d:
URL changed for Linux Foundation TAB (2016-10-01 00:57:13 -0600)
----------------------------------------------------------------
This is the documentation update pull for the 4.9 merge window.
The Sphinx transition is still creating a fair amount of work. Here we
have a number of fixes and, importantly, a proper PDF output solution,
thanks to Jani Nikula, Mauro Carvalho Chehab and Markus Heiser.
I've started a couple of new books: a driver API book (based on the old
device-drivers.tmpl) and a development tools book. Both are meant to show
how we can integrate together our existing documentation into a more
coherent and accessible whole. It involves moving some stuff around and
formatting changes, but, I think, the results are worth it. The good news
is that most of our existing Documentation/*.txt files are *almost* in RST
format already; the amount of messing around required is minimal.
And, of course, there's the usual set of updates, typo fixes, and more.
----------------------------------------------------------------
Andi Shyti (1):
Documentation: clk: update file names containing referenced structures
Andrey Smirnov (1):
Documentation: DMA-API-HOWTO: Fix a typo
Baoquan He (1):
docs: kernel-parameter: Improve the description of nr_cpus and maxcpus
Christoph Hellwig (1):
DMA-API-HOWTO: <asm/generic/scatterlist.h> is no more
David A. Long (1):
Documentation: kprobes: Document jprobes stack copying limitations
Eugeniu Rosca (1):
kconfig-language: improve menuconfig usage description
Finn Thain (1):
documentation/scsi: Remove nodisconnect parameter
Icenowy Zheng (1):
Documentation: sunxi: Update Allwinner SoC documentation
Jani Nikula (3):
Documentation/sphinx: build the media intermediate rst files for all outputs
Documentation: switch to pdflatex for pdf generation
Documentation: exclude media documentation from pdf generation
Jean Delvare (1):
CodingStyle: Clarify and complete chapter 7
Joe Perches (1):
CodingStyle: Remove "Don't use C99-style comments"
Jon Bailey (1):
URL changed for Linux Foundation TAB
Jonathan Corbet (22):
Merge branch 'xelatex' into doc/4.9
docs: create a new dev-tools directory
docs: sphinxify coccinelle.txt and add it to dev-tools
docs: sphinxify sparse.txt and move to dev-tools
docs: sphinxify kcov.txt and move to dev-tools
docs: sphinixfy gcov.txt and move to dev-tools
docs: sphinxify kasan.txt and move to dev-tools
docs: sphinxify ubsan.txt and move it to dev-tools
docs: sphinxify kmemleak.txt and move it to dev-tools
docs: sphinxify kmemcheck.txt and move to dev-tools
docs: Sphinxify gdb-kernel-debugging.txt and move to dev-tools
Merge branch 'dev-tools' into doc/4.9
Docs: sphinxify device-drivers.tmpl
docs: split up the driver book
docs: make kernel-doc handle varargs properly
docs: Special-case function-pointer parameters in kernel-doc
docs: Pull the HSI documentation together
docs: split up serial-interfaces.rst
docs: Don't format internal MPT docs
Merge branch 'driver-api' into doc/4.9
docs: Clean up bare :: lines
docs: Remove space-before-label guidance from CodingStyle
Laura Abbott (2):
mm, kasan: Update kasan docs to indicate arm64 support
doc: ioctl: Add some clarifications to botching-up-ioctls
Laurent Navet (1):
docs/driver-model: fix typo
Lorenzo Stoakes (1):
x86: fix memory ranges in mm documentation
Markus Heiser (16):
doc-rst: generic way to build only sphinx sub-folders
doc-rst: add stand-alone conf.py to media folder
doc-rst: add media/conf_nitpick.py
doc-rst: add stand-alone conf.py to gpu folder
doc-rst: add docutils config file
doc-rst: add index to sub-folders
doc-rst: add boilerplate to customize c-domain
doc-rst:c-domain: ref-name of a function declaration
doc-rst: moved *duplicate* warnings to nitpicky mode
doc-rst: Revert "kernel-doc: fix handling of address_space tags"
doc-rst: migrate ioctl CEC_DQEVENT to c-domain
docs: sphinx-extensions: add metadata parallel-safe
doc-rst: generic way to build PDF of sub-folders
doc-rst: define PDF's of the media folder
doc-rst:c-domain: fix sphinx version incompatibility
doc-rst:c-domain: function-like macros arguments
Mauro Carvalho Chehab (55):
docs-rst: fix a breakage when building PDF documents
docs-rst: remove a rst2pdf left over code
docs-rst: allow generating some LaTeX pages in landscape
docs-rst: improve output for .. notes:: on LaTeX
docs-rst: Don't mangle with UTF-8 chars on LaTeX/PDF output
docs-rst: better adjust margins and font size
docs-rst: parse-heraders.pl: escape LaTeX characters
docs-rst: Don't go to interactive mode on errors
docs-rst: enable the Sphinx math extension
docs-rst: add support for LaTeX output
docs-rst: conf.py: adjust the size of .. note:: tag
docs-rst: Use better colors for note/warning/attention boxes
docs-rst: Fix an warning when in interactive mode
docs-rst: add package adjustbox
docs-rst: kernel-doc: better output struct members
docs-rst: improve typedef parser
docs-rst: kernel-doc: fix typedef output in RST format
doc-rst: add CSS styles for :kbd: and :menuselection:
doc: development-process: convert it to ReST markup
doc: development-process: rename files to rst
docs-rst: create a book for the development process
Documentation/HOWTO: convert to ReST notation
Documentation/applying-patches.txt: convert it to ReST markup
Documentation/applying-patches.txt: Update the information there
Documentation/Changes: convert it to ReST markup
Documentation/Changes: add minimal requirements for documentation build
Documentation/CodingStyle: Convert to ReST markup
Documentation/CodingStyle: use the proper tag for verbatim font
Documentation/CodingStyle: replace underline markups
Documentation/CodingStyle: use the .. note:: markup where needed
Documentation/ManagementStyle: convert it to ReST markup
Documentation/SecurityBugs: convert it to ReST markup
Documentation/stable_api_nonsense.txt: convert it to ReST markup
Documentation/stable_kernel_rules.txt: convert it to ReST markup
Documentation/SubmittingDrivers: convert it to ReST markup
Documentation/SubmittingPatches: convert it to ReST markup
Documentation/SubmittingPatches: enrich the Sphinx output
Documentation/kernel-docs.txt: convert it to ReST markup
Documentation/HOWTO: add cross-references to other documents
Documentation/HOWTO: update information about generating documentation
Documentation/HOWTO: improve some markups to make it visually better
Documentation/HOWTO: adjust external link references
Documentation/SubmitChecklist: update kernel-doc task
Documentation/SubmitChecklist: convert it to ReST markup
Documentation/kernel-docs.txt: some improvements on the ReST output
Documentation/kernel-docs.txt: adjust LDD references
Documentation/kernel-docs.txt: sort books per publication date
Documentation/kernel-docs.txt: add two published books
Documentation/kernel-docs.txt: remove more legacy references
Documentation/kernel-docs.txt: move in-kernel docs
Documentation/kernel-docs.txt: get rid of broken docs
Documentation/kernel-docs.txt: Add dates for online docs
Documentation/kernel-docs.txt: reorder based on timestamp
Documentation/email-clients.txt: convert it to ReST markup
docs-rst: add inter-document cross references
Ricardo Ribalda Delgado (1):
Documentation: rs485: Do not define manually the ioctl
Richard Sailer (4):
Documentation/kernel-docs.txt: Remove offline or outdated entries
Documentation/kernel-docs.txt: Improve layouting of book list
Documentation/kernel-docs.txt: Add 4 paper/book references
Documentation/kernel-docs.txt: Consistent indenting: 4 spaces
Robert Foss (1):
Documentation/filesystems: Fixed typo
Sandhya Bankar (1):
iio: Documentation: Correct the path used to create triggers.
Stephen Bates (1):
dax : Fix documentation with respect to struct pages
Zhou Wenjian (2):
Documentation: kdump: Remind user of nr_cpus
Documentation: kdump: Add description of enable multi-cpus support
baolex.ni (1):
Update the maximum depth of C-state from 6 to 9
Øyvind A. Holm (1):
README: Delete obsolete i386 info + update arch/i386/ paths
Documentation/Changes | 264 ++--
Documentation/CodeOfConflict | 2 +-
Documentation/CodingStyle | 404 ++++--
Documentation/DMA-API-HOWTO.txt | 8 +-
Documentation/DocBook/Makefile | 10 +-
Documentation/DocBook/device-drivers.tmpl | 521 --------
Documentation/HOWTO | 148 ++-
Documentation/Makefile.sphinx | 64 +-
Documentation/ManagementStyle | 154 ++-
Documentation/SecurityBugs | 8 +
Documentation/SubmitChecklist | 127 +-
Documentation/SubmittingDrivers | 54 +-
Documentation/SubmittingPatches | 312 ++---
Documentation/applying-patches.txt | 431 +++---
Documentation/arm/sunxi/README | 11 +-
Documentation/clk.txt | 42 +-
Documentation/conf.py | 104 +-
.../{coccinelle.txt => dev-tools/coccinelle.rst} | 359 ++---
Documentation/dev-tools/gcov.rst | 256 ++++
.../gdb-kernel-debugging.rst} | 77 +-
Documentation/dev-tools/kasan.rst | 173 +++
Documentation/{kcov.txt => dev-tools/kcov.rst} | 84 +-
Documentation/dev-tools/kmemcheck.rst | 733 +++++++++++
.../{kmemleak.txt => dev-tools/kmemleak.rst} | 93 +-
Documentation/{sparse.txt => dev-tools/sparse.rst} | 39 +-
Documentation/dev-tools/tools.rst | 25 +
Documentation/{ubsan.txt => dev-tools/ubsan.rst} | 42 +-
.../development-process/{1.Intro => 1.Intro.rst} | 68 +-
.../{2.Process => 2.Process.rst} | 41 +-
.../{3.Early-stage => 3.Early-stage.rst} | 22 +-
.../development-process/{4.Coding => 4.Coding.rst} | 46 +-
.../{5.Posting => 5.Posting.rst} | 26 +-
.../{6.Followthrough => 6.Followthrough.rst} | 14 +-
.../{7.AdvancedTopics => 7.AdvancedTopics.rst} | 13 +-
.../{8.Conclusion => 8.Conclusion.rst} | 8 +-
Documentation/development-process/conf.py | 10 +
.../development-process/development-process.rst | 29 +
Documentation/development-process/index.rst | 9 +
Documentation/docutils.conf | 7 +
Documentation/driver-api/basics.rst | 120 ++
Documentation/driver-api/frame-buffer.rst | 62 +
Documentation/driver-api/hsi.rst | 88 ++
Documentation/driver-api/i2c.rst | 46 +
Documentation/driver-api/index.rst | 26 +
Documentation/driver-api/infrastructure.rst | 169 +++
Documentation/driver-api/input.rst | 51 +
Documentation/driver-api/message-based.rst | 12 +
Documentation/driver-api/miscellaneous.rst | 50 +
Documentation/driver-api/sound.rst | 54 +
Documentation/driver-api/spi.rst | 53 +
Documentation/driver-model/device.txt | 2 +-
Documentation/email-clients.txt | 214 +--
Documentation/filesystems/dax.txt | 15 +-
Documentation/filesystems/proc.txt | 2 +-
Documentation/gcov.txt | 257 ----
Documentation/gpu/conf.py | 5 +
Documentation/gpu/index.rst | 7 +
Documentation/hsi.txt | 75 --
Documentation/iio/iio_configfs.txt | 4 +-
Documentation/index.rst | 11 +-
Documentation/ioctl/botching-up-ioctls.txt | 13 +-
Documentation/kasan.txt | 171 ---
Documentation/kbuild/kconfig-language.txt | 39 +-
Documentation/kdump/kdump.txt | 9 +
Documentation/kernel-docs.txt | 1375 +++++++++-----------
Documentation/kernel-documentation.rst | 31 +
Documentation/kernel-parameters.txt | 24 +-
Documentation/kmemcheck.txt | 754 -----------
Documentation/kprobes.txt | 10 +
Documentation/media/Makefile | 3 +-
Documentation/media/conf.py | 10 +
Documentation/media/conf_nitpick.py | 93 ++
Documentation/media/index.rst | 19 +
Documentation/media/uapi/cec/cec-func-open.rst | 2 +-
Documentation/media/uapi/cec/cec-ioc-dqevent.rst | 5 +-
Documentation/scsi/scsi-parameters.txt | 2 -
Documentation/serial/serial-rs485.txt | 5 +-
Documentation/sphinx-static/theme_overrides.css | 15 +-
Documentation/sphinx/cdomain.py | 165 +++
Documentation/sphinx/kernel-doc.py | 8 +
Documentation/sphinx/kernel_include.py | 7 +
Documentation/sphinx/load_config.py | 32 +
Documentation/sphinx/parse-headers.pl | 2 +-
Documentation/sphinx/rstFlatTable.py | 6 +
Documentation/stable_api_nonsense.txt | 37 +-
Documentation/stable_kernel_rules.txt | 110 +-
Documentation/x86/x86_64/mm.txt | 6 +-
MAINTAINERS | 12 +-
Makefile | 2 +-
README | 8 +-
scripts/kernel-doc | 48 +-
91 files changed, 5207 insertions(+), 3977 deletions(-)
delete mode 100644 Documentation/DocBook/device-drivers.tmpl
rename Documentation/{coccinelle.txt => dev-tools/coccinelle.rst} (56%)
create mode 100644 Documentation/dev-tools/gcov.rst
rename Documentation/{gdb-kernel-debugging.txt => dev-tools/gdb-kernel-debugging.rst} (73%)
create mode 100644 Documentation/dev-tools/kasan.rst
rename Documentation/{kcov.txt => dev-tools/kcov.rst} (78%)
create mode 100644 Documentation/dev-tools/kmemcheck.rst
rename Documentation/{kmemleak.txt => dev-tools/kmemleak.rst} (73%)
rename Documentation/{sparse.txt => dev-tools/sparse.rst} (82%)
create mode 100644 Documentation/dev-tools/tools.rst
rename Documentation/{ubsan.txt => dev-tools/ubsan.rst} (78%)
rename Documentation/development-process/{1.Intro => 1.Intro.rst} (87%)
rename Documentation/development-process/{2.Process => 2.Process.rst} (96%)
rename Documentation/development-process/{3.Early-stage => 3.Early-stage.rst} (97%)
rename Documentation/development-process/{4.Coding => 4.Coding.rst} (97%)
rename Documentation/development-process/{5.Posting => 5.Posting.rst} (98%)
rename Documentation/development-process/{6.Followthrough => 6.Followthrough.rst} (98%)
rename Documentation/development-process/{7.AdvancedTopics => 7.AdvancedTopics.rst} (98%)
rename Documentation/development-process/{8.Conclusion => 8.Conclusion.rst} (96%)
create mode 100644 Documentation/development-process/conf.py
create mode 100644 Documentation/development-process/development-process.rst
create mode 100644 Documentation/development-process/index.rst
create mode 100644 Documentation/docutils.conf
create mode 100644 Documentation/driver-api/basics.rst
create mode 100644 Documentation/driver-api/frame-buffer.rst
create mode 100644 Documentation/driver-api/hsi.rst
create mode 100644 Documentation/driver-api/i2c.rst
create mode 100644 Documentation/driver-api/index.rst
create mode 100644 Documentation/driver-api/infrastructure.rst
create mode 100644 Documentation/driver-api/input.rst
create mode 100644 Documentation/driver-api/message-based.rst
create mode 100644 Documentation/driver-api/miscellaneous.rst
create mode 100644 Documentation/driver-api/sound.rst
create mode 100644 Documentation/driver-api/spi.rst
delete mode 100644 Documentation/gcov.txt
create mode 100644 Documentation/gpu/conf.py
delete mode 100644 Documentation/hsi.txt
delete mode 100644 Documentation/kasan.txt
delete mode 100644 Documentation/kmemcheck.txt
create mode 100644 Documentation/media/conf.py
create mode 100644 Documentation/media/conf_nitpick.py
create mode 100644 Documentation/media/index.rst
create mode 100644 Documentation/sphinx/cdomain.py
create mode 100644 Documentation/sphinx/load_config.py
mode change 100644 => 100755 Documentation/sphinx/rstFlatTable.py
Powered by blists - more mailing lists