public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Manuel Ebner <manuelebner@airmail.cc>,
	Collin Funk <collin.funk1@gmail.com>,
	Shuah Khan <skhan@linuxfoundation.org>
Cc: workflows@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v4 2/4] workflow: process/changes.rst: expand and cleanup list
Date: Mon, 23 Mar 2026 12:28:14 -0600	[thread overview]
Message-ID: <87tsu69z9d.fsf@trenco.lwn.net> (raw)
In-Reply-To: <21f66cb8aa8e3ede1666bec65540824784041aa3.camel@airmail.cc>

Manuel Ebner <manuelebner@airmail.cc> writes:

> On Tue, 2026-03-17 at 09:04 -0600, Jonathan Corbet wrote:
>> Manuel Ebner <manuelebner@airmail.cc> writes:
>> > remove footnote for sphinx
>> >  in the paragraph before the list it says:
>> >  "Also, not all tools are necessary on all systems;
>> >  obviously, if you don't have any PC Card hardware, for example,
>> >  you probably needn't concern yourself with pcmciautils."
>
> i understand this paragraph like this:
> most or all tools can be optional, depending on the specific use case.
> e.g. quota-tools is optional for people compiling the kernel.
> that's why i removed the optional markings.
>
> and pcmciautils, the example in the the file, is not marked as optional in changes.rst:
>
> ====================== ===============  ========================================
>         Program        Minimal version       Command to check the version
> ====================== ===============  ========================================
> [...]
> pcmciautils            004              pccardctl -V

The markings can certainly be done in a more thoughtful way; I don't see
that as an argument for simply removing them, though.

>> > remove "(optional)" for the same reason as above
>> 
>> Here you have lost some information - now the document doesn't say
>> *which* tools are optional.  That is, I think, not ideal.
>
> that's true.
> my question is: what are the tools optional for?
> or what is the criteria for "optional"?

Well, that would be an awfully nice addition to the documentation, but I
wouldn't require that to get your current changes in :)

Thanks,

jon

  reply	other threads:[~2026-03-23 18:28 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20260311164935.183495-3-manuelebner@airmail.cc>
     [not found] ` <20260311165440.183672-2-manuelebner@airmail.cc>
2026-03-17 15:02   ` [PATCH v4 1/4] scripts: ver_linux: expand and fix list Jonathan Corbet
     [not found] ` <20260311165612.184288-2-manuelebner@airmail.cc>
2026-03-17 15:04   ` [PATCH v4 2/4] workflow: process/changes.rst: expand and cleanup list Jonathan Corbet
2026-03-23 17:50     ` Manuel Ebner
2026-03-23 18:28       ` Jonathan Corbet [this message]
     [not found] ` <20260312002535.191111-2-manuelebner@airmail.cc>
2026-03-17 15:05   ` [PATCH v4 3/4] scripts: ver_linux: sort Jonathan Corbet
     [not found] ` <20260312002607.191358-2-manuelebner@airmail.cc>
2026-03-17 15:05   ` [PATCH v4 4/4] workflow: process/changes.rst: sort list Jonathan Corbet
2026-03-17 15:08 ` [PATCH v4 0/4] workflow, scripts: sort changes.rst and ver_linux Jonathan Corbet
2026-03-25 13:30   ` Manuel Ebner
2026-03-25 13:40     ` 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=87tsu69z9d.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=collin.funk1@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=manuelebner@airmail.cc \
    --cc=skhan@linuxfoundation.org \
    --cc=workflows@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