public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Nicolas Schier <nsc@kernel.org>
To: Gang Yan <gang.yan@linux.dev>
Cc: Nathan Chancellor <nathan@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	David Disseldorp <ddiss@suse.de>,
	linux-kbuild@vger.kernel.org, linux-doc@vger.kernel.org,
	Gang Yan <yangang@kylinos.cn>
Subject: Re: [PATCH, v2] kbuild: doc: improve KBUILD_BUILD_TIMESTAMP documentation
Date: Fri, 17 Oct 2025 21:54:12 +0200	[thread overview]
Message-ID: <aPKe5KGR27robyc5@levanger> (raw)
In-Reply-To: <20251017021209.6586-1-gang.yan@linux.dev>

On Fri, Oct 17, 2025 at 10:12:09AM +0800, Gang Yan wrote:
> From: Gang Yan <yangang@kylinos.cn>
> 
> This patch adds an example of how to set KBUILD_BUILD_TIMESTAMP to a
> specific date. Also, note that the provided timestamp is used for
> initramfs mtime fields, which are 32-bit and thus limited to dates
> between the Unix epoch and 2106-02-07 06:28:15 UTC. Dates outside this
> range will cause errors.
> 
> Suggested-by: David Disseldorp <ddiss@suse.de>
> Signed-off-by: Gang Yan <yangang@kylinos.cn>
> Reviewed-by: David Disseldorp <ddiss@suse.de>
> ---
> Changelog:
>  v2:
>   - Replace the invalid example with a valid one.
>   - Apply David's suggestions.
> ---
>  Documentation/kbuild/kbuild.rst | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)
> 

Thanks to both of you!

I have only found a tiny nit-pick, see below.

Reviewed-by: Nicolas Schier <nsc@kernel.org>

> diff --git a/Documentation/kbuild/kbuild.rst b/Documentation/kbuild/kbuild.rst
> index 3388a10f2dcc..881189ecd0ca 100644
> --- a/Documentation/kbuild/kbuild.rst
> +++ b/Documentation/kbuild/kbuild.rst
> @@ -328,8 +328,14 @@ KBUILD_BUILD_TIMESTAMP
>  ----------------------
>  Setting this to a date string overrides the timestamp used in the
>  UTS_VERSION definition (uname -v in the running kernel). The value has to
> -be a string that can be passed to date -d. The default value
> -is the output of the date command at one point during build.
> +be a string that can be passed to date -d. E.g.::
> +
> +$ KBUILD_BUILD_TIMESTAMP="Mon Oct 13 00:00:00 UTC 2025" make

Other code blocks in kbuild.rst are indented by four spaces (and
accidentally five in one line).

I can add these when applying the patch for kbuild-next, if that is ok
for you.

Kind regards
Nicolas

  reply	other threads:[~2025-10-17 20:46 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-17  2:12 [PATCH, v2] kbuild: doc: improve KBUILD_BUILD_TIMESTAMP documentation Gang Yan
2025-10-17 19:54 ` Nicolas Schier [this message]
2025-10-17 23:16   ` GangYan
2025-10-22 21:20 ` Nicolas Schier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aPKe5KGR27robyc5@levanger \
    --to=nsc@kernel.org \
    --cc=corbet@lwn.net \
    --cc=ddiss@suse.de \
    --cc=gang.yan@linux.dev \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=nathan@kernel.org \
    --cc=yangang@kylinos.cn \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox