- 23 Apr, 2023 1 commit
-
-
Tomi Valkeinen authored
Commit 8d0e3fc6 ("media: Add 2-10-10-10 RGB formats") added documentation for a few new RGB formats. The table has column-width specifiers for 34 columns used in pdfdocs build. However, the new table has a couple of rows with 35 columns which confused Sphinx's latex builder. The resulting .tex file causes an error in a later stage of a pdfdocs build. Remove the trailing empty dash lines to fix the issue. Fixes: 8d0e3fc6 ("media: Add 2-10-10-10 RGB formats") Reported-by:
Akira Yokosawa <akiyks@gmail.com> Link: https://lore.kernel.org/r/12250823-8445-5854-dfb8-b92c0ff0851e@gmail.com/Signed-off-by:
Tomi Valkeinen <tomi.valkeinen@ideasonboard.com> Tested-by:
Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com> Acked-by:
Mauro Carvalho Chehab <mchehab@kernel.org> [akiyks: explain the cause of build error] Signed-off-by:
Jonathan Corbet <corbet@lwn.net>
-
- 20 Apr, 2023 7 commits
-
-
Brian Masney authored
The existing clk documentation has a section that talks about the clk_ignore_unused kernel parameter. Add additional documentation that describes how to log which clocks the kernel disables on bootup. This will log messages like the following to the console on bootup: [ 1.268115] clk: Disabling unused clocks [ 1.272167] clk_disable: gcc_usb_clkref_en [ 1.276389] clk_disable: gcc_usb30_sec_sleep_clk [ 1.281131] clk_disable: gcc_usb30_prim_sleep_clk ... Signed-off-by:Brian Masney <bmasney@redhat.com> Link: https://lore.kernel.org/r/20230411192153.289688-1-bmasney@redhat.com [jc: turned parameters into a literal block] Signed-off-by:
-
Lin Yu Chen authored
There is a typo in the sentence "A kernel developer must be conscience ...". The word conscience should be conscious. This patch fixes it. Signed-off-by:
Lin Yu Chen <starpt.official@gmail.com> Acked-by:
Steven Rostedt (Google) <rostedt@goodmis.org> Link: https://lore.kernel.org/r/20230412183739.89894-1-starpt.official@gmail.comSigned-off-by:
-
Krzysztof Kozlowski authored
The "Select the recipients for your patch" part about CC-ing mailing lists is a bit vague and might be understood that only some lists should be Cc-ed. That's not what most of the maintainers expect. For given code, associated mailing list must always be CC-ed, because the list is used for reviewing and testing patches. Example are the Devicetree bindings patches, which are tested iff Devicetree mailing list is CC-ed. Signed-off-by:
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Link: https://lore.kernel.org/r/20230413165501.47442-1-krzysztof.kozlowski@linaro.orgSigned-off-by:
-
Lukas Bulwahn authored
Commit c87db8ca0902 ("kmemleak-test: fix kmemleak_test.c build logic") essentially renames the config DEBUG_KMEMLEAK_TEST to SAMPLE_KMEMLEAK, but misses to adjust the documentation. Adjust kmemleak documentation to this config renaming. Signed-off-by:Lukas Bulwahn <lukas.bulwahn@gmail.com> Acked-by:
Catalin Marinas <catalin.marinas@arm.com> Link: https://lore.kernel.org/r/20230414061241.12754-1-lukas.bulwahn@gmail.comSigned-off-by:
-
Alexey Dobriyan authored
Turns out rules about PT_INTERP, PT_GNU_STACK and PT_GNU_PROPERTY program headers are slightly different. Signed-off-by:
Alexey Dobriyan <adobriyan@gmail.com> Link: https://lore.kernel.org/r/88d3f1bb-f4e0-4c40-9304-3843513a1262@p183Signed-off-by:
-
Alain Volmat authored
ST's STiH415 and STiH416 platforms support have been removed since a long time already. This commit updates the sti related documentation overview to remove related entries and update the sti part to add STiH407/STiH410 and STiH418 platforms which are still actively supported. Signed-off-by:
Alain Volmat <avolmat@me.com> Link: https://lore.kernel.org/r/20230416185349.18156-1-avolmat@me.comSigned-off-by:
-
Jonathan Corbet authored
We have long disabled the "html_use_smartypants" option to prevent Sphinx from mangling "--" sequences (among others). Unfortunately, Sphinx changed that option to "smartquotes" in the 1.6.6 release, and seemingly didn't see fit to warn about the use of the obsolete option, resulting in the aforementioned mangling returning. Disable this behavior again and hope that the option name stays stable for a while. Reported-by:
Zipeng Zhang <zhangzipeng0@foxmail.com> Link: https://lore.kernel.org/lkml/tencent_CB1A298D31FD221496FF657CD7EF406E6605@qq.comReviewed-by:
Miguel Ojeda <ojeda@kernel.org> Signed-off-by:
-
- 11 Apr, 2023 2 commits
-
-
Florian Fainelli authored
Newline characters will be taken into account for the firmware search path parameter, warn users about that and provide an example using 'echo -n' such that it clarifies the typical use of that parameter. Signed-off-by:
Florian Fainelli <f.fainelli@gmail.com> Link: https://lore.kernel.org/r/20230402135423.3235-1-f.fainelli@gmail.comSigned-off-by:
-
Kim Phillips authored
it's -> its referenced to by -> referenced by Signed-off-by:
Kim Phillips <kim.phillips@amd.com> Reviewed-by:
Mike Rapoport (IBM) <rppt@kernel.org> Link: https://lore.kernel.org/r/20230331165254.207526-1-kim.phillips@amd.comSigned-off-by:
-
- 10 Apr, 2023 6 commits
-
-
Feng Tang authored
When doing performance tuning or debugging performance regressions, more and more cases are found to be related to false sharing [1][2][3], and the situation can be worse for newer platforms with hundreds of CPUs. There are already many commits in current kernel specially for mitigating the performance degradation due to false sharing. False sharing could harm the performance silently without being noticed, due to reasons like: * data members of a big data structure randomly sitting together in one cache line * global data of small size are linked compactly together So it's better to make a simple document about the normal pattern of false sharing, basic ways to mitigate it and call out to developers to pay attention during code-writing. [ Many thanks to Dave Hansen, Ying Huang, Tim Chen, Julie Du and Yu Chen for their contributions ] [1]. https://lore.kernel.org/lkml/20220619150456.GB34471@xsang-OptiPlex-9020/ [2]. https://lore.kernel.org/lkml/20201102091543.GM31092@shao2-debian/ [3]. https://lore.kernel.org/lkml/20230307125538.818862491@linutronix.de/Signed-off-by:
Feng Tang <feng.tang@intel.com> Reviewed-by:
Randy Dunlap <rdunlap@infradead.org> Reviewed-by:
Shakeel Butt <shakeelb@google.com> Link: https://lore.kernel.org/r/20230407041235.37886-1-feng.tang@intel.comSigned-off-by:
-
Michael S. Tsirkin authored
Stumbled upon a typo while reading the doc, here's a fix. Signed-off-by:
Michael S. Tsirkin <mst@redhat.com> Link: https://lore.kernel.org/r/af1505348a67981f63ccff4e3c3d45b686cda43f.1680864874.git.mst@redhat.comSigned-off-by:
-
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/m68k into arch/ and fix all in-tree references. Reviewed-by:
Geert Uytterhoeven <geert@linux-m68k.org> Signed-off-by:
-
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/parisc into arch/ and fix all in-tree references. Cc: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com> Cc: Helge Deller <deller@gmx.de> Cc: Alex Shi <alexs@kernel.org> Reviewed-by:
Yanteng Si <siyanteng@loongson.cn> Signed-off-by:
-
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/ia64 into arch/ and fix all in-tree references. Signed-off-by: -
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/arc into arch/ and fix all in-tree references. Acked-by:
Vineet Gupta <vgupta@kernel.org> Signed-off-by:
-
- 30 Mar, 2023 7 commits
-
-
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/nios2 into arch/ and fix all in-tree references. Signed-off-by: -
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/openrisc into arch/ and fix all in-tree references. Cc: Jonas Bonn <jonas@southpole.se> Cc: Stefan Kristiansson <stefan.kristiansson@saunalahti.fi> Cc: Stafford Horne <shorne@gmail.com> Acked-by:
Alex Shi <alexs@kernel.org> Reviewed-by:
-
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/sh into arch/ and fix all in-tree references. Cc: Yoshinori Sato <ysato@users.sourceforge.jp> Cc: Rich Felker <dalias@libc.org> Cc: John Paul Adrian Glaubitz <glaubitz@physik.fu-berlin.de> Signed-off-by: -
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/sparc into arch/ and fix all in-tree references. Cc: "David S. Miller" <davem@davemloft.net> Signed-off-by: -
Jonathan Corbet authored
Architecture-specific documentation is being moved into Documentation/arch/ as a way of cleaning up the top-level documentation directory and making the docs hierarchy more closely match the source hierarchy. Move Documentation/xtensa into arch/ and fix all in-tree references. Cc: Chris Zankel <chris@zankel.net> Reviewed-by:
Max Filippov <jcmvbkbc@gmail.com> Signed-off-by:
-
Jonathan Corbet authored
This mirrors commit 4f1bb038 ("docs: create a top-level arch/ directory"), creating a top-level directory to hold architecture-specific documentation. Acked-by:
-
Jonathan Corbet authored
Move the x86 documentation under Documentation/arch/ as a way of cleaning up the top-level directory and making the structure of our docs more closely match the structure of the source directories it describes. All in-kernel references to the old paths have been updated. Acked-by:
Dave Hansen <dave.hansen@linux.intel.com> Cc: linux-arch@vger.kernel.org Cc: x86@kernel.org Cc: Borislav Petkov <bp@alien8.de> Cc: Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/lkml/20230315211523.108836-1-corbet@lwn.net/Signed-off-by:
-
- 29 Mar, 2023 3 commits
-
-
Bagas Sanjaya authored
Commit ba47652b ("media: meye: remove this deprecated driver") removes meye driver but forgets to purge its kernel-parameters.txt entry, hence broken reference. Remove the entry. Link: https://lore.kernel.org/all/202302070341.OVqstpMM-lkp@intel.com/ Fixes: ba47652b ("media: meye: remove this deprecated driver") Reported-by:
kernel test robot <lkp@intel.com> Signed-off-by:
Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by:
-
Federico Vaga authored
Italian translation updated following these changes: commit 901578a4 ("docs: recommend using Link: whenever using Reported-by:")" commit 775a445d ("coding-style: fix title of Greg K-H's talk") commit 1d2ed923 ("Documentation: process: Document suitability of Proton Mail for kernel development") commit 9d0f5cd1 ("docs: promote the title of process/index.rst") commit d4563201 ("Documentation: simplify and clarify DCO contribution example language") commit e7b4311e ("Replace HTTP links with HTTPS ones: Documentation/process") commit 0b02076f ("docs: programming-language: add Rust programming language section") commit 38484a1d ("docs: programming-language: remove mention of the Intel compiler") commit b8885e26 ("Documentation: front page: use recommended heading adornments") Signed-off-by:
Federico Vaga <federico.vaga@vaga.pv.it> Link: https://lore.kernel.org/r/20230326130213.28755-1-federico.vaga@vaga.pv.itSigned-off-by:
-
Akira Yokosawa authored
As this file is included literally, ZERO WIDTH SPACE causes "make pdfdocs" to emit messages which read: Missing character: There is no (U+200B) in font DejaVu Sans Mono/OT:script=latn;language=dflt;! Missing character: There is no (U+200B) in font DejaVu Sans Mono/OT:script=latn;language=dflt;! U+200B (ZERO WIDTH SPADE) has no effect in literal blocks. Remove them and get rid of those noises. Signed-off-by:
Carlos Bilbao <carlos.bilbao@amd.com> Link: https://lore.kernel.org/r/c38176c7-c30a-4c2c-3516-8d3be1c267dc@gmail.comSigned-off-by:
-
- 23 Mar, 2023 8 commits
-
-
Jonathan Corbet authored
As the first step in bringing some order to our architecture-specific documentation, create a top-level arch/ directory and move arch.rst as its index.rst file. There is no change in the rendered docs at this point. Signed-off-by: -
Thorsten Leemhuis authored
Add a text explaining how to quickly build a kernel, as that's something users will often have to do when they want to report an issue or test proposed fixes. This is a huge and frightening task for quite a few users these days, as many rely on pre-compiled kernels and have never built their own. They find help on quite a few websites explaining the process in various ways, but those howtos often omit important details or make things too hard for the 'quickly build just for testing' case that 'localmodconfig' is really useful for. Hence give users something at hand to guide them, as that makes it easier for them to help with testing, debugging, and fixing the kernel. To keep the complexity at bay, the document explicitly focuses on how to compile the kernel on commodity distributions running on commodity hardware. People that deal with less common distributions or hardware will often know their way around already anyway. The text describes a few oddities of Arch and Debian that were found by the author and a few volunteers that tested the described procedure. There are likely more such quirks that need to be covered as well as a few things the author will have missed -- but one has to start somewhere. The document heavily uses anchors and links to them, which makes things slightly harder to read in the source form. But the intended target audience is way more likely to read rendered versions of this text on pages like docs.kernel.org anyway -- and there those anchors and links allow easy jumps to the reference section and back, which makes the document a lot easier to work with for the intended target audience. Aspects relevant for bisection were left out on purpose, as that is a related, but in the end different use case. The rough plan is to have a second document with a similar style to cover bisection. The idea is to reuse a few bits from this document and link quite often to entries in the reference section with the help of the anchors in this text. Signed-off-by:
Thorsten Leemhuis <linux@leemhuis.info> Reviewed-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org> Link: https://lore.kernel.org/r/1a788a8e7ba8a2063df08668f565efa832016032.1678021408.git.linux@leemhuis.infoSigned-off-by:
-
Jakub Wilk authored
The talk title was inadvertently mangled in 8c27ceff ("docs: fix locations of several documents that got moved"). Signed-off-by:
Jakub Wilk <jwilk@jwilk.net> Link: https://lore.kernel.org/r/20230322215311.6579-1-jwilk@jwilk.netSigned-off-by:
-
Tony Luck authored
commit b041b525 ("x86/split_lock: Make life miserable for split lockers") added a delay and serialization of split locks. Commit 72720937 ("x86/split_lock: Add sysctl to control the misery mode") provided a sysctl to turn off the misery. Update the split lock documentation to describe the current state of the code. Signed-off-by:
Tony Luck <tony.luck@intel.com> Link: https://lore.kernel.org/r/20230315225722.104607-1-tony.luck@intel.comSigned-off-by:
-
Zang Leigang authored
Add a missing markup for the code snippet at the end of lru_sort.rst Signed-off-by:
Zang Leigang <zangleigang@hisilicon.com> Reviewed-by:
-
Randy Dunlap authored
Sort all of the "no..." kernel parameters into the correct order as specified in kernel-parameters.rst: "into English Dictionary order (defined as ignoring all punctuation and sorting digits before letters in a case insensitive manner)". No other changes here, just movement of lines. Signed-off-by:
-
Federico Vaga authored
Major update for maintainer-pgp-guide commit e4412739 ("Documentation: raise minimum supported version of binutils to 2.25") commit 67fe6792 ("Documentation: stable: Document alternative for referring upstream commit hash") commit 8763a30b ("docs: deprecated.rst: Add note about DECLARE_FLEX_ARRAY() usage commit 2f993509 ("docs: process/5.Posting.rst: clarify use of Reported-by: tag") commit a31323be ("timers: Update the documentation to reflect on the new timer_shutdown() API") Signed-off-by:
-
Bagas Sanjaya authored
Documentation: maintainer-tip: Rectify link to "Describe your changes" section of submitting-patches.rst The general changelog rules for the tip tree refers to "Describe your changes" section of submitting patches guide. However, the internal link reference targets to non-existent "submittingpatches" label, which brings reader to the top of the linked doc. Correct the target. No changes to submitting-patches.rst since the required label is already there. Fixes: 31c9d7c8 ("Documentation/process: Add tip tree handbook") Signed-off-by:
Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/r/20230320124327.174881-1-bagasdotme@gmail.comSigned-off-by:
-
- 14 Mar, 2023 6 commits
-
-
Mike Rapoport (IBM) authored
Add an example of memory layout with interleaving nodes where even memory banks belong to node 0 and odd memory banks belong to node 1 Suggested-by:
Michal Hocko <mhocko@kernel.org> Signed-off-by:
David Hildenbrand <david@redhat.com> Link: https://lore.kernel.org/r/20230213154447.1631847-1-rppt@kernel.orgSigned-off-by:
-
Lukas Bulwahn authored
Replace the content of the qnx4 README file with the canonical place for such information. Add the credits of the qnx4 contribution to CREDITS. As there is already a QNX4 FILESYSTEM section in MAINTAINERS, it is clear who to contact and send patches to. Signed-off-by:
Anders Larsen <al@alarsen.net> Link: https://lore.kernel.org/r/20230220170210.15677-3-lukas.bulwahn@gmail.comSigned-off-by:
-
Lukas Bulwahn authored
Replace the content of the qnx6 README file with the canonical places for such information. Add the credits of the qnx6 contribution to CREDITS, and add an section in MAINTAINERS to mark this filesystem as Orphan, as the domain ontika.net and email address does not resolve to an IP address anymore. Signed-off-by:
-
Carlos Bilbao authored
For the list of kernel published books, include publication covering kernel debugging from August, 2022 (ISBN 978-1801075039) and one from March, 2021 on the topic of char device drivers and kernel synchronization (ISBN 978-1801079518). Also add foundational book from Robert Love (ISBN 978-1449339531) and remove extra spaces. Co-developed-by:
Kaiwan N Billimoria <kaiwan.billimoria@gmail.com> Signed-off-by:
-
Randy Dunlap authored
Sort the NFS kernel command line parameters. This is done in 4 groups so as to not have them intermingled: 'nfs' module parameters, 'nfs4' module parameters, 'nfsd' module parameters, and nfs "global" (__setup, no module) parameters. There were 5 parameters which were listed with a space between the parameter name and the following '=' sign. The space has been removed since module parameters expect 'parameter=' with no intervening space. Signed-off-by:
-
Lukas Bulwahn authored
Replace link to a non-existing page with a note that lanana.org does not maintain Linux Zone Unicode Assignments anymore. Remove the reference to H. Peter Anvin and the unicode lanana.org email as the maintainer of this file, as at this point, this is all maintained by the general kernel community. Signed-off-by:
-
