Re: [PATCH] kbuild: document generation of offset header files

From: Nathan Chancellor

Date: Wed Apr 29 2026 - 18:17:35 EST


On Sat, 11 Apr 2026 03:42:54 +0530, Piyush Patle <piyushpatle228@xxxxxxxxx> wrote:

Hi Piyush,

> Replace the placeholder reference with a description of how Kbuild
> generates offset header files such as include/generated/asm-offsets.h.
>
> Remove the corresponding TODO entry now that this is documented.
>
> Signed-off-by: Piyush Patle <piyushpatle228@xxxxxxxxx>

Thanks, this seems generally good to me. I had wondered if it was worth
adding a "lay person's explanation" of the example but I think it is
fairly easy to understand.

>
>
> diff --git a/Documentation/kbuild/makefiles.rst b/Documentation/kbuild/makefiles.rst
> index 24a4708d26e8..7521cae7d56f 100644
> --- a/Documentation/kbuild/makefiles.rst
> +++ b/Documentation/kbuild/makefiles.rst
> @@ -1690,9 +1721,3 @@ Credits
> - Updates by Kai Germaschewski <kai@xxxxxxxxxxxxxxxxxxxxxx>
> - Updates by Sam Ravnborg <sam@xxxxxxxxxxxx>
> - Language QA by Jan Engelhardt <jengelh@xxxxxx>
> -
> -TODO
> -====
> -
> -- Generating offset header files.
> -- Add more variables to chapters 7 or 9?

Sashiko notes that you also removed the TODO around variables:

https://sashiko.dev/#/message/20260410221257.191517-1-piyushpatle228@xxxxxxxxx

I don't think it is a big enough deal to warrant a respin but just
something to be aware of for the future.

--
Cheers,
Nathan