[PATCH 0/3] kernel-hacking documentation cleanup

[PATCH 0/3] kernel-hacking documentation cleanup

[Bagas Sanjaya]

Hi,

Here are additional docs cleanup for kernel-hacking documentation. It
is based on Thorsten's :c:func: annotation removal [1].

Enjoy!

[1]: https://lore.kernel.org/linux-doc/20251222232506.2615-2-thorsten.blum@linux.dev/

Bagas Sanjaya (3):
  Documentation: kernel-hacking: Remove current macro annotation
  Documentation: kernel-hacking: Do not italicize EXPORT_SYMBOL{,_GPL}()
    references
  Documentation: kernel-hacking: Convert internal links

 Documentation/kernel-hacking/hacking.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/3] Documentation: kernel-hacking: Remove current macro annotation

[Bagas Sanjaya]

Remove unneeded :c:macro: annotation of current macro.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/kernel-hacking/hacking.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index bd5401b924427e..a5f7a1df7fb97d 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -345,8 +345,8 @@ routine.
 Before inventing your own cache of often-used objects consider using a
 slab cache in ``include/linux/slab.h``
 
-:c:macro:`current`
-------------------
+current
+-------
 
 Defined in ``include/asm/current.h``
 
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 2/3] Documentation: kernel-hacking: Do not italicize EXPORT_SYMBOL{,_GPL}() references

[Bagas Sanjaya]

Do not italicize EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL() references in
EXPORT_SYMBOL_NS() and EXPORT_SYMBOL_NS_GPL() subsections.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/kernel-hacking/hacking.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index a5f7a1df7fb97d..1d120ff80f956c 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -597,7 +597,7 @@ EXPORT_SYMBOL_NS()
 
 Defined in ``include/linux/export.h``
 
-This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol
+This is the variant of EXPORT_SYMBOL() that allows specifying a symbol
 namespace. Symbol Namespaces are documented in
 Documentation/core-api/symbol-namespaces.rst
 
@@ -606,7 +606,7 @@ EXPORT_SYMBOL_NS_GPL()
 
 Defined in ``include/linux/export.h``
 
-This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol
+This is the variant of EXPORT_SYMBOL_GPL() that allows specifying a symbol
 namespace. Symbol Namespaces are documented in
 Documentation/core-api/symbol-namespaces.rst
 
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 3/3] Documentation: kernel-hacking: Convert internal links

[Bagas Sanjaya]

Convert internal cross-references in "Putting Your Stuff in the kernel"
section from inline code to internal links.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/kernel-hacking/hacking.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/kernel-hacking/hacking.rst b/Documentation/kernel-hacking/hacking.rst
index 1d120ff80f956c..ef527bdc5f8daa 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -735,7 +735,7 @@ make a neat patch, there's administrative work to be done:
 -  Usually you want a configuration option for your kernel hack. Edit
    ``Kconfig`` in the appropriate directory. The Config language is
    simple to use by cut and paste, and there's complete documentation in
-   ``Documentation/kbuild/kconfig-language.rst``.
+   Documentation/kbuild/kconfig-language.rst.
 
    In your description of the option, make sure you address both the
    expert user and the user who knows nothing about your feature.
@@ -745,7 +745,7 @@ make a neat patch, there's administrative work to be done:
 
 -  Edit the ``Makefile``: the CONFIG variables are exported here so you
    can usually just add a "obj-$(CONFIG_xxx) += xxx.o" line. The syntax
-   is documented in ``Documentation/kbuild/makefiles.rst``.
+   is documented in Documentation/kbuild/makefiles.rst.
 
 -  Put yourself in ``CREDITS`` if you consider what you've done
    noteworthy, usually beyond a single file (your name should be at the
@@ -754,7 +754,7 @@ make a neat patch, there's administrative work to be done:
    it implies a more-than-passing commitment to some part of the code.
 
 -  Finally, don't forget to read
-   ``Documentation/process/submitting-patches.rst``
+   Documentation/process/submitting-patches.rst.
 
 Kernel Cantrips
 ===============
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/3] kernel-hacking documentation cleanup

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Hi,
>
> Here are additional docs cleanup for kernel-hacking documentation. It
> is based on Thorsten's :c:func: annotation removal [1].
>
> Enjoy!
>
> [1]: https://lore.kernel.org/linux-doc/20251222232506.2615-2-thorsten.blum@linux.dev/
>
> Bagas Sanjaya (3):
>   Documentation: kernel-hacking: Remove current macro annotation
>   Documentation: kernel-hacking: Do not italicize EXPORT_SYMBOL{,_GPL}()
>     references
>   Documentation: kernel-hacking: Convert internal links
>
>  Documentation/kernel-hacking/hacking.rst | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)

Applied, thanks.

jon