1309205 Commits

Author SHA1 Message Date
Sebastian Fricke
83a474c11e docs: Add debugging guide for the media subsystem
Provide a guide for developers on how to debug code with a focus on the
media subsystem. This document aims to provide a rough overview over the
possibilities and a rational to help choosing the right tool for the
given circumstances.

Signed-off-by: Sebastian Fricke <sebastian.fricke@collabora.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241028-media_docs_improve_v3-v3-2-edf5c5b3746f@collabora.com
2024-11-22 10:48:12 -07:00
Sebastian Fricke
a037699da0 docs: Add debugging section to process
This idea was formed after noticing that new developers experience
certain difficulty to navigate within the multitude of different
debugging options in the Kernel and while there often is good
documentation for the tools, the developer has to know first that they
exist and where to find them.
Add a general debugging section to the Kernel documentation, as an
easily locatable entry point to other documentation and as a general
guideline for the topic.

Signed-off-by: Sebastian Fricke <sebastian.fricke@collabora.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241028-media_docs_improve_v3-v3-1-edf5c5b3746f@collabora.com
2024-11-22 10:48:12 -07:00
Uwe Kleine-König
d8c949c577 docs/licensing: Clarify wording about "GPL" and "Proprietary"
There are currently some doubts about out-of-tree kernel modules licensed
under GPLv3 and if they are supposed to be able to use symbols exported
using EXPORT_SYMBOL_GPL.

Clarify that "Proprietary" means anything non-GPL2 even though the
license might be an open source license. Also disambiguate "GPL
compatible" to "GPLv2 compatible".

Signed-off-by: Uwe Kleine-König <ukleinek@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241115103842.585207-2-ukleinek@kernel.org
2024-11-22 10:44:25 -07:00
Pavel Tikhomirov
21e500138b docs: core-api/gfp_mask-from-fs-io: indicate that vmalloc supports GFP_NOFS/GFP_NOIO
After the commit 451769ebb7e79 ("mm/vmalloc: alloc GFP_NO{FS,IO} for
vmalloc") in v5.17 it is now safe to use GFP_NOFS/GFP_NOIO flags
in [k]vmalloc, let's reflect it in documentation.

Signed-off-by: Pavel Tikhomirov <ptikhomirov@virtuozzo.com>
Acked-by: Michal Hocko <mhocko@suse.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241119093922.567138-1-ptikhomirov@virtuozzo.com
2024-11-22 10:42:37 -07:00
Randy Dunlap
9e6c5870bb Documentation: kernel-doc: enumerate identifier *type*s
Explain that a kernel-doc :identifiers: line can refer to a struct,
union, enum, or typedef as well as functions.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241119203201.110953-1-rdunlap@infradead.org
2024-11-22 10:37:40 -07:00
Javier Carrasco
72471fc769 Documentation: pwrseq: Fix trivial misspellings
Use proper spelling for 'discrete'. When at it, capitalize 'Linux',
which is common practice in the documentation.

Signed-off-by: Javier Carrasco <javier.carrasco.cruz@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241120-pwrseq-doc-trivial-fixes-v1-1-19a70f4dd156@gmail.com
2024-11-22 10:36:53 -07:00
Randy Dunlap
1e726223be Documentation: filesystems: update filename extensions
Update references to most txt files to rst files.
Update one reference to an md file to a rst file.
Update one file path to its current location.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Jan Kara <jack@suse.cz>
Cc: linux-fsdevel@vger.kernel.org
Cc: Ian Kent <raven@themaw.net>
Cc: autofs@vger.kernel.org
Cc: Alexander Aring <aahringo@redhat.com>
Cc: David Teigland <teigland@redhat.com>
Cc: gfs2@lists.linux.dev
Cc: Eric Biggers <ebiggers@kernel.org>
Cc: Theodore Y. Ts'o <tytso@mit.edu>
Cc: fsverity@lists.linux.dev
Cc: Mark Fasheh <mark@fasheh.com>
Cc: Joel Becker <jlbec@evilplan.org>
Cc: Joseph Qi <joseph.qi@linux.alibaba.com>
Cc: ocfs2-devel@lists.linux.dev
Reviewed-by: Christian Brauner (Microsoft) <brauner@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241120055246.158368-1-rdunlap@infradead.org
2024-11-22 10:31:04 -07:00
Shuah Khan
c818d5c64c Documentation/CoC: spell out enforcement for unacceptable behaviors
The Code of Conduct committee's goal first and foremost is to bring about
change to ensure our community continues to foster respectful discussions.

In the interest of transparency, the CoC enforcement policy is formalized
for unacceptable behaviors.

Update the Code of Conduct Interpretation document with the enforcement
information.

Acked-by: Linus Torvalds <torvalds@linux-foundation.org>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Miguel Ojeda <ojeda@kernel.org>
Acked-by: Dave Hansen <dave.hansen@linux.intel.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
Acked-by: Steven Rostedt <rostedt@goodmis.org>
Acked-by: Dan Williams <dan.j.williams@intel.com>
Acked-by: Theodore Ts'o <tytso@mit.edu>
Acked-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Acked-by: Kees Cook <kees@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241114205649.44179-1-skhan@linuxfoundation.org
2024-11-15 14:31:59 -07:00
Abhinav Saxena
623e5747c6 docs: fix typos and whitespace in Documentation/process/backporting.rst
- Fix repeated word "when" in backporting documentation
- Remove trailing whitespace after '$' character

These issues were reported by checkpatch.pl. No functional changes.

Signed-off-by: Abhinav Saxena <xandfury@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241107061911.106040-1-xandfury@gmail.com
2024-11-12 13:22:16 -07:00
Dongliang Mu
ef7d4c8206 docs/zh_CN: fix one sentence in llvm.rst
According to Jinjie Ruan, the description about the prebuilt llvm is
incorrect. Fix this sentence with new understanding.

Link: https://groups.google.com/g/hust-os-kernel-patches/c/GbN5RkVrBho/m/2sC9rAw7BQAJ
Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Jinjie Ruan <ruanjinjie@huawei.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241107013615.374757-1-dzm91@hust.edu.cn
2024-11-12 13:12:22 -07:00
Thorsten Leemhuis
f5aff6fa64 docs: bug-bisect: add a note about bisecting -next
Explicitly mention how to bisect -next, as nothing in the kernel tree
currently explains that bisects between -next versions won't work well
and it's better to bisect between mainline and -next.

Co-developed-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Reviewed-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/ec19d5fc503ff7db3d4c4ff9e97fff24cc78f72a.1730808651.git.linux@leemhuis.info
2024-11-12 13:06:07 -07:00
Dongliang Mu
b934bc7542 docs/zh_CN: add the translation of kbuild/llvm.rst
Finish the translation of kbuild/llvm.rst and move llvm from TODO
to the main body.

Update to commit 145082ebfcf0 ("Documentation/llvm: turn make command
for ccache into code block")

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241023153235.1291567-1-dzm91@hust.edu.cn
2024-11-04 12:36:10 -07:00
Nir Lichtman
cdcfc02948 Documentation: Fix incorrect paths/magic in magic numbers rst
Fix some no longer true header/c file paths and correct the BAYCOM_MAGIC
value to be decimal as in the source instead of incorrectly hexadecimal

Signed-off-by: Nir Lichtman <nir@lichtman.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241025135128.GA879576@lichtman.org
2024-11-04 12:34:59 -07:00
Andrew Kreimer
a10b5325f0 Documentation/maintainer-tip: Fix typos
Fix typos in documentation: a -> an.

Signed-off-by: Andrew Kreimer <algonell@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241027125712.19141-1-algonell@gmail.com
2024-11-04 12:29:33 -07:00
Guilherme G. Piccoli
7d6094e62c Documentation: Improve crash_kexec_post_notifiers description
The crash_kexec_post_notifiers description could be improved a bit,
by clarifying its upsides (yes, there are some!) and be more descriptive
about the downsides, specially mentioning code that enables the option
unconditionally, like Hyper-V[0], PowerPC (fadump)[1] and more recently,
AMD SEV-SNP[2].

[0] Commit a11589563e96 ("x86/Hyper-V: Report crash register data or kmsg before running crash kernel").
[1] Commit 06e629c25daa ("powerpc/fadump: Fix inaccurate CPU state info in vmcore generated with panic").
[2] Commit 8ef979584ea8 ("crypto: ccp: Add panic notifier for SEV/SNP firmware shutdown on kdump").

Reviewed-by: Stephen Brennan <stephen.s.brennan@oracle.com>
Signed-off-by: Guilherme G. Piccoli <gpiccoli@igalia.com>
Reviewed-by: Michael Kelley <mhklinux@outlook.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241027204159.985163-1-gpiccoli@igalia.com
2024-11-04 12:28:43 -07:00
Yaxin Wang
6f33817fb4 Docs/zh_CN: Translate physical_memory.rst to Simplified Chinese
This patch translates the "physical_memory.rst" document into
Simplified Chinese to improve accessibility for Chinese-speaking
developers and users.

Signed-off-by: Yaxin Wang <wang.yaxin@zte.com.cn>
Signed-off-by: Jiang Kun <jiang.kun2@zte.com.cn>
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: xu xin <xu.xin16@zte.com.cn>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241028135321916ZWK032bHhlbncjvmzDkZs@zte.com.cn
2024-11-04 12:27:15 -07:00
Randy Dunlap
32643e10df Documentation: admin: reorganize kernel-parameters intro
Reorganize the introduction to the kernel-parameters file to place
related paragraphs together:

- move module info together and near the beginning
- add a Special Handling section for dashes, underscores, double quotes,
  cpu lists, and metric (KMG) suffixes. Expand the KMG suffixes to
  include TPE as well.
- add a Kernel Build Options section

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241029180320.412629-1-rdunlap@infradead.org
2024-11-04 11:03:24 -07:00
Dongliang Mu
062d98be0e docs/zh_CN: update the translation of process/programming-language.rst
Update to commit 0b02076f9953 ("docs: programming-language: add Rust
programming language section")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/process/programming-language.rst
commit 0b02076f9953 ("docs: programming-language: add Rust programming
language section")
commit 38484a1d0c50 ("docs: programming-language: remove mention of the
Intel compiler")
2 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20241023062750.849951-1-dzm91@hust.edu.cn>
2024-10-24 15:45:33 -06:00
Dongliang Mu
20e845db46 docs/zh_CN: update the translation of mm/page_owner.rst
Update to commit f5c12105c15f ("mm,page_owner: fix refcount imbalance")

Documentation/translations/zh_CN/mm/page_owner.rst
commit f5c12105c15f ("mm,page_owner: fix refcount imbalance")
commit ba6fe5377244 ("mm,page_owner: update Documentation regarding
page_owner_stacks")
2 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <38a9d8868e0f98dc5d2a08fb865313cc4db943a3.1729327831.git.dzm91@hust.edu.cn>
2024-10-24 14:54:45 -06:00
Dongliang Mu
9d197b627e docs/zh_CN: update the translation of mm/page_table_check.rst
Update to commit 8430557fc584 ("mm/page_table_check: support
userfault wr-protect entries")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/mm/page_table_check.rst
commit 8430557fc584 ("mm/page_table_check: support userfault wr-protect
entries")
commit 81a31a860bb6 ("mm: page_table_check: Make it dependent on
EXCLUSIVE_SYSTEM_RAM")
commit ee86588960e2 ("docs/mm: remove useless markup")
3 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <68b62a5713d5a465f09226c1a607dee7ec76a6aa.1729327831.git.dzm91@hust.edu.cn>
2024-10-24 14:54:45 -06:00
Dongliang Mu
63435ec4b7 docs/zh_CN: update the translation of mm/overcommit-accounting.rst
Update to commit d17ff438a036 ("docs: mm: fix vm overcommit
documentation for OVERCOMMIT_GUESS")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/mm/overcommit-accounting.rst
commit d17ff438a036 ("docs: mm: fix vm overcommit documentation
for OVERCOMMIT_GUESS")
1 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <d426f3f3d9aac061c20c3b766c17369f4e60f398.1729327831.git.dzm91@hust.edu.cn>
2024-10-24 14:54:45 -06:00
Dongliang Mu
0244846a79 docs/zh_CN: update the translation of mm/admon/faq.rst
Update to commit c6bb975aa60b ("Docs/mm/damon/faq: remove old questions")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/mm/damon/faq.rst
commit c6bb975aa60b ("Docs/mm/damon/faq: remove old questions")
1 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20e7e17b18542ecbf924234ed40438b95345e514.1729327831.git.dzm91@hust.edu.cn>
2024-10-24 14:54:45 -06:00
Dongliang Mu
6a8897de11 docs/zh_CN: update the translation of mm/active_mm.rst
Update to commit 88e3009b5283 ("lazy tlb: allow lazy tlb
mm refcounting to be configurable")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/mm/active_mm.rst
commit 88e3009b5283 ("lazy tlb: allow lazy tlb mm refcounting
to be configurable")
commit ee86588960e2 ("docs/mm: remove useless markup")
2 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <985f62236dad7c9446272d94bffc20eb8f45ae4b.1729327831.git.dzm91@hust.edu.cn>
2024-10-24 14:54:44 -06:00
Dongliang Mu
047545e560 docs/zh_CN: update the translation of mm/hmm.rst
Update to commit 406c4c5ee4ea ("docs:mm: fix spelling mistakes in
heterogeneous memory management page")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/mm/hmm.rst
commit 406c4c5ee4ea ("docs:mm: fix spelling mistakes in heterogeneous
memory management page")
commit 090a7f1009b8 ("docs/mm: remove references to hmm_mirror ops and
clean typos")
commit d56b699d76d1 ("Documentation: Fix typos")
3 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <82259a2656549c90591dc3873f3d2e8a4fb41233.1729327831.git.dzm91@hust.edu.cn>
2024-10-24 14:54:44 -06:00
Jonathan Corbet
b27f9e8079 docs: remove Documentation/dontdiff
The dontdiff file is a relic from the pre-Git era that has little use now.
It has entries (parse.c, for example) that will mask real changes to kernel
source files.  There are all kinds of entries for files we do not create
anymore.  Rather than try to fix it up, simply remove it.

Update the kernel documentation (and translations) to remove references to
this file.  There is an ancient Japanese translation of SubmittingPatches
that I am unable to update; that really needs a thorough redo.

Message-ID: <87y12m1zk4.fsf@trenco.lwn.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2024-10-24 12:37:12 -06:00
Pengyu Zhang
56aaee3915 docs/zh_CN: Add a entry in Chinese glossary
To avoid confusion with the term "entry," the glossary stipulates
that in contexts related to page tables, "page table entry" will be
translated as "页表项," while "entry" will be translated as "表项."

Signed-off-by: Pengyu Zhang <zpenya1314@gmail.com>
Link: https://lore.kernel.org/r/20241016141801.25487-5-zpenya1314@gmail.com
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2024-10-21 09:44:31 -06:00
Pengyu Zhang
53e5230277 Docs/zh_CN: Fix the pfn calculation error in page_tables.rst
Synchronize the changes of origin document to fix the pfn value.

Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Pengyu Zhang <zpenya1314@gmail.com>
Link: https://lore.kernel.org/r/20241016141801.25487-4-zpenya1314@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2024-10-21 09:44:23 -06:00
Pengyu Zhang
a1b44f9b5d Docs/zh_CN: Translate page_tables.rst to Simplified Chinese
This patch provides a Simplified Chinese translation of the
"page_tables.rst" document, aimed at improving accessibility for
Chinese-speaking developers and users.

The translation prioritizes technical accuracy and readability, ensuring
that the content remains clear and informative for its intended audience.

Update to commit 4d83d5cdfa12 ("Documentation/page_tables: Add info about
MMU/TLB and Page Faults")

Signed-off-by: Pengyu Zhang <zpenya1314@gmail.com>
Link: https://lore.kernel.org/r/20241016141801.25487-2-zpenya1314@gmail.com
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2024-10-21 09:44:04 -06:00
Dongliang Mu
5ca1c920ad docs/zh_CN: update the translation of process/coding-style.rst
Update to commit c5d436f05a3f ("docs/process: fix typos")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/process/coding-style.rst
commit c5d436f05a3f ("docs/process: fix typos")
commit 82b8000c28b5 ("net: drop special comment style")
2 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241018014609.3781089-1-dzm91@hust.edu.cn
2024-10-21 09:41:29 -06:00
Dongliang Mu
f63874b2db docs/zh_CN: update the translation of process/email-clients.rst
Update to commit 91031ca349ee ("docs: improve comment consistency in
.muttrc example configuration")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/process/email-clients.rst
commit 91031ca349ee ("docs: improve comment consistency in .muttrc
example configuration")
commit 7fe7de7be828 ("Docs/process/email-clients: Document HacKerMaiL")
commit 9c03bc90c065 ("Documentation: process: Revert "Document suitability
of Proton Mail for kernel development"")
commit 1d2ed9234c85 ("Documentation: process: Document suitability of
Proton Mail for kernel development")
4 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241018014908.3783976-1-dzm91@hust.edu.cn
2024-10-21 09:40:10 -06:00
Dongliang Mu
ff8da2af1e docs/zh_CN: update the translation of process/submitting-patches.rst
Update to commit eb5ed2fae197 ("docs: submitting-patches: Advertise b4")

scripts/checktransupdate.py reports:

Documentation/translations/zh_CN/process/submitting-patches.rst
commit eb5ed2fae197 ("docs: submitting-patches: Advertise b4")
commit 413e775efaec ("Documentation: fix links to mailing list services")
2 commits needs resolving in total

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241018015452.3787741-1-dzm91@hust.edu.cn
2024-10-21 09:35:08 -06:00
Jonathan Corbet
6eb119414f Add Yanteng Si to .mailmap
Yanteng Si's old address bounces, creating a lot of noise in conversations
about patches.  Add a .mailmap entry so scripts/get_maintainer.pl will
return a working address.

Acked-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/87plny1zam.fsf@trenco.lwn.net
2024-10-21 09:33:03 -06:00
Thorsten Blum
3a1b9c4d8e docs: Remove redundant word "for"
s/for//

Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241018172924.159221-2-thorsten.blum@linux.dev
2024-10-21 09:32:20 -06:00
Nir Lichtman
6fde43859f Documentation: English fixes in kgdb/kdb article
Minor grammar and typos fixed in the kgdb/kdb article

Signed-off-by: Nir Lichtman <nir@lichtman.org>
Reviewed-by: Douglas Anderson <dianders@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241018223536.GA799515@lichtman.org
2024-10-21 09:30:56 -06:00
Dongliang Mu
ca26a0a273 docs/zh_CN: add the translations of kbuild/reproducible-builds.rst
Finish the translation of kbuild/reproducible-builds.rst and move
reproducible-builds.rst from TODO to the main body.

Update to commit 114ff6fe6cfb ("Documentation: kbuild: Add description
of git for reproducible builds")

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Link: https://lore.kernel.org/r/dcd09bf28f52ba0461b26f800fdbb145c879a313.1729259177.git.dzm91@hust.edu.cn
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2024-10-21 09:26:20 -06:00
Haoyang Liu
3af2dd00a3 docs/zh_CN: add translation of dev-tools/kmsan.rst
Add translation of kmsan.rst and remove it from TODO list.
update to commit 3f53d1b4a4d2 ("docs/dev-tools: fix a typo")

Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Reviewed-by: Yanteng Si <si.yanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241019142243.88712-1-tttturtleruss@hust.edu.cn
2024-10-21 09:19:01 -06:00
Dongliang Mu
a1e42d2543 docs/zh_CN: add the translation of kbuild/kbuild.rst
Finish the translation of kbuild/kbuild.rst and move kbuild
from TODO to the main body.

Update to commit 2eb5d7f24299 ("kbuild: doc: describe the -C
option precisely for external module builds")

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241016131710.2619567-1-dzm91@hust.edu.cn
2024-10-17 09:41:57 -06:00
Haoyang Liu
3f53d1b4a4 docs/dev-tools: fix a typo
fix a typo in dev-tools/kmsan.rst

[jc: this is not really a typo, but "iff" is clearly a confusing construct
for non-native speakers; changing it will prevent people from trying to
"fix" it repeatedly.]

Signed-off-by: Haoyang Liu <tttturtleruss@hust.edu.cn>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241015140159.8082-1-tttturtleruss@hust.edu.cn
2024-10-17 09:39:19 -06:00
Eder Zulian
ce6fab9357 docs/core-api: swiotlb: fix typos
Correct references to swiotlb_tbl_map_single() and
swiotlb_tbl_unmap_single() in the documentation for swiotlb.

Fix two small typos that went unnoticed in commit c93f261dfc39
("Documentation/core-api: add swiotlb documentation"):
swiotlb_tlb_map_single --> swiotlb_tbl_map_single
swiotbl_tlb_unmap_single --> swiotlb_tbl_unmap_single

Signed-off-by: Eder Zulian <ezulian@redhat.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241014224026.1838525-1-ezulian@redhat.com
2024-10-17 09:37:05 -06:00
Randy Dunlap
bb8fd09e28 kernel-doc: allow object-like macros in ReST output
output_function_rst() does not handle object-like macros. It presents
a trailing "()" while output_function_man() handles these macros
correctly.

Update output_function_rst() to handle object-like macros.
Don't show the "Parameters" heading if there are no parameters.

For output_function_man(), don't show the "ARGUMENTS" heading if there
are no parameters.

I have tested this quite a bit with my ad hoc test files for both ReST
and man format outputs. The generated output looks good.

Fixes: cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Horia Geanta <horia.geanta@freescale.com>
Tested-by: Vlastimil Babka <vbabka@suse.cz>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241015181107.536894-1-rdunlap@infradead.org
2024-10-17 09:33:29 -06:00
Vishnu Sanal T
878b56e011 fix grammar on false-sharing.rst
Fix slight grammar mistake on kernel-hacking/false-sharing.rst

Signed-off-by: Vishnu Sanal T <t.v.s10123@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241007191253.112697-2-t.v.s10123@gmail.com
2024-10-14 13:22:17 -06:00
Nihar Chaithanya
41047d53bc docs:process:changes: fix version command for btrfs-progs
The command given in the changes.rst document to check the version of
btrfs-progs is:
-> btrfsck
which does not output the version, and according to manual page of the
btrfs-progs the command to check the version of btrfs-progs is:
-> btrfs --version

Add a fix changing the command to check the version of btrfs-progs.

Signed-off-by: Nihar Chaithanya <niharchaithanya@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241012141425.11852-1-niharchaithanya@gmail.com
2024-10-14 13:19:33 -06:00
Chen-Yu Tsai
be9264110e scripts/kernel-doc: Do not track section counter across processed files
The section counter tracks how many sections of kernel-doc were added.
The only real use of the counter value is to check if anything was
actually supposed to be output and give a warning is nothing is
available.

The current logic of remembering the initial value and then resetting
the value then when processing each file means that if a file has the
same number of sections as the previously processed one, a warning is
incorrectly given.

Fixes: 1da177e4c3f4 ("Linux-2.6.12-rc2")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241008082905.4005524-1-wenst@chromium.org
2024-10-14 10:19:22 -06:00
Pengyu Zhang
6a32c8dfec Docs/mm: Fix a mistake for pfn in page_tables.rst
The documentation incorrectly calculate the pfn value as 0x3fffff,
which should be 0x3ffff instead. It is obtained by right-shifting
0xffffc000 by 14 bits.

This patch corrects the value to prevent any potential confusion
for developers referencing this document.

Signed-off-by: Pengyu Zhang <zpenya1314@gmail.com>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Reviewed-by: Zenghui Yu <zenghui.yu@linux.dev>
Reviewed-by: Mike Rapoport (Microsoft) <rppt@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241009144135.12453-1-zpenya1314@gmail.com
2024-10-14 10:16:16 -06:00
Federico Vaga
443165227d doc:it_IT: update documents in process/
Update Italian translation following these changes under Documentation/process

commit eb5ed2fae197 ("docs: submitting-patches: Advertise b4")
commit 413e775efaec ("Documentation: fix links to mailing list services")
commit 47c67ec1e8ef ("docs: submit-checklist: use subheadings")
commit 5969fbf30274 ("docs: submit-checklist: structure by category")
commit 5f99665ee8f4 ("kbuild: raise the minimum GNU Make requirement to 4.0")
commit 627395716cc3 ("docs: document python version used for compilation")
commit 7a23b027ec17 ("arm64: boot: Support Flat Image Tree")
commit 56f64b370612 ("rust: upgrade to Rust 1.78.0")
commit 82b8000c28b5 ("net: drop special comment style")
commit 6813216bbdba ("Documentation: coding-style: ask function-like macros to evaluate parameters")
commit 91031ca349ee ("docs: improve comment consistency in .muttrc example configuration")
commit 7fe7de7be828 ("Docs/process/email-clients: Document HacKerMaiL")
commit 9c03bc90c065 ("Documentation: process: Revert "Document suitability of Proton Mail for kernel development"")
commit f9a4f4a0e1f5 ("Docs: Move magic-number from process to staging")
commit 7400d25a0a5c ("Docs/process/index: Remove riscv/patch-acceptance from 'Other materi
al' section")

Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241009224518.15585-1-federico.vaga@vaga.pv.it
2024-10-14 10:00:42 -06:00
Dongliang Mu
fbdeb12af1 docs/zh_CN: add the translation of kbuild/kconfig.rst
Finish the translation of kbuild/kconfig.rst and move kconfig
from TODO to the main body.

Update to commit f6314b76d826 ("docs: kbuild/kconfig: reformat/cleanup")

Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn>
Reviewed-by: Alex Shi <alexs@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241005144121.3953919-1-dzm91@hust.edu.cn
2024-10-14 10:00:30 -06:00
André Almeida
82f5ee35d0 scripts/kernel-doc: Fix build time warnings
As stated at Documentation/kbuild/llvm.rst, to make usage of ccache one
must set KBUILD_BUILD_TIMESTAMP=''. Setting this together with W=1
will trigger the following warning for every compiled file:

  date: invalid date ‘+%s’

This comes from kernel-doc script, that produces the following command
when KBUILD_BUILD_TIMESTAMP is empty:

  date -d"" +%s

That triggers the warning above. Add a space between the flag `-d` and
the string argument to fix date command and remove the warning.

Signed-off-by: André Almeida <andrealmeid@igalia.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241010225933.166436-1-andrealmeid@igalia.com
2024-10-14 09:51:38 -06:00
Steven Rostedt
f7e1d19105 Documentation/tracing: Mention that RESET_ATTACK_MITIGATION can clear memory
At the 2024 Linux Plumbers Conference, I was talking with Hans de Goede
about the persistent buffer to display traces from previous boots. He
mentioned that UEFI can clear memory. In my own tests I have not seen
this. He later informed me that it requires the config option:

 CONFIG_RESET_ATTACK_MITIGATION

It appears that setting this will allow the memory to be cleared on boot
up, which will definitely clear out the trace of the previous boot.

Add this information under the trace_instance in kernel-parameters.txt
to let people know that this can cause issues.

Link: https://lore.kernel.org/all/20170825155019.6740-2-ard.biesheuvel@linaro.org/

Reported-by: Hans de Goede <hdegoede@redhat.com>
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Acked-by: Ard Biesheuvel <ardb@kernel.org>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241007131653.35837081@gandalf.local.home
2024-10-14 09:50:30 -06:00
Sergio González Collado
f3904bb70a docs/sp_SP: Add translation for scheduler/sched-bwc.rst
Translate Documentation/scheduler/sched-bwc.rst into Spanish.

Signed-off-by: Sergio González Collado <sergio.collado@gmail.com>
Reviewed-by: Carlos Bilbao <carlos.bilbao.osdev@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240912171144.15398-1-sergio.collado@gmail.com
2024-10-14 09:50:30 -06:00
Bernhard M. Wiedemann
9ac45d4628 docs/zh_TW+zh_CN: Make rst references unique
We found that sphinx parallel processing would randomly pick
one or the other
https://github.com/sphinx-doc/sphinx/issues/6714#issuecomment-2362212754

Signed-off-by: Bernhard M. Wiedemann <bwiedemann@suse.de>
Reviewed-by: Yanteng Si <siyanteng@linux.dev>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240920070144.26947-1-bernhard+linux-doc@lsmod.de
2024-10-14 09:50:30 -06:00