| b580fa30 | 16-Dec-2025 |
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> |
docs: kernel-doc.rst: document the new "var" kernel-doc markup
Add a description containing the new syntax to document variables within kernel-doc markups.
Reviewed-by: Randy Dunlap <rdunlap@infrad
docs: kernel-doc.rst: document the new "var" kernel-doc markup
Add a description containing the new syntax to document variables within kernel-doc markups.
Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <aa0e3abcd6882a62f3ab9c34033c60fca1c44604.1765894964.git.mchehab+huawei@kernel.org>
show more ...
|
| 6ae0f207 | 15-Nov-2025 |
Ankit Khushwaha <ankitkhushwaha.linux@gmail.com> |
docs: parse-headers.rst: Fix a typo
Replace "vantage" with "advantage" in the description of userspace API cross-references.
Signed-off-by: Ankit Khushwaha <ankitkhushwaha.linux@gmail.com> Signed-o
docs: parse-headers.rst: Fix a typo
Replace "vantage" with "advantage" in the description of userspace API cross-references.
Signed-off-by: Ankit Khushwaha <ankitkhushwaha.linux@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20251115114233.32239-1-ankitkhushwaha.linux@gmail.com>
show more ...
|
| d69a03a9 | 08-Nov-2025 |
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> |
docs: doc-guide: parse-headers.rst update its documentation
Besides converting from Perl to Python, parse-headers has gained some new functionality and was moved to tools/docs.
Update its documenta
docs: doc-guide: parse-headers.rst update its documentation
Besides converting from Perl to Python, parse-headers has gained some new functionality and was moved to tools/docs.
Update its documentation accordingly.
Reported-by: Randy Dunlap <rdunlap@infradead.org> Closes: https://lore.kernel.org/linux-doc/9391a0f0-7c92-42aa-8190-28255b22e131@infradead.org/ Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Dongliang Mu <dzm91@hust.edu.cn> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <1f9025dc98dc58da3cc31f3343d5027f351be338.1762594622.git.mchehab+huawei@kernel.org>
show more ...
|
| 7e8a8143 | 18-Sep-2025 |
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> |
docs: add support to build manpages from kerneldoc output
Generating man files currently requires running a separate script. The target also doesn't appear at the docs Makefile.
Add support for man
docs: add support to build manpages from kerneldoc output
Generating man files currently requires running a separate script. The target also doesn't appear at the docs Makefile.
Add support for mandocs at the Makefile, adding the build logic inside sphinx-build-wrapper, updating documentation and dropping the ancillary script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Message-ID: <3d248d724e7f3154f6e3a227e5923d7360201de9.1758196090.git.mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
show more ...
|
| d6d88600 | 20-May-2025 |
Randy Dunlap <rdunlap@infradead.org> |
Docs: doc-guide: update sphinx.rst Sphinx version number
Update the minimum version number to match both Documentation/Changes and Documentation/conf.py.
Signed-off-by: Randy Dunlap <rdunlap@infrad
Docs: doc-guide: update sphinx.rst Sphinx version number
Update the minimum version number to match both Documentation/Changes and Documentation/conf.py.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20250519220413.2914890-1-rdunlap@infradead.org>
show more ...
|
| b31274d5 | 01-Mar-2024 |
Lukas Bulwahn <lukas.bulwahn@gmail.com> |
docs: drop the version constraints for sphinx and dependencies
As discussed (see Links), there is some inertia to move to the recent Sphinx versions for the doc build environment.
As first step, dr
docs: drop the version constraints for sphinx and dependencies
As discussed (see Links), there is some inertia to move to the recent Sphinx versions for the doc build environment.
As first step, drop the version constraints and the related comments. As sphinx depends on jinja2, jinja2 is pulled in automatically. So drop that. Then, the sphinx-pre-install script will fail though with:
Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.
The script simply expects to parse a version constraint with Sphinx in the requirements.txt. That version is used in the script for suggesting the virtualenv directory name.
To suggest a virtualenv directory name, when there is no version given in the requirements.txt, one could try to guess the version that would be downloaded with 'pip install -r Documentation/sphinx/requirements.txt'. However, there seems no simple way to get that version without actually setting up the venv and running pip. So, instead, name the directory with the fixed name 'sphinx_latest'.
Finally update the Sphinx build documentation to reflect this directory name change.
Link: https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/ Link: https://lore.kernel.org/linux-doc/20240226093854.47830-1-lukas.bulwahn@gmail.com/ Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Tested-by: Vegard Nossum <vegard.nossum@oracle.com> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20240301141800.30218-1-lukas.bulwahn@gmail.com>
show more ...
|
| 91a3d6be | 07-Jan-2024 |
Randy Dunlap <rdunlap@infradead.org> |
doc-guide: kernel-doc: tell about object-like macros
Since 2014 kernel-doc has supported describing object-like macros but it is not documented anywhere. I should have required some documentation fo
doc-guide: kernel-doc: tell about object-like macros
Since 2014 kernel-doc has supported describing object-like macros but it is not documented anywhere. I should have required some documentation for it when I merged the patch. :(
There are currently only 3 uses of this (all in DRM headers, in include/drm/*.h).
Add object-like macro kernel-doc documentation now so that more may know about it and use it.
Fixes: cbb4d3e6510b ("scripts/kernel-doc: handle object-like macros") Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20240107012400.32587-1-rdunlap@infradead.org
show more ...
|