lwn.git/Documentation, branch docs-4.16

linux-next: docs-rst: Fix typos in kfigure.py

2018-01-17T23:49:05+00:00

This patch fixes some spelling typos found in kfigure.py Signed-off-by: Masanari Iida Signed-off-by: Jonathan Corbet

linux-next: DOC: HWPOISON: Fix path to debugfs in hwpoison.txt

2018-01-17T23:48:29+00:00

This patch fixes an incorrect path for debugfs in hwpoison.txt Signed-off-by: Masanari Iida Signed-off-by: Jonathan Corbet

Documentation: Fix misconversion of #if

2018-01-17T23:45:01+00:00

At some stage of the conversion pipeline, something thought that the DocBook entity # should be rendered as NUM instead of #. Signed-off-by: Matthew Wilcox Signed-off-by: Jonathan Corbet

docs: add index entry for networking/msg_zerocopy

2018-01-08T21:20:57+00:00

Currently msg_zerocopy is not included in any toctree. Sphinx emits a build warning to this effect. The other three rst files in Documentation/networking are all indexed. We can add msg_zerocopy to the toctree to enable navigation of the document via HTML kernel docs. Add msg_zerocopy to the networking/ toctree. Signed-off-by: Tobin C. Harding Signed-off-by: Jonathan Corbet

Documentation: security/credentials.rst: explain need to sort group_list

2018-01-08T21:20:31+00:00

This patch updates the documentation with the observations that led to commit bdcf0a423ea1 ("kernel: make groups_sort calling a responsibility group_info allocators") and the new behaviour required. Specifically that groups_sort() should be called on a new group_list before set_groups() or set_current_groups() is called. Signed-off-by: NeilBrown [jc: use proper :c:func: references] Signed-off-by: Jonathan Corbet

Documentation: Add license-rules.rst to describe how to properly identify file licenses

2018-01-06T17:58:02+00:00

Add a file to the Documentation directory to describe how file licenses should be described in all kernel files, using the SPDX identifier, as well as where all licenses should be in the kernel source tree for people to refer to (LICENSES/). Thanks to Kate and Greg for review and editing and Jonas for the suggestions concerning the meta tags in the licenses files. Signed-off-by: Thomas Gleixner Reviewed-by: Jonas Oberg Reviewed-by: Jonathan Corbet Reviewed-by: Philippe Ombredanne Reviewed-by: Kate Stewart Reviewed-by: Greg Kroah-Hartman Signed-off-by: Jonathan Corbet

fs/*/Kconfig: drop links to 404-compliant http://acl.bestbits.at

2018-01-01T19:45:37+00:00

This link is replicated in most filesystems' config stanzas. Referring to an archived version of that site is pointless as it mostly deals with patches; user documentation is available elsewhere. Signed-off-by: Adam Borowski CC: Alexander Viro Reviewed-by: Darrick J. Wong Acked-by: Jan Kara Acked-by: Dave Kleikamp Acked-by: David Sterba Acked-by: "Yan, Zheng" Acked-by: Chao Yu Acked-by: Jaegeuk Kim Acked-by: Steve French Signed-off-by: Jonathan Corbet

doc: md: Fix a file name to md-fault.c in fault-injection.txt

2018-01-01T19:43:09+00:00

drivers/md/faulty.c has been renamed to md-faulty.c after following commit merged int to the main line. 935fe0983e09f4f7331ebf5ea4ae2124f6e9f9e8 . But the file name in fault-injection.txt has not been changed. Now the actual file name and document are in sync. Signed-off-by: Masanari Iida Signed-off-by: Jonathan Corbet

errseq: Add to documentation tree

2018-01-01T19:40:27+00:00

- Move errseq.rst into core-api - Add errseq to the core-api index - Promote the header to a more prominent header type, otherwise we get three entries in the table of contents. - Reformat the table to look nicer and be a little more proportional in terms of horizontal width per bit (the SF bit is still disproportionately large, but there's no way to fix that). - Include errseq kernel-doc in the errseq.rst - Neaten some kernel-doc markup Signed-off-by: Matthew Wilcox Reviewed-by: Jeff Layton Reviewed-by: Randy Dunlap Signed-off-by: Jonathan Corbet

scripts: kernel-doc: parse next structs/unions

2017-12-21T20:41:46+00:00

There are several places within the Kernel tree with nested structs/unions, like this one: struct ingenic_cgu_clk_info { const char *name; enum { CGU_CLK_NONE = 0, CGU_CLK_EXT = BIT(0), CGU_CLK_PLL = BIT(1), CGU_CLK_GATE = BIT(2), CGU_CLK_MUX = BIT(3), CGU_CLK_MUX_GLITCHFREE = BIT(4), CGU_CLK_DIV = BIT(5), CGU_CLK_FIXDIV = BIT(6), CGU_CLK_CUSTOM = BIT(7), } type; int parents[4]; union { struct ingenic_cgu_pll_info pll; struct { struct ingenic_cgu_gate_info gate; struct ingenic_cgu_mux_info mux; struct ingenic_cgu_div_info div; struct ingenic_cgu_fixdiv_info fixdiv; }; struct ingenic_cgu_custom_info custom; }; }; Currently, such struct is documented as: **Definition** :: struct ingenic_cgu_clk_info { const char * name; }; **Members** ``name`` name of the clock With is obvioulsy wrong. It also generates an error: drivers/clk/ingenic/cgu.h:169: warning: No description found for parameter 'enum' However, there's nothing wrong with this kernel-doc markup: everything is documented there. It makes sense to document all fields there. So, add a way for the core to parse those structs. With this patch, all documented fields will properly generate documentation. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet