[PATCH] DOCUMENTATION: Correct filename in Documentation

[PATCH] DOCUMENTATION: Correct filename in Documentation

[mail]

Correct filename of renamed file in Documentation

The current documentation in Documentation/core-api/kobject.rst refers to a
macro named `container_of`, supposedly defined in linux/kernel.h while in
reality it is defined in linux/container_of.h

Signed-off-by: René Nyffenegger <mail@renenyffenegger.ch>
--
diff --git a/Documentation/core-api/kobject.rst b/Documentation/core-api/kobject.rst
index 7310247310a0..5f6c61bc03bf 100644
--- a/Documentation/core-api/kobject.rst
+++ b/Documentation/core-api/kobject.rst
@@ -78,7 +78,7 @@ just a matter of using the kobj member.  Code that works with kobjects will
 often have the opposite problem, however: given a struct kobject pointer,
 what is the pointer to the containing structure?  You must avoid tricks
 (such as assuming that the kobject is at the beginning of the structure)
-and, instead, use the container_of() macro, found in ``<linux/kernel.h>``::
+and, instead, use the container_of() macro, found in ``<linux/container_of.h>``::
 
     container_of(ptr, type, member)

Re: [PATCH] DOCUMENTATION: Correct filename in Documentation

[Randy Dunlap]

On 8/17/23 13:59, mail@renenyffenegger.ch wrote:
> Correct filename of renamed file in Documentation
> 
> The current documentation in Documentation/core-api/kobject.rst refers to a
> macro named `container_of`, supposedly defined in linux/kernel.h while in
> reality it is defined in linux/container_of.h
> 
> Signed-off-by: René Nyffenegger <mail@renenyffenegger.ch>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> --
> diff --git a/Documentation/core-api/kobject.rst b/Documentation/core-api/kobject.rst
> index 7310247310a0..5f6c61bc03bf 100644
> --- a/Documentation/core-api/kobject.rst
> +++ b/Documentation/core-api/kobject.rst
> @@ -78,7 +78,7 @@ just a matter of using the kobj member.  Code that works with kobjects will
>  often have the opposite problem, however: given a struct kobject pointer,
>  what is the pointer to the containing structure?  You must avoid tricks
>  (such as assuming that the kobject is at the beginning of the structure)
> -and, instead, use the container_of() macro, found in ``<linux/kernel.h>``::
> +and, instead, use the container_of() macro, found in ``<linux/container_of.h>``::
>  
>      container_of(ptr, type, member)
> 

-- 
~Randy

Re: [PATCH] DOCUMENTATION: Correct filename in Documentation

[Matthew Wilcox]

On Thu, Aug 17, 2023 at 10:59:40PM +0200, mail@renenyffenegger.ch wrote:
> Correct filename of renamed file in Documentation
> 
> The current documentation in Documentation/core-api/kobject.rst refers to a
> macro named `container_of`, supposedly defined in linux/kernel.h while in
> reality it is defined in linux/container_of.h

Maybe we should just remove the reference to where it's defined?

Re: [PATCH] DOCUMENTATION: Correct filename in Documentation

[Jani Nikula]

On Thu, 17 Aug 2023, Matthew Wilcox <willy@infradead.org> wrote:
> On Thu, Aug 17, 2023 at 10:59:40PM +0200, mail@renenyffenegger.ch wrote:
>> Correct filename of renamed file in Documentation
>> 
>> The current documentation in Documentation/core-api/kobject.rst refers to a
>> macro named `container_of`, supposedly defined in linux/kernel.h while in
>> reality it is defined in linux/container_of.h
>
> Maybe we should just remove the reference to where it's defined?

container_of.h seems to have kernel-doc, but it's not included anywhere
in Documentation. With that fixed, this could be a reference to the
documentation.

BR,
Jani.

-- 
Jani Nikula, Intel Open Source Graphics Center