Linux Documentation
 help / color / mirror / Atom feed
From: <dan.j.williams@intel.com>
To: <alison.schofield@intel.com>, Jonathan Corbet <corbet@lwn.net>,
	<linux-doc@vger.kernel.org>
Cc: Alison Schofield <alison.schofield@intel.com>,
	Dan Williams <dan.j.williams@intel.com>
Subject: Re: [PATCH] docs: ABI: make the KernelVersion field optional
Date: Wed, 25 Jun 2025 20:10:20 -0700	[thread overview]
Message-ID: <685cba1cc427b_1608bd1001b@dwillia2-xfh.jf.intel.com.notmuch> (raw)
In-Reply-To: <20250626024101.792073-1-alison.schofield@intel.com>

alison.schofield@ wrote:
> From: Alison Schofield <alison.schofield@intel.com>
> 
> The KernelVersion field has limited practical value. Git history
> provides more accurate tracking of when features were introduced
> and target kernel versions often change during development and
> merge.
> 
> Label it optional.
> 
> Signed-off-by: Alison Schofield <alison.schofield@intel.com>

I gave this feedback as a review comment and support this.

Acked-by: Dan Williams <dan.j.williams@intel.com>

However, this document is quite old and, for example, says about
"Users:":

    "This is very important for interfaces in the 'testing' stage,"

The Users: tag only appears in 49 out of the 564 testing/ files.

Moreover, the testing/ stable/ distinction has lost meaning over time.

So, yes, marking KernelVersion: as explicitly optional is maybe an
improvement, but there are wider issues here, and leaving well enough
alone is also a reasonable outcome in that light.

> ---
> 
> Plan B is to remove the field entirely. 

I do not want to motivate a slew of "cleanup" patches removing it from
other files, so "optional" makes sense.

I think What: and Description: are mandatory, everything else is
optional and maybe note that an ABI is "stable" the moment it is in a
released kernel and a real world use case starts depending on it.

The pain of removing or renaming the stable/ and testing/ directories is
probably not worth it given the potential to break links that people
have to these Documentation files.

  parent reply	other threads:[~2025-06-26  3:10 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-26  2:40 [PATCH] docs: ABI: make the KernelVersion field optional alison.schofield
2025-06-26  2:52 ` Randy Dunlap
2025-06-26  3:32   ` Alison Schofield
2025-06-26  3:53     ` Randy Dunlap
2025-06-26  3:10 ` dan.j.williams [this message]
2025-07-01 19:18 ` Jonathan Corbet

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=685cba1cc427b_1608bd1001b@dwillia2-xfh.jf.intel.com.notmuch \
    --to=dan.j.williams@intel.com \
    --cc=alison.schofield@intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    /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