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
Finish the translation of kbuild/llvm.rst and move llvm from TODO
to the main body.
Update to commit 145082ebfc ("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
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
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 a11589563e ("x86/Hyper-V: Report crash register data or kmsg before running crash kernel").
[1] Commit 06e629c25d ("powerpc/fadump: Fix inaccurate CPU state info in vmcore generated with panic").
[2] Commit 8ef979584e ("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
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
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
Update to commit 0b02076f99 ("docs: programming-language: add Rust
programming language section")
scripts/checktransupdate.py reports:
Documentation/translations/zh_CN/process/programming-language.rst
commit 0b02076f99 ("docs: programming-language: add Rust programming
language section")
commit 38484a1d0c ("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>
Update to commit 8430557fc5 ("mm/page_table_check: support
userfault wr-protect entries")
scripts/checktransupdate.py reports:
Documentation/translations/zh_CN/mm/page_table_check.rst
commit 8430557fc5 ("mm/page_table_check: support userfault wr-protect
entries")
commit 81a31a860b ("mm: page_table_check: Make it dependent on
EXCLUSIVE_SYSTEM_RAM")
commit ee86588960 ("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>
Update to commit d17ff438a0 ("docs: mm: fix vm overcommit
documentation for OVERCOMMIT_GUESS")
scripts/checktransupdate.py reports:
Documentation/translations/zh_CN/mm/overcommit-accounting.rst
commit d17ff438a0 ("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>
Update to commit c6bb975aa6 ("Docs/mm/damon/faq: remove old questions")
scripts/checktransupdate.py reports:
Documentation/translations/zh_CN/mm/damon/faq.rst
commit c6bb975aa6 ("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>
Update to commit 88e3009b52 ("lazy tlb: allow lazy tlb
mm refcounting to be configurable")
scripts/checktransupdate.py reports:
Documentation/translations/zh_CN/mm/active_mm.rst
commit 88e3009b52 ("lazy tlb: allow lazy tlb mm refcounting
to be configurable")
commit ee86588960 ("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>
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>
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>
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>
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 4d83d5cdfa ("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>
Update to commit 91031ca349 ("docs: improve comment consistency in
.muttrc example configuration")
scripts/checktransupdate.py reports:
Documentation/translations/zh_CN/process/email-clients.rst
commit 91031ca349 ("docs: improve comment consistency in .muttrc
example configuration")
commit 7fe7de7be8 ("Docs/process/email-clients: Document HacKerMaiL")
commit 9c03bc90c0 ("Documentation: process: Revert "Document suitability
of Proton Mail for kernel development"")
commit 1d2ed9234c ("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
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
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
Finish the translation of kbuild/reproducible-builds.rst and move
reproducible-builds.rst from TODO to the main body.
Update to commit 114ff6fe6c ("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>
Add translation of kmsan.rst and remove it from TODO list.
update to commit 3f53d1b4a4 ("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
Finish the translation of kbuild/kbuild.rst and move kbuild
from TODO to the main body.
Update to commit 2eb5d7f242 ("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
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
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 c93f261dfc
("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
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: cbb4d3e651 ("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
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
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: 1da177e4c3 ("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
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
Update Italian translation following these changes under Documentation/process
commit eb5ed2fae1 ("docs: submitting-patches: Advertise b4")
commit 413e775efa ("Documentation: fix links to mailing list services")
commit 47c67ec1e8 ("docs: submit-checklist: use subheadings")
commit 5969fbf302 ("docs: submit-checklist: structure by category")
commit 5f99665ee8 ("kbuild: raise the minimum GNU Make requirement to 4.0")
commit 627395716c ("docs: document python version used for compilation")
commit 7a23b027ec ("arm64: boot: Support Flat Image Tree")
commit 56f64b3706 ("rust: upgrade to Rust 1.78.0")
commit 82b8000c28 ("net: drop special comment style")
commit 6813216bbd ("Documentation: coding-style: ask function-like macros to evaluate parameters")
commit 91031ca349 ("docs: improve comment consistency in .muttrc example configuration")
commit 7fe7de7be8 ("Docs/process/email-clients: Document HacKerMaiL")
commit 9c03bc90c0 ("Documentation: process: Revert "Document suitability of Proton Mail for kernel development"")
commit f9a4f4a0e1 ("Docs: Move magic-number from process to staging")
commit 7400d25a0a ("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
Finish the translation of kbuild/kconfig.rst and move kconfig
from TODO to the main body.
Update to commit f6314b76d8 ("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
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
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
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
Include a new section in the Index of Further Kernel Documentation with
resources to learn Rust. Reference it in the Rust index. The resources
are a product of a survey among assistants to the conference Kangrejos'24.
Signed-off-by: Carlos Bilbao <carlos.bilbao.osdev@gmail.com>
Reviewed-by: Dirk Behme <dirk.behme@de.bosch.com>
Acked-by: Miguel Ojeda <ojeda@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240922160411.274949-1-carlos.bilbao.osdev@gmail.com
Module kgdb had been converted to debug_core since commit c433820971
("Move kernel/kgdb.c to kernel/debug/debug_core.c") be added, so let's
correct the module parameter path.
Fixes: c433820971 ("Move kernel/kgdb.c to kernel/debug/debug_core.c")
Signed-off-by: Changhuang Liang <changhuang.liang@starfivetech.com>
Reviewed-by: Douglas Anderson <dianders@chromium.org>
Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240925100742.1730576-1-changhuang.liang@starfivetech.com
The Tracing > Histogram page contains a typo in the field display
modifiers table.
Signed-off-by: Gabriele Monaco <gmonaco@redhat.com>
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241003122334.44682-2-gmonaco@redhat.com
