Signed-off-by: SeongJae Park <sjpark@amazon.de>
Link: https://lore.kernel.org/r/20200131205237.29535-5-sj38.park@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Commit 0ea6e611 ("Documentation: update broken web addresses.")
removed a link to 'http://patchwork.ozlabs.org' in howto, but the change
has not applied to the Korean translation.  This commit simply applies
the change to the Korean translation.  The link is restored now, though.
Signed-off-by: SeongJae Park <sjpark@amazon.de>
Link: https://lore.kernel.org/r/20200131205237.29535-4-sj38.park@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Commit 2e4f5382 ("locking/doc: Rename LOCK/UNLOCK to
ACQUIRE/RELEASE") has not appied to 'spinlock.rst'.  This commit updates
the doc for the change.
Signed-off-by: SeongJae Park <sjpark@amazon.com>
Link: https://lore.kernel.org/r/20200131205237.29535-2-sj38.park@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

While the document is there, it is currently missing at the
index file.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/3b8e7783b1fcc71e4f94af5ea8e5fa264392f8c4.1580193653.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>

It seems that some files were removed from USB documentation.

Update the links accordingly.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/00008303fde6b4e06d027d3b76ae7032614a7030.1580193653.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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>

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: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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: Minchan Kim <minchan@kernel.org>
Link: https://lore.kernel.org/r/77000e12-677a-62f6-9f78-343be5bd6630@infradead.orgSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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 <corbet@lwn.net>

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: Matthew Wilcox (Oracle) <willy@infradead.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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 <corbet@lwn.net>

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.

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: Jonathan Corbet <corbet@lwn.net>

Convert pnfs-scsi-server to ReST and move it to admin-guide. Content
remains mostly unchanged.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/5c4b8af41ca0a427a3987535815bccf47a65d320.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Convert pnfs-block-server.txt to ReST and move it to admin-guide.
Content remains mostly unchanged.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/c06903760e690c16d9df92f5e75f80381d6326d8.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Convert idmapper.txt to ReST and move it to admin-guide.
Content remains mostly unchanged otherwise.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/069e40cd551ea778538f8fe9ad15ee26e45fc748.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Convert nfsd-admin-interfaces to ReST and move it into admin-guide.
Content remains mostly untouched.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/d471305e9c96dec38f18d2ff816fca2269a88e29.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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 <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/9c88f184f9de2a3eb5181563e258559efc02f58a.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Refill a paragraph to eliminate long lines.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/58c50f6ba94a0a2f212c4d2a42f64ffb40336b68.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Convert nfsroot.txt to RST and move it to admin-guide. Content remains
mostly the same.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/442d35917351f5260dd8ed7362e9b5f1264ef8ad.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/cb9f2da2f2f6dd432b4cf9e05f79f74f4d54b6ab.1578697871.git.dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Converts vfat.txt to the reStructuredText format, improving presentation
without changing the underlying content.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
-----------------------------------------------------------
Changes in v3:
Removed unnecessary markup.
Removed section "BUG REPORTS" as recommended by the maintainer.

Changes in v2:
Refactored long lines as pointed out by Jonathan
Copied the maintainer
Updated the reference in the MAINTAINERS file for vfat

I did not move this into admin-guide, waiting on what the
maintainer has to say about this and also about old sections
in the text, if any.

Link: https://lore.kernel.org/r/20191223010030.434902-1-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix WARNING: Inline emphasis start-string without end-string.
This warning was due to wrong syntax being used.
Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20191223033121.1584930-1-dwlsalmeida@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Steven Rostedt (VMware) <rostedt@goodmis.org>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Link: https://lore.kernel.org/r/22f9a98a972c3155c7b478247a087a5efafde774.1577231751.git.frank@generalsoftwareinc.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

Fix minor typos in the doc.
Suggested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Signed-off-by: Frank A. Cancio Bello <frank@generalsoftwareinc.com>
Link: https://lore.kernel.org/r/9ef705d0208a4ca0852fed69bc0838a589a4df85.1577231751.git.frank@generalsoftwareinc.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Steven Rostedt (VMware) <rostedt@goodmis.org>
Suggested-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Reviewed-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Reviewed-by: Joel Fernandes (Google) <joel@joelfernandes.org>
Signed-off-by: Frank A. Cancio Bello <frank@generalsoftwareinc.com>
Link: https://lore.kernel.org/r/6f33be5f3d60e5ffc061d8d2b329d3d3ccf22a8c.1577231751.git.frank@generalsoftwareinc.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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 <alex.shi@linux.alibaba.com>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: lizefan@huawei.com
Cc: Fengguang Wu <fengguang.wu@intel.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-2-git-send-email-alex.shi@linux.alibaba.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Fengguang Wu <fengguang.wu@intel.com>
Cc: lizefan@huawei.com
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Harry Wei <harryxiyou@gmail.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Sasha Levin <sashal@kernel.org>
Cc: Dave Hansen <dave.hansen@linux.intel.com>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Ben Hutchings <ben@decadent.org.uk>
Cc: Tom Lendacky <thomas.lendacky@amd.com>
Cc: Tony Luck <tony.luck@intel.com>
Cc: Kees Cook <keescook@chromium.org>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Link: https://lore.kernel.org/r/1576811085-30544-1-git-send-email-alex.shi@linux.alibaba.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

Fix a spelling typo in mm.rst.
Signed-off-by: Masanari Iida <standby24x7@gmail.com>
Link: https://lore.kernel.org/r/20191226162138.17601-1-standby24x7@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>

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: Madhuparna Bhowmik <madhuparnabhowmik04@gmail.com>
Link: https://lore.kernel.org/r/20191204101939.6939-1-madhuparnabhowmik04@gmail.comSigned-off-by: Jonathan Corbet <corbet@lwn.net>

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: Jonathan Corbet <corbet@lwn.net>