summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2025-05-19Documentation: NTB: Fix typoUtkarsh Tiwari
Fix 'peace' to 'piece' in the ntb documentation Signed-off-by: Utkarsh Tiwari <utkarsh02t@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250519080248.648971-1-utkarsh02t@gmail.com>
2025-05-19Documentation: ioctl-number: Update table introBagas Sanjaya
Introduction paragraph to the ioctl numbers table states that only ioctls in up to ancient Linux kernel version (v2.6.31) for x86 arch are listed. This is inaccurate as the table also lists ioctls from non-x86 archs and the kernel is continously developed (currently in v6.x). Update the paragraph accordingly. Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250508005838.8381-2-bagasdotme@gmail.com>
2025-05-19docs: conf.py: drop backward support for old Sphinx versionsMauro Carvalho Chehab
Since commit 5e25b972a22b ("docs: changes: update Python minimal version"), the minimal Sphinx version is 3.4.3. Drop support for older versions from the config file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250507121117.317810-1-mchehab+huawei@kernel.org>
2025-05-19Docs: driver-api/basics: add kobject_event interfacesRandy Dunlap
Add the kernel-doc comments from lib/kobject_uevent.c to the "Kernel objects manipulation" section of driver API Basics. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Rafael J. Wysocki <rafael@kernel.org> Cc: Danilo Krummrich <dakr@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250509005538.685678-1-rdunlap@infradead.org>
2025-05-19Docs: relay: editing cleanupsRandy Dunlap
Cleanup some punctuation, capital letter, and a missing word in relay.rst. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Andrew Morton <akpm@linux-foundation.org> Cc: Jens Axboe <axboe@kernel.dk> Cc: Tom Zanussi <tzanussi@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250512023233.107582-1-rdunlap@infradead.org>
2025-05-19docs: fix "incase" typo in coresight/panic.rstHendrik Hamerlinck
Corrects a spelling mistake in Documentation/trace/coresight/panic.rst where "incase" was used instead of "in case". Signed-off-by: Hendrik Hamerlinck <hendrik.hamerlinck@hammernet.be> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250513110931.15072-1-hendrik.hamerlinck@hammernet.be>
2025-05-19Fix spelling error for 'parallel'Anish Dabhane
Signed-off-by: Anish Dabhane <anishdabhane71@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250518140107.21310-1-anishdabhane71@gmail.com>
2025-05-19docs: admin-guide: fix typos in reporting-issues.rstShivam Sharma
Correct pin-point to pinpoint, If that the case to If that is the case, and its only slightly modified to it's only slightly modified in Documentation/admin-guide/reporting-issues.rst for proper spelling and grammar. Signed-off-by: Shivam Sharma <10sharmashivam@gmail.com> Acked-by: Thorsten Leemhuis <linux@leemhuis.info> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250518172658.6983-1-10sharmashivam@gmail.com>
2025-05-15Merge tag 'Chinese-doc-6.16-rc1' of ↵Jonathan Corbet
gitolite.kernel.org:pub/scm/linux/kernel/git/alexs/linux into docs-mw Chinese translation docs for 6.16-rc1 from Alex Shi This is the Chinese translation subtree for 6.16-rc1. It just includes few changes: - MAINTAINERS: Change Yanteng's email address - docs/zh_CN: Add how-to of Chinese translation - Add networking translation index - Docs/zh_CN: Translate msg_zerocopy.rst to Simplified Chinese Signed-off-by: Alex Shi <alexs@kernel.org>
2025-05-07docs: dmaengine: add explanation for DMA_ASYNC_TX capabilityKendra Moore
This patch replaces the TODO for DMA_ASYNC_TX in the DMA engine provider documentation. The flag is automatically set by the DMA framework when a device supports key asynchronous memory-to-memory operations such as memcpy, memset, xor, pq, xor_val, and pq_val. It must not be set by drivers directly. Signed-off-by: Kendra Moore <kendra.j.moore3443@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250421010205.84719-1-kendra.j.moore3443@gmail.com>
2025-05-07Documentation: leds: improve readibility of multicolor docJean-Michel Hautbois
When reading the documentation of multicolor leds, the HTML output is not easy to read. Improve it by adding a few markups, splitting the console in a dedicated block. Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@yoseli.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250421-leds-doc-v1-1-9a32df7fc6f4@yoseli.org>
2025-05-07docs: fix typo in firmware-related sectionAlexander Shatalin
Fix a minor grammar issue by changing 'firmwares' to 'firmware' in the Documentation/index.rst file. Signed-off-by: Alexander Shatalin <sashatalin03@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250430142726.3276-1-sashatalin03@gmail.com>
2025-05-07docs: Makefile: Inherit PYTHONPYCACHEPREFIX setting as env variableAkira Yokosawa
Commit 6c2f0b28d76e ("docs: Makefile: store __pycache__ at the output directory") assigns a new path to PYTHONPYCACHEPREFIX for building kernel documentation. However, it is not necessarily optimal for everyone. If you find PYTHONPYCACHEPREFIX is already set, it strongly suggests that the developer has selected the setting as best suited for one's own workflow. Use "?=" in the assignment to PYTHONPYCACHEPREFIX so that the path of $(abspath $(BUILDDIR)/__pycache__) works only as a safeguard. Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <0253ce98-960c-4498-8ace-a4354e3ebc26@gmail.com>
2025-05-07Documentation: ioctl-number: Update outdated submission infoBagas Sanjaya
Much like device numbers that used to be assigned by LANANA (see commit ebdf4040c16df5 ("Documentation: update the devices.txt documentation"), ioctl numbers list is maintained by general kernel community nowadays instead of contacting Michael directly as he's long stepped down from kernel-related activity (his last LKML message was from 2003 [1] and he's in CREDITS since the beginning of kernel's git history). Also, patch (including one to update ioctl numbers list) submission now follows process as described in Documentation/process/submitting-patches.rst rather than sending patches directly to Linus as in the distant past. Update the docs to reflect that. Link: https://lore.kernel.org/r/200305261446.h4QEkBVv023861@duracef.shout.net/ [1] Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250502074504.26933-2-bagasdotme@gmail.com>
2025-04-28docs: namespace: Tweak and reword resource control docJoel Savitz
Fix the document title and reword the phrasing to active voice. Signed-off-by: Joel Savitz <jsavitz@redhat.com> Message-ID: <20250421161723.1138903-1-jsavitz@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2025-04-28docs: Makefile: store __pycache__ at the output directoryMauro Carvalho Chehab
Instead of blocking creation of *.pyc cache, store python cache under Documentation/output/__pycache__ Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <1b9e7f34c1d99a27a8abb308da3221b4663b5693.1745539360.git.mchehab+huawei@kernel.org>
2025-04-28scripts/lib/kdoc/kdoc_parser.py: move kernel entry to a classMauro Carvalho Chehab
The KernelDoc class is too complex. Start optimizing it by placing the kernel-doc parser entry to a separate class. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <28b456f726a022011f0ce5810dbcc26827c1403a.1745564565.git.mchehab+huawei@kernel.org>
2025-04-28scripts/lib/kdoc: change mode to 0644Mauro Carvalho Chehab
The script library here contain just classes. Remove execution permission. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <be0b0a5bde82fa09027a5083f8202f150581eb4e.1745564565.git.mchehab+huawei@kernel.org>
2025-04-28docs: Sphinx: kerneldoc: only initialize kernel-doc classes onceMauro Carvalho Chehab
Instead of re-creating the objects every time, initialize it just once. This allows caching previously parsed objects. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <b00788f26e161512858a6e01a673c34743c954df.1745564565.git.mchehab+huawei@kernel.org>
2025-04-28Documentation: x86: Fix a typo in fsgs.rstAdrian Bütler
Fix a spelling typo in fsgs.rst. Signed-off-by: Adrian Bütler <buetlera123@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250426122303.15905-1-buetlera123@gmail.com>
2025-04-28Documentation: fix speculation.rst chapterCui Wei
'Mitigating speculation side-channels' should be a chapter rather than title. Signed-off-by: Cui Wei <chris.wei.cui@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250426135609.735-1-chris.wei.cui@gmail.com>
2025-04-24.gitignore: ignore Python compiled bytecodeMauro Carvalho Chehab
While the building system doesn't create any Python JIT bytecode, if one manually runs kernel-doc.py or get_abi.py, Python will, by default, create a bytecode and store it under scripts/lib/*. This is normal, and not controlled by the Kernel itself. So, add *.pyc as an extension to be ignored. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <ae1c54ddacf6ded1f7154897b10798d4b3fdaf96.1745453655.git.mchehab+huawei@kernel.org>
2025-04-24scripts/kernel-doc.py: don't create *.pyc filesMauro Carvalho Chehab
As reported by Andy, kernel-doc.py is creating a __pycache__ directory at build time. Disable creation of __pycache__ for the libraries used by kernel-doc.py, when excecuted via the build system or via scripts/find-unused-docs.sh. Reported-by: Andy Shevchenko <andriy.shevchenko@intel.com> Closes: https://lore.kernel.org/linux-doc/Z_zYXAJcTD-c3xTe@black.fi.intel.com/ Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Tested-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <158b962ed7cd104f7bbfe69f499ec1cc378864db.1745453655.git.mchehab+huawei@kernel.org>
2025-04-24Makefile: move KERNELDOC macro to the main MakefileMauro Carvalho Chehab
As kernel-doc script is used not only on Documentation, but also on scripts and drivers/drm Makefiles, move it to the main makefile, as otherwise sub-makefiles may not have it. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Tested-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <bb3ea3b49e76aee51dae7762db10c4d38cd67afe.1745453655.git.mchehab+huawei@kernel.org>
2025-04-24docs: Makefile: get rid of KERNELDOC_CONF env variableMauro Carvalho Chehab
Despite its name, what's there is a set of Sphinx arguments that are passed to sphinx/kerneldoc.py: - kerneldoc_srctree: location of the source tree; - kerneldoc_bin: external script to excecute kernel-doc Drop it, and just place the values at the already-existing ALLSPHINXOPTS variable. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Tested-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <88be0fc288598c30fbedb9cc230b2a7ed28225a2.1745453655.git.mchehab+huawei@kernel.org>
2025-04-21docs: sphinx: kerneldoc: Use python class if availableMauro Carvalho Chehab
Better integrate with the new kernel-doc tool by calling the Python classes directly if KERNELDOC=scripts/kernel-doc.py. This way, warnings won't be duplicated anymore, as files will be parsed only once. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/1556a6c005d8e0fafa951f74725e984e1c7459bf.1744685912.git.mchehab+huawei@kernel.org
2025-04-21scripts:kdoc_files.py: use glob for export_file seekMauro Carvalho Chehab
As filenames are expanded using kernel-doc glob, just in case, use it also when checking for exported symbols. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/21657afdd4f8effe0752a5ec258d74b8a4101f55.1744685912.git.mchehab+huawei@kernel.org
2025-04-21scripts/lib/kdoc/kdoc_parser.py: move states to a separate classMauro Carvalho Chehab
States are really enums. on Python, enums are actually classes, as can be seen at: https://docs.python.org/3/library/enum.html Yet, I can't see any advantage of derivating the class from enum class here. So, just place the states on a separate class. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/00cb4e0b8a1545bf7c4401b58213841db5cba2e2.1744685912.git.mchehab+huawei@kernel.org
2025-04-21scripts/lib/kdoc/kdoc_files.py: don't try to join NoneMauro Carvalho Chehab
If out_msg() returns None, it means that an unknown declaration was found. Avoid letting the script crash on such case. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/4334d16f14cfd93e611b290fb56c35d236cadcb7.1744685912.git.mchehab+huawei@kernel.org
2025-04-21Documentation: trace: Refactor toctreePurva Yeshi
Refactor table of contents of kernel tracing subsystem docs to improve clarity, structure, and organization: - Reformat sections and add appropriate headings - Improve section grouping and refine descriptions for each group - Add docs intro paragraph Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> Link: https://lore.kernel.org/r/20250318113230.24950-2-purvayeshi550@gmail.com [Bagas: massage commit message and address reviews] Co-developed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2025-04-21Documentation: trace: Reduce toctree depthPurva Yeshi
Reduce toctree depth from 2 to 1 so that only docs titles are listed in the toctree. Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> Link: https://lore.kernel.org/r/20250318113230.24950-1-purvayeshi550@gmail.com [Bagas: massage commit message] Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2025-04-14docs: Fix conflicting contributor identity infoAmmar Askar
In commit d4563201f33a ("Documentation: simplify and clarify DCO contribution example language"), the patch submission documentation was updated to remove the note about pseudonyms and instead simplify it to allow "known identities". The process documentation still explicitly prohibits pseudonymous contributors. This patch changes the process documentation to line up with the submitting patches document. Signed-off-by: Ammar Askar <ammar@ammaraskar.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250318235331.3566174-1-ammar@ammaraskar.com
2025-04-14docs/sp_SP: fix links to mailing list servicesAndres Urian Florez
With the changes in the way mailing lists are hostet at kernel.org, there is a need to sync the Spanish documentation to: 1. fix links that are pointing at the outdated resources 2. remove an outdated patchbomb admonition Signed-off-by: Andres Urian Florez <andres.emb.sys@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250324164613.12639-1-andres.emb.sys@gmail.com
2025-04-14Documentation/rtla: Include BPF sample collectionTomas Glozar
Add dependencies needed to build rtla with BPF sample collection support to README, and document both ways of sample collection in the manpages. Signed-off-by: Tomas Glozar <tglozar@redhat.com> Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org> Reviewed-by: Luis Claudio R. Goncalves <lgoncalv@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250311114936.148012-5-tglozar@redhat.com
2025-04-14Documentation/rtla: Fix typo in common_timerlat_description.rstTomas Glozar
Fix "it enable" to "it enables". Fixes: 29380d4055e5 ("rtla: Add rtla timerlat documentation") Signed-off-by: Tomas Glozar <tglozar@redhat.com> Reviewed-by: Luis Claudio R. Goncalves <lgoncalv@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250311114936.148012-4-tglozar@redhat.com
2025-04-14Documentation/rtla: Fix typo in rtla-timerlat.rstTomas Glozar
The file says "rtla hist hist mode" instead of "rtla timerlat hist mode". Fix the typo. Fixes: 29380d4055e5 ("rtla: Add rtla timerlat documentation") Signed-off-by: Tomas Glozar <tglozar@redhat.com> Reviewed-by: Luis Claudio R. Goncalves <lgoncalv@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250311114936.148012-3-tglozar@redhat.com
2025-04-14Documentation/rtla: Fix duplicate text about timerlat tracerTomas Glozar
A passage about how the timerlat tracer outputs information is included in both common_timerlat_description.rst and rtla-timerlat.rst, leading it to be displayed twice in the rtla-timerlat page. Remove the duplicate passage from rtla-timerlat.rst. Fixes: 29380d4055e5 ("rtla: Add rtla timerlat documentation") Signed-off-by: Tomas Glozar <tglozar@redhat.com> Reviewed-by: Luis Claudio R. Goncalves <lgoncalv@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250311114936.148012-2-tglozar@redhat.com
2025-04-14docs: hid: Fix typo in intel-thc-hid.rstChih Yun Lin
Corrected the spelling of "triggerred" to "triggered" and "flexiblity" to "flexibility". Signed-off-by: Chih Yun Lin <noralin249@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250330084518.20916-1-noralin249@gmail.com
2025-04-14Added usb_string function to a namespaceKevin Paul Reddy Janagari
with reference to WARNING: Duplicate C declaration, also defined at driver-api/usb/gadget:804 There is a function usb_string in the file message.c, there is also a struct usb_string in the kernel api headers. The docs is unable to index the function as the index is occupied by struct This fix adds messgae.c to the usb_core namespace (in docs) hence providing usb_sting a unique index usb_core.usb_string() Signed-off-by: Kevin Paul Reddy Janagari <kevinpaul468@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250405165116.147958-1-kevinpaul468@gmail.com
2025-04-14cpufreq: editing corrections to cpufreq.rstRandy Dunlap
Change a few words and abbreviations/punctuation. Change one echo command to include a trailing '`'. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Rafael J. Wysocki <rafael@kernel.org> Cc: Viresh Kumar <viresh.kumar@linaro.org> Cc: linux-pm@vger.kernel.org Cc: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250405001447.4039463-1-rdunlap@infradead.org
2025-04-14docs: Disambiguate a pair of rST labelsJames Addison
According to the reStructuredText documentation, internal hyperlink targets[1] are intended to resolve within the current document. Sphinx has a bug that causes internal hyperlinks declared with duplicate names to resolve nondeterministically, producing incorrect documentation. Sphinx does not yet emit a warning when these duplicate target names are declared. To improve the reproducibility and correctness of the HTML documentation, disambiguate two labels both previously titled "submit_improvements". [1] - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-targets Link: https://github.com/sphinx-doc/sphinx/issues/13383 Signed-off-by: James Addison <jay@jp-hosting.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250407195120.331103-2-jvanderwaa@redhat.com
2025-04-14docs: automarkup: Move common logic to add and resolve xref to helperNícolas F. R. A. Prado
Several of the markup functions contain the same code, calling into sphinx's pending_xref and resolve_xref functions to add and resolve a cross-reference, with only a few of the parameters changed (domain, reference type, markup content). Move this logic to its own function and reuse it in the markup functions. No functional change. Signed-off-by: Nícolas F. R. A. Prado <nfraprado@collabora.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20250408-automarkup-resolve-xref-helper-v2-1-e0a9b8fc7fdd@collabora.com
2025-04-10MAINTAINERS: Change Yanteng's email addressYanteng Si
I'm no longer work for Loongson, so I have permanently lost my Loongson email account. Signed-off-by: Yanteng Si <si.yanteng@linux.dev> Link: https://lore.kernel.org/r/403fa4722ad008800086e41d412cd322243b9089.1743156287.git.si.yanteng@linux.dev Signed-off-by: Alex Shi <alexs@kernel.org>
2025-04-10docs/zh_CN: Add how-to of Chinese translationYanteng Si
Many new faces keep appearing on the mailing list from time to time, and there may be many potential developers who want to participate in the Chinese translation but don't know how to get started. As more and more documents are translated, it is becoming increasingly important to improve the maintainability of Chinese documents. We have a lot of conventions, but currently these conventions are still being passed on orally. At the same time, during the review process, especially for the first few patches submitted by newbies, we have made too many repetitive comments. In order to address the above issues, I have drafted this guide, and there is still a lot that needs to be improved. Alex Shi: Fix a embedded code white space issue. Co-developed-by: Dongliang Mu <dzm91@hust.edu.cn> Signed-off-by: Dongliang Mu <dzm91@hust.edu.cn> Signed-off-by: Yanteng Si <si.yanteng@linux.dev> Link: https://lore.kernel.org/r/0443c86e10d900a4d752d103265c948360563d43.1743156287.git.si.yanteng@linux.dev Signed-off-by: Alex Shi <alexs@kernel.org>
2025-04-10Docs/zh_CN: Translate msg_zerocopy.rst to Simplified ChineseWang Yaxin
translate the "msg_zerocopy.rst" into Simplified Chinese. Update to commit bac2cac12c26("docs: net: description of MSG_ZEROCOPY for AF_VSOCK") Fix embedded code type issue by Alex Shi. Signed-off-by: Wang Yaxin <wang.yaxin@zte.com.cn> Signed-off-by: Jiang Kun <jiang.kun2@zte.com.cn> Signed-off-by: xu xin <xu.xin16@zte.com.cn> Signed-off-by: He Peilin <he.peilin@zte.com.cn> Reviewed-by: Yanteng Si <si.yanteng@linux.dev> Link: https://lore.kernel.org/r/20250319155237978a-_o_XXMLszvXPDlyRsb4@zte.com.cn Signed-off-by: Alex Shi <alexs@kernel.org>
2025-04-10Docs/zh_CN: Translate index.rst to Simplified ChineseWang Yaxin
translate the "index.rst" into Simplified Chinese. Update to commit e793b86ae44e("Documentation: networking: add Twisted Pair Ethernet diagnostics at OSI Layer 1") Signed-off-by: Wang Yaxin <wang.yaxin@zte.com.cn> Signed-off-by: Jiang Kun <jiang.kun2@zte.com.cn> Signed-off-by: xu xin <xu.xin16@zte.com.cn> Signed-off-by: He Peilin <he.peilin@zte.com.cn> Link: https://lore.kernel.org/r/20250319155110884FL0FcZmsjNzP1NnAC70Zs@zte.com.cn Signed-off-by: Alex Shi <alexs@kernel.org>
2025-04-09Merge branch 'mauro' into docs-mwJonathan Corbet
Mauro says: This changeset contains the kernel-doc.py script to replace the verable kernel-doc originally written in Perl. It replaces the first version and the second series I sent on the top of it. I tried to stay as close as possible of the original Perl implementation on the first patch introducing kernel-doc.py, as it helps to double check if each function was properly translated to Python. This have been helpful debugging troubles that happened during the conversion. I worked hard to make it bug-compatible with the original one. Still, its output has a couple of differences from the original one: - The tab expansion works better with the Python script. With that, some outputs that contain tabs at kernel-doc markups are now different; - The new script works better stripping blank lines. So, there are a couple of empty new lines that are now stripped with this version; - There is a buggy logic at kernel-doc to strip empty description and return sections. I was not able to replicate the exact behavior. So, I ended adding an extra logic to strip empty sections with a different algorithm. Yet, on my tests, the results are compatible with the venerable script output for all .. kernel-doc tags found in Documentation/. I double-checked this by adding support to output the kernel-doc commands when V=1, and then I ran a diff between kernel-doc.pl and kernel-doc.py for the same command lines. The only patch that doesn't belong to this series is a patch dropping kernel-doc.pl. I opted to keep it for now, as it can help to better test the new tools. With such changes, if one wants to build docs with the old script, all it is needed is to use KERNELDOC parameter, e.g.: $ make KERNELDOC=scripts/kernel-doc.pl htmldocs
2025-04-09scripts: kernel-doc: fix parsing function-like typedefs (again)Sean Anderson
Typedefs like typedef struct phylink_pcs *(*pcs_xlate_t)(const u64 *args); have a typedef_type that ends with a * and therefore has no word boundary. Add an extra clause for the final group of the typedef_type so we only require a word boundary if we match a word. [mchehab: modify also kernel-doc.py, as we're deprecating the perl version] Fixes: 7d2c6b1edf79 ("scripts: kernel-doc: fix parsing function-like typedefs") Signed-off-by: Sean Anderson <sean.anderson@linux.dev> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/e0abb103c73a96d76602d909f60ab8fd6e2fd0bd.1744106242.git.mchehab+huawei@kernel.org
2025-04-09scripts/kernel-doc.py: Rename the kernel doc Re class to KernReMauro Carvalho Chehab
Using just "Re" makes it harder to distinguish from the native "re" class. So, let's rename it. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/4e095ecd5235a3e811ddcf5bad4cfb92f1da0a4a.1744106242.git.mchehab+huawei@kernel.org
2025-04-09scripts/kernel_doc.py: better handle exported symbolsMauro Carvalho Chehab
Change the logic which detects internal/external symbols in a way that we can re-use it when calling via Sphinx extension. While here, remove an unused self.config var and let it clearer that self.config variables are read-only. This helps to allow handling multiple times in parallel if ever needed. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/6a69ba8d2b7ee6a6427abb53e60d09bd4d3565ee.1744106242.git.mchehab+huawei@kernel.org
generated by cgit v1.2.3 (git 2.39.1) at 2025-07-29 00:33:33 +0000