- 27 Jan, 2020 1 commit
-
-
Geert Uytterhoeven authored
scripts/find-unused-docs.sh invokes scripts/kernel-doc to find out if a source file contains kerneldoc or not. However, as it passes the no longer supported "-text" option to scripts/kernel-doc, the latter prints out its help text, causing all files to be considered containing kerneldoc. Get rid of these false positives by removing the no longer supported "-text" option from the scripts/kernel-doc invocation. Cc: stable@vger.kernel.org # 4.16+ Fixes: b0514267 ("scripts: kernel-doc: get rid of unused output formats") Signed-off-by:
Geert Uytterhoeven <geert+renesas@glider.be> Link: https://lore.kernel.org/r/20200127093107.26401-1-geert+renesas@glider.beSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 24 Jan, 2020 6 commits
-
-
Lukas Bulwahn authored
The ACPI Device Specific Methods (_DSM) paragraph is intended to be a subsection of the Submit Checklist Addendum section. Dan Williams however used Markdown notation for this subsection, which does not parse as intended in a ReST documentation. Change the markup to ReST notation, as described in the Specific guidelines for the kernel documentation section in Documentation/doc-guide/sphinx.rst. Fixes: 47843401 ("libnvdimm, MAINTAINERS: Maintainer Entry Profile") Signed-off-by:
Lukas Bulwahn <lukas.bulwahn@gmail.com> Link: https://lore.kernel.org/r/20200118153620.8276-1-lukas.bulwahn@gmail.comSigned-off-by:
-
Yue Hu authored
sysfs node for huge page writeback is writeback rather than write. Signed-off-by:
Yue Hu <huyue2@yulong.com> Acked-by:
Minchan Kim <minchan@kernel.org> Link: https://lore.kernel.org/r/20200120102949.12132-1-zbestahu@gmail.comSigned-off-by:
-
Randy Dunlap authored
Fix various items in zram.rst: - typos/spellos - punctuation - grammar - shell syntax - indentation - sysfs file names Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Acked-by:
-
Jonathan Corbet authored
Documentation should lead by example, so here's a basic maintainer entry profile for this subsystem. Reviewed-by:
Matthew Wilcox (Oracle) <willy@infradead.org> Signed-off-by:
-
Jonathan Corbet authored
This is mostly a collection of thoughts for how people who want to help out can make the docs better. Hopefully the world will respond with a flurry of useful patches. Acked-by:
Jani Nikula <jani.nikula@intel.com> Reviewed-by:
-
Jonathan Corbet authored
Sphinx 2.1 moved sphinx.environment.NoUri into sphinx.errors; that produced this warning in the docs build: /usr/lib/python3.7/site-packages/sphinx/registry.py:473: RemovedInSphinx30Warning: sphinx.environment.NoUri is deprecated. Grab NoUri from the right place and make the warning go away. That symbol was only added to sphinx.errors in 2.1, so we must still import it from the old location when running in older versions. Signed-off-by:
-
- 16 Jan, 2020 11 commits
-
-
Will Deacon authored
The example given in asm-annotations.rst to describe the constraints that a function should meet in order to be annotated with a SYM_FUNC_* macro is x86-specific, and not necessarily applicable to architectures using branch-and-link style calling conventions such as arm64. Tweak the example text to call out the x86-specific text. Cc: Mark Brown <broonie@kernel.org> Cc: Jiri Slaby <jslaby@suse.com> Signed-off-by:
Will Deacon <will@kernel.org> Link: https://lore.kernel.org/r/20200115184305.1187-1-will@kernel.orgSigned-off-by:
-
Jonathan Corbet authored
Daniel W. S. Almeida writes: This series converts a few docs in Documentation/filesystems/nfs to RST. The docs were also moved into admin-guide because they contain information that might be useful for system administrators Most changes are related to aesthetics and presentation, i.e. the content itself remains mostly untouched. The use of markup was limited in order not to negatively impact the plain-text reading experience.
-
Daniel W. S. Almeida authored
Convert fault_injection.txt to ReST and move it to admin-guide. Signed-off-by:
Daniel W. S. Almeida <dwlsalmeida@gmail.com> Link: https://lore.kernel.org/r/f7b0cf8fb1159a668f75ce82a581e7590568c2b8.1578697871.git.dwlsalmeida@gmail.comSigned-off-by:
-
Daniel W. S. Almeida authored
Convert pnfs-scsi-server to ReST and move it to admin-guide. Content remains mostly unchanged. Signed-off-by:
-
Daniel W. S. Almeida authored
Convert pnfs-block-server.txt to ReST and move it to admin-guide. Content remains mostly unchanged. Signed-off-by:
-
Daniel W. S. Almeida authored
Convert idmapper.txt to ReST and move it to admin-guide. Content remains mostly unchanged otherwise. Signed-off-by:
-
Daniel W. S. Almeida authored
Convert nfsd-admin-interfaces to ReST and move it into admin-guide. Content remains mostly untouched. Signed-off-by:
-
Daniel W. S. Almeida authored
Convert nfs-rdma to ReST and move it to admin-guide. Content remais mostly untouched. Also, mark the doc as obsolete. Signed-off-by:
-
Daniel W. S. Almeida authored
Refill a paragraph to eliminate long lines. Signed-off-by:
-
Daniel W. S. Almeida authored
Convert nfsroot.txt to RST and move it to admin-guide. Content remains mostly the same. Signed-off-by:
-
Daniel W. S. Almeida authored
This patch converts nfs.txt to RST. It also moves it to admin-guide. The reason for moving it is because this document contains information useful for system administrators, as noted on the following paragraph: 'The purpose of this document is to provide information on some of the special features of the NFS client that can be configured by system administrators'. Signed-off-by:
-
- 10 Jan, 2020 7 commits
-
-
Daniel W. S. Almeida authored
Converts vfat.txt to the reStructuredText format, improving presentation without changing the underlying content. Signed-off-by:
-
Daniel W. S. Almeida authored
Fix WARNING: Inline emphasis start-string without end-string. This warning was due to wrong syntax being used. Signed-off-by:
-
Frank A. Cancio Bello authored
The use of iff ("if and only if") notation is not accurate in this case. Suggested-by:Steven Rostedt (VMware) <rostedt@goodmis.org> Signed-off-by:
Frank A. Cancio Bello <frank@generalsoftwareinc.com> Reviewed-by:
Joel Fernandes (Google) <joel@joelfernandes.org> Link: https://lore.kernel.org/r/22f9a98a972c3155c7b478247a087a5efafde774.1577231751.git.frank@generalsoftwareinc.comSigned-off-by:
-
Frank A. Cancio Bello authored
Fix minor typos in the doc. Suggested-by:
-
Frank A. Cancio Bello authored
The current text could mislead the user into believing that the number of pages allocated by each CPU ring buffer is calculated by the round up of the division: buffer_size_kb / PAGE_SIZE. Clarifies that a few extra pages may be allocated to accommodate buffer management meta-data. Suggested-by:
-
Guoqing Jiang authored
Replace fs with block since bio.c had been moved to block folder. Signed-off-by:
Guoqing Jiang <guoqing.jiang@cloud.ionos.com> Link: https://lore.kernel.org/r/20200106103735.10327-1-guoqing.jiang@cloud.ionos.comSigned-off-by:
-
Colin Ian King authored
Fix spelling mistake in text. Signed-off-by:
Colin Ian King <colin.king@canonical.com> Link: https://lore.kernel.org/r/20200110100427.236530-1-colin.king@canonical.comSigned-off-by:
-
- 30 Dec, 2019 5 commits
-
-
Alex Shi authored
kernel enforcement statement is a important statement to show a kind of attitude in kernel community. This patch translate it into Chinese and add it into toctree. Signed-off-by:
Alex Shi <alex.shi@linux.alibaba.com> Cc: Fengguang Wu <fengguang.wu@intel.com> Cc: Li Zefan <lizefan@huawei.com> Cc: Harry Wei <harryxiyou@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org Link: https://lore.kernel.org/r/1576811085-30544-3-git-send-email-alex.shi@linux.alibaba.comSigned-off-by:
-
Alex Shi authored
kernel driver statement is a great statement in kernel community. This patch translate the statement into Chinese and add it into toctree. Signed-off-by:
-
Alex Shi authored
Embargoed hardware issues is a necessary process guide, but leak of Chinese version, since there is more Chinese hardware vendors in market. We'd better have a Chinese version of this guide. This patch translate the guide, add it into toctree. and also add a link stub for the original doc. Signed-off-by:
-
Masanari Iida authored
Fix a spelling typo in omap-hdq.rst Signed-off-by:
Masanari Iida <standby24x7@gmail.com> Link: https://lore.kernel.org/r/20191225165534.9395-1-standby24x7@gmail.comSigned-off-by:
-
Masanari Iida authored
Fix a spelling typo in mm.rst. Signed-off-by:
-
- 19 Dec, 2019 9 commits
-
-
SeongJae Park authored
As suggested by Paul, I got a review from another Korean hacker Yunjae. From the review, I got not only 'Reviewed-by:' tags, but also found a few minor nits. So I made a second version of the patchset but just realized that the first version has already sent to Linus. I therefore send only the nit fixes as another patch. ----------------------------- >8 ---------------------------------------- docs/memory-barriers.txt.kokr: Minor wordsmith This commit fixes a couple of minor nits in the Korean translation of 'memory-barriers.txt'. Signed-off-by:
SeongJae Park <sjpark@amazon.de> Reviewed-by:
Yunjae Lee <lyj7694@gmail.com> Link: https://lore.kernel.org/r/20191129182823.8710-1-sjpark@amazon.deSigned-off-by:
-
Federico Vaga authored
The description was talking about two default values: I removed the wrong one. Signed-off-by:
Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20191201121941.6971-1-federico.vaga@vaga.pv.itSigned-off-by:
-
Madhuparna Bhowmik authored
Documentation: kernel-hacking: hacking.rst: Change reference to document namespaces.rst to symbol-namespaces.rst This patch fixes the following documentation build warning: Warning: Documentation/kernel-hacking/hacking.rst references a file that doesn't exist: Documentation/kbuild/namespaces.rst According to the following patch: https://patchwork.kernel.org/patch/11178727/ (doc: move namespaces.rst from kbuild/ to core-api/) The file namespaces.rst was moved from kbuild to core-api and renamed to symbol-namespaces.rst. Therefore, this patch changes the reference to the document kbuild/namespaces.rst in hacking.rst to core-api/symbol-namespaces.rst Signed-off-by:
Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com> Link: https://lore.kernel.org/r/20191204104554.9100-1-madhuparnabhowmik04@gmail.comSigned-off-by:
-
Madhuparna Bhowmik authored
Documentation: filesystems: automount-support: Change reference to document autofs.txt to autofs.rst This patch fixes following documentation build warning: Warning: Documentation/filesystems/automount-support.txt references a file that doesn't exist: Documentation/filesystems/autofs.txt Signed-off-by:
-
Atish Patra authored
There are some typos in boot image header and riscv boot documentation. Fix the typos. Signed-off-by:
Atish Patra <atish.patra@wdc.com> Reviewed-by:
Palmer Dabbelt <palmerdabbelt@google.com> Link: https://lore.kernel.org/r/20191009010637.9955-1-atish.patra@wdc.comSigned-off-by:
-
Randy Dunlap authored
Fix Sphinx format warning by adding a blank line. Documentation/misc-devices/xilinx_sdfec.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by:
Dragan Cvetic <dragan.cvetic@xilinx.com> Link: https://lore.kernel.org/r/8d644cf1-fa7b-ec62-84cf-9b41d7c30eed@infradead.orgSigned-off-by:
-
Randy Dunlap authored
Fix a Sphinx documentation format warning by breaking a long line into 2 lines. Also drop the ':' usage after the Protocol version numbers since other Protocol versions don't use colons. Documentation/x86/boot.rst:72: WARNING: Malformed table. Text in column margin in table line 57. Fixes: 2c33c27f ("x86/boot: Introduce kernel_info") Fixes: 00cd1c15 ("x86/boot: Introduce kernel_info.setup_type_max") Signed-off-by:
Daniel Kiper <daniel.kiper@oracle.com> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Ingo Molnar <mingo@redhat.com> Cc: Borislav Petkov <bp@alien8.de> Cc: "H. Peter Anvin" <hpa@zytor.com> Link: https://lore.kernel.org/r/c6fbf592-0aca-69d9-e903-e869221a041a@infradead.orgSigned-off-by:
-
Konstantin Ryabitsev authored
Fill in "..." stubs with proper links to the mailing lists's encryption keys and service description URLs. Similarly, fix wording to specify that multiple members of Linux Foundation's IT team have access to internal kernel.org infrastructure, and that all of them have similar confidentiality obligations as the IT team director. Signed-off-by:
Konstantin Ryabitsev <konstantin@linuxfoundation.org> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Link: https://lore.kernel.org/r/20191209192611.GA1688548@chatter.i7.localSigned-off-by:
-
Frank A. Cancio Bello authored
Clarify a few places where the ring buffer and the "snapshot" buffer are cleared as a side effect of an operation. This will avoid users lost of tracing data because of these so far undocumented behavior. Signed-off-by:
-
- 15 Dec, 2019 1 commit
-
-
Linus Torvalds authored
-
