- 20 Mar, 2020 9 commits
-
-
Lukas Bulwahn authored
Mauro's patch series <cover.1581955849.git.mchehab+huawei@kernel.org> ("[PATCH 00/44] Manually convert filesystem FS documents to ReST") converts many Documentation/filesystems/ files to ReST. Since then, ./scripts/get_maintainer.pl --self-test complains with 27 warnings on Documentation/filesystems/ of this kind: warning: no file matches F: Documentation/filesystems/... Adjust MAINTAINERS entries to all files converted from .txt to .rst in the patch series and address the 27 warnings. Link: https://lore.kernel.org/linux-erofs/cover.1581955849.git.mchehab+huawei@kernel.orgSigned-off-by:Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20200314175030.10436-1-lukas.bulwahn@gmail.comSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Kees Cook authored
Linus continues to remind[1] people to stop using the BUG()-family of functions. We should have this better documented (even if checkpatch.pl has been warning[2] since 2015), so add more details to deprecated.rst, as a distinct place to point people to for guidance. [1] https://lore.kernel.org/lkml/CAHk-=whDHsbK3HTOpTF=ue_o04onRwTEaK_ZoJp_fjbqq4+=Jw@mail.gmail.com/ [2] https://git.kernel.org/linus/9d3e3c705eb395528fd8f17208c87581b134da48Signed-off-by:
Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/202003141524.59C619B51A@keescookSigned-off-by:
-
Wang Wenhu authored
Translate virtiofs.rst in Documentation/filesystems/ into Chinese. Reviewed-by:
Alex Shi <alex.shi@linux.alibaba.com> Reviewed-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Acked-by:
Stefan Hajnoczi <stefanha@redhat.com> Signed-off-by:
Wang Wenhu <wenhu.wang@vivo.com> Link: https://lore.kernel.org/r/20200316110143.97848-2-wenhu.wang@vivo.comSigned-off-by:
-
Wang Wenhu authored
Add filesystems subdirectory into the table of Contents for zh_CN, all translations residing on it would be indexed conveniently. Reviewed-by:
-
Stephen Boyd authored
The kernel doc tooling knows how to do this itself so drop this markup throughout this file to simplify. Suggested-by:
Stephen Boyd <swboyd@chromium.org> Link: https://lore.kernel.org/r/20200318174133.160206-3-swboyd@chromium.orgSigned-off-by:
-
Stephen Boyd authored
Add the missing word to make this sentence read properly. Signed-off-by:
-
Jonathan Corbet authored
Mauro says (as he's cleaning up my mess): This small series address a regression caused by a new patch at docs-next (and at linux-next). Before this patch, when a cross-reference to a chapter within the documentation is needed, we had to add a markup like: .. _foo: foo === This behavor is now different after this patch: 58ad30cf ("docs: fix reference to core-api/namespaces.rst") As a Sphinx extension now creates automatically a reference like the above, without requiring any extra markup. That, however, comes with a price: it is not possible anymore to have two sections with the same name within the entire Kernel docs! This causes thousands of warnings, as we have sections named "introduction" on lots of places. This series solve this regression by doing two changes: 1) The references are now prefixed by the document name. So, a file named "bar" would have the "foo" reference as "bar:foo". 2) It will only use the first two levels. The first one is (usually) the name of the document, and the second one the chapter name. This solves almost all problems we have. Still, there are a few places where we have two chapters at the same document with the same name. The first patch addresses this problem. The second patch limits the escope of the autosectionlabel.
-
Mauro Carvalho Chehab authored
The autosectionlabel extension is nice, as it allows to refer to a section by its name without requiring any extra tag to create a reference name. However, on its default, it has two serious problems: 1) the namespace is global. So, two files with different "introduction" section would create a label with the same name. This is easily solvable by forcing the extension to prepend the file name with: autosectionlabel_prefix_document = True 2) It doesn't work hierarchically. So, if there are two level 1 sessions (let's say, one labeled "open" and another one "ioctl") and both have a level 2 "synopsis" label, both section 2 will have the same identical name. Currently, there's no way to tell Sphinx to create an hierarchical reference like: open / synopsis ioctl / synopsis This causes around 800 warnings. So, the fix should be to not let autosectionlabel to produce references for anything that it is not at a chapter level within any doc, with: autosectionlabel_maxdepth = 2 Fixes: 58ad30cf ("docs: fix reference to core-api/namespaces.rst") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 58ad30cf ("docs: fix reference to core-api/namespaces.rst") enabled a new feature at Sphinx: it will now generate index for each document title, plus to each chapter inside it. There's a drawback, though: one document cannot have two sections with the same name anymore. A followup patch will change the logic of autosectionlabel to avoid most creating references for every single section title, but still we need to be able to reference the chapters inside a document. There are a few places where there are two chapters with the same name. This patch renames one of the chapters, in order to avoid symbol conflict within the same document. PS.: as I don't speach Chinese, I had some help from a friend (Wen Liu) at the Chinese translation for "publishing patches" for this document: Documentation/translations/zh_CN/process/5.Posting.rst Fixes: 58ad30cf ("docs: fix reference to core-api/namespaces.rst") Signed-off-by:
-
- 19 Mar, 2020 1 commit
-
-
Jonathan Corbet authored
Fix a couple of dangling links to core-api/namespaces.rst by turning them into proper references. Enable the autosection extension (available since Sphinx 1.4) to make this work. Co-developed-by:
Federico Vaga <federico.vaga@vaga.pv.it> Fixes: fcfacb9f ("doc: move namespaces.rst from kbuild/ to core-api/") Signed-off-by:
-
- 11 Mar, 2020 1 commit
-
-
Mauro Carvalho Chehab authored
Those files got moved, but cross-references still point to the wrong places. Fixes: fcd68072 ("Documentation: Add io-mapping.rst to driver-api manual") Fixes: d1ce3500 ("Documentation: Add io_ordering.rst to driver-api manual") Signed-off-by:
Andy Shevchenko <andriy.shevchenko@linux.intel.com> Link: https://lore.kernel.org/r/c0205119db4fef536272cb0a183b6c14c2c8bf4c.1583927470.git.mchehab+huawei@kernel.orgSigned-off-by:
-
- 10 Mar, 2020 21 commits
-
-
Guilherme G. Piccoli authored
Commit 9c44bc03 ("softlockup: allow panic on lockup") added the softlockup_panic sysctl, but didn't add information about it to the file Documentation/admin-guide/sysctl/kernel.rst (which in that time certainly wasn't rst and had other name!). This patch just adds the respective documentation and references it from the corresponding entry in Documentation/admin-guide/kernel-parameters.txt. This patch was strongly based on Scott Wood's commit d22881dc ("Documentation: Better document the hardlockup_panic sysctl"). Reviewed-by:
Guilherme G. Piccoli <gpiccoli@canonical.com> Link: https://lore.kernel.org/r/20200310183649.23163-1-gpiccoli@canonical.comSigned-off-by:
-
Mauro Carvalho Chehab authored
The virt_mechanism reference there points to a section called elsewhere (Virtualization mitigation). Also, it is not used anywere. Besides that, it conflicts with a label with the same name inside: Documentation/admin-guide/hw-vuln/mds.rst Perhaps added due to some cut-and-paste? Anyway, as this is not used, let's just get rid of it. Signed-off-by:
-
Mauro Carvalho Chehab authored
Documentation/admin-guide/perf/imx-ddr.rst:47: WARNING: Unexpected indentation. Signed-off-by: -
Mauro Carvalho Chehab authored
Get rid of this warning: Documentation/filesystems/fuse.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. Fixes: 8ab13bca ("Documentation: filesystems: convert fuse to RST") Signed-off-by: -
Mauro Carvalho Chehab authored
As the translations document is part of the main body, we can't keep duplicated references there. So, prefix the Italian ones with "it-". Signed-off-by:
-
Mauro Carvalho Chehab authored
Get rid of those, by marking a literal block as such: Documentation/driver-api/gpio/driver.rst:425: WARNING: Unexpected indentation. Documentation/driver-api/gpio/driver.rst:423: WARNING: Inline emphasis start-string without end-string. Signed-off-by:
-
Mauro Carvalho Chehab authored
Some new chapters were added to the documentation. This caused Sphinx to complain, as the literal blocks there are not properly tagged as such. Also, a new note added there doesn't follow the ReST format. This fixes the following warnings: Documentation/trace/events.rst:589: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/trace/events.rst:620: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:623: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:626: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:703: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:697: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:722: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:775: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/trace/events.rst:814: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:817: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:820: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:823: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:826: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:829: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:832: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:844: WARNING: Unexpected indentation. Documentation/trace/events.rst:845: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/trace/events.rst:849: WARNING: Unexpected indentation. Documentation/trace/events.rst:850: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/trace/events.rst:883: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:886: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:889: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:895: WARNING: Bullet list ends without a blank line; unexpected unindent. Documentation/trace/events.rst:895: WARNING: Inline emphasis start-string without end-string. Documentation/trace/events.rst:968: WARNING: Inline emphasis start-string without end-string. Fixes: 34ed6357 ("tracing: Documentation for in-kernel synthetic event API") Signed-off-by:Tom Zanussi <zanussi@kernel.org> Acked-by:
Steven Rostedt (VMware) <rostedt@goodmis.org> Link: https://lore.kernel.org/r/afbe367ccb7b9abcb9fab7bc5cb5e0686c105a53.1583250595.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Pragat Pandya authored
Add io_ordering.rst under Documentation/driver-api and reference it from the Sphinx TOC Tree present in Documentation/driver-api/index.rst Signed-off-by:
Pragat Pandya <pragat.pandya@gmail.com> Link: https://lore.kernel.org/r/20200303050301.5412-3-pragat.pandya@gmail.comSigned-off-by:
-
Pragat Pandya authored
Add io-mapping.rst under Documentation/driver-api and reference it from Sphinx TOC Tree present in Documentation/driver-api/index.rst Signed-off-by:
-
Jonathan Neuschäfer authored
Commit 7f2b3c65 ("Documentation/ManagementStyle: convert it to ReST markup") converted _underlined_ to *emphasized* words, but forgot about an underscore in this case. Signed-off-by:
Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20200303192113.20761-1-j.neuschaefer@gmx.netSigned-off-by:
-
Jonathan Neuschäfer authored
* Don't list powerpc twice (once as ppc) * Drop tile, which has been removed from the source tree * Mention arm64, nds32, arc, and xtensa Signed-off-by:
-
Lukas Bulwahn authored
Commit 5fed00dc ("Documentation: kobject.txt has been moved to core-api/kobject.rst") missed to adjust the entry in MAINTAINERS. Since then, ./scripts/get_maintainer.pl --self-test complains: warning: no file matches F: Documentation/kobject.txt Adjust DRIVER CORE, KOBJECTS, DEBUGFS AND SYSFS entry in MAINTAINERS. Signed-off-by:
-
Jonathan Corbet authored
Documentation/process/deprecated.rst has a lot of uses of :c:func:, which is, well, deprecated. Emacs query-replace-regexp to the rescue. Signed-off-by: -
Kees Cook authored
Add example of fall-through, list-ify the case ending statements, and adjust the markup for links and readability. While here, adjust strscpy() details to mention strscpy_pad(). Signed-off-by:
Gustavo A. R. Silva <gustavo@embeddedor.com> Link: https://lore.kernel.org/r/202003041102.47A4E4B62@keescookSigned-off-by:
-
Jonathan Corbet authored
The ioctl() documentation belongs with the rest of the driver-oriented info, so move it there. Signed-off-by: -
Jonathan Corbet authored
Information about GCC plugins is relevant to kernel building, so move this document to the kbuild manual. Acked-by:
Masahiro Yamada <masahiroy@kernel.org> Signed-off-by:
-
Jonathan Corbet authored
The core-api manual has become a big, disorganized mess. Try to bring a small amount of order to it by organizing the documents into subcategories. Signed-off-by: -
Kees Cook authored
Once in a while %p usage comes up, and I've needed to have a reference to point people to. Add %p details to deprecated.rst. Signed-off-by:
-
Jonathan Neuschäfer authored
Signed-off-by:
-
Jonathan Neuschäfer authored
Trim the title a bit, since it's relatively long. Add `binfmt_misc` to make it easier to search for the feature by its common name. Signed-off-by:
-
Jonathan Neuschäfer authored
It doesn't need to be a top-level chapter. This patch also updates MAINTAINERS and makes sure the F: lines are properly sorted. Signed-off-by:
Andy Shevchenko <andy.shevchenko@gmail.com> Link: https://lore.kernel.org/r/20200308211519.8414-1-j.neuschaefer@gmx.netSigned-off-by:
-
- 02 Mar, 2020 8 commits
-
-
Jonathan Corbet authored
Mauro sez: There are lots of plain text documents under Documentation/filesystems. Manually convert several of those to ReST and add them to the index file. Signed-off-by: -
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add it to filesystems/index.rst. Signed-off-by:
Damien Le Moal <damien.lemoal@wdc.com> Link: https://lore.kernel.org/r/42a7cfcd19f6b904a9a3188fd4af71bed5050052.1581955849.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Add table markups; - Add lists markups; - Add it to filesystems/index.rst. Signed-off-by:
Jan Kara <jack@suse.cz> Link: https://lore.kernel.org/r/2887f8a3a813a31170389eab687e9f199327dc7d.1581955849.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Adjust section titles; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add table markups; - Add lists markups; - Add it to filesystems/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Mark some literals as such; - Add it to filesystems/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add table markups; - Use :field: markup; - Add it to filesystems/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add table markups; - Add it to filesystems/index.rst. Signed-off-by:
-
Mauro Carvalho Chehab authored
- Add a SPDX header; - Add a document title; - Adjust document and section titles; - use :field: markup; - Some whitespace fixes and new line breaks; - Mark literal blocks as such; - Add it to filesystems/index.rst. Signed-off-by:
-
