2019-12-04 10:47:07

by Madhuparna Bhowmik

Subject: [PATCH 2/2] Documentation: kernel-hacking: hacking.rst: Change reference to document namespaces.rst to symbol-namespaces.rst

From: Madhuparna Bhowmik <[email protected]>

This patch fixes the following documentation build warning:
Warning: Documentation/kernel-hacking/hacking.rst references
a file that doesn't exist: Documentation/kbuild/namespaces.rst

According to the following patch:
https://patchwork.kernel.org/patch/11178727/
(doc: move namespaces.rst from kbuild/ to core-api/)

The file namespaces.rst was moved from kbuild to core-api
and renamed to symbol-namespaces.rst.
Therefore, this patch changes the reference to the document
kbuild/namespaces.rst in hacking.rst to
core-api/symbol-namespaces.rst

Signed-off-by: Madhuparna Bhowmik <[email protected]>
---
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 a3ddb213a5e1..d62aacb2822a 100644
--- a/Documentation/kernel-hacking/hacking.rst
+++ b/Documentation/kernel-hacking/hacking.rst
@@ -601,7 +601,7 @@ Defined in ``include/linux/export.h``

This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol
namespace. Symbol Namespaces are documented in
-``Documentation/kbuild/namespaces.rst``.
+``Documentation/core-api/symbol-namespaces.rst``.

:c:func:`EXPORT_SYMBOL_NS_GPL()`
--------------------------------
@@ -610,7 +610,7 @@ Defined in ``include/linux/export.h``

This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a symbol
namespace. Symbol Namespaces are documented in
-``Documentation/kbuild/namespaces.rst``.
+``Documentation/core-api/symbol-namespaces.rst``.

Routines and Conventions
========================
--
2.17.1

2019-12-04 19:52:23

by Federico Vaga

Subject: Re: [PATCH 2/2] Documentation: kernel-hacking: hacking.rst: Change reference to document namespaces.rst to symbol-namespaces.rst

If you are interested there is a little discussion here about it

https://www.lkml.org/lkml/2019/11/22/1580

On Wednesday, December 4, 2019 11:45:54 AM CET [email protected]
wrote:
> From: Madhuparna Bhowmik <[email protected]>
>
> This patch fixes the following documentation build warning:
> Warning: Documentation/kernel-hacking/hacking.rst references
> a file that doesn't exist: Documentation/kbuild/namespaces.rst
>
> According to the following patch:
> https://patchwork.kernel.org/patch/11178727/
> (doc: move namespaces.rst from kbuild/ to core-api/)
>
> The file namespaces.rst was moved from kbuild to core-api
> and renamed to symbol-namespaces.rst.
> Therefore, this patch changes the reference to the document
> kbuild/namespaces.rst in hacking.rst to
> core-api/symbol-namespaces.rst
>
> Signed-off-by: Madhuparna Bhowmik <[email protected]>
> ---
> 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 a3ddb213a5e1..d62aacb2822a
> 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -601,7 +601,7 @@ Defined in ``include/linux/export.h``
>
> This is the variant of `EXPORT_SYMBOL()` that allows specifying a symbol
> namespace. Symbol Namespaces are documented in
> -``Documentation/kbuild/namespaces.rst``.
> +``Documentation/core-api/symbol-namespaces.rst``.
>
> :c:func:`EXPORT_SYMBOL_NS_GPL()`
>
> --------------------------------
> @@ -610,7 +610,7 @@ Defined in ``include/linux/export.h``
>
> This is the variant of `EXPORT_SYMBOL_GPL()` that allows specifying a
> symbol namespace. Symbol Namespaces are documented in
> -``Documentation/kbuild/namespaces.rst``.
> +``Documentation/core-api/symbol-namespaces.rst``.
>
> Routines and Conventions
> ========================