linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eric Biggers <ebiggers@kernel.org>
To: Bart Van Assche <bvanassche@acm.org>
Cc: linux-block@vger.kernel.org, Jens Axboe <axboe@kernel.dk>,
	linux-doc@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 0/7] docs: consolidate sysfs-block into Documentation/ABI/
Date: Thu, 2 Dec 2021 13:05:39 -0800	[thread overview]
Message-ID: <Yak1I/xolvLIOtkf@sol.localdomain> (raw)
In-Reply-To: <0bf11301-4085-f4a1-eeed-c65d0e5563b4@acm.org>

On Thu, Dec 02, 2021 at 11:32:45AM -0800, Bart Van Assche wrote:
> On 12/1/21 12:45 AM, Eric Biggers wrote:
> > This series consolidates the documentation for /sys/block/<disk>/queue/
> > into Documentation/ABI/, where it is supposed to go (as per Greg KH:
> > https://lore.kernel.org/r/YaXXpEAwVGTLjp1e@kroah.com).
> > 
> > This series also updates MAINTAINERS to associate the block
> > documentation with the block layer.
> > 
> > This series applies to linux-block/for-next.
> > 
> > Eric Biggers (7):
> >    docs: sysfs-block: sort alphabetically
> >    docs: sysfs-block: add contact for nomerges
> >    docs: sysfs-block: fill in missing documentation from queue-sysfs.rst
> >    docs: sysfs-block: document stable_writes
> >    docs: sysfs-block: document virt_boundary_mask
> >    docs: block: remove queue-sysfs.rst
> >    MAINTAINERS: add entries for block layer documentation
> > 
> >   Documentation/ABI/testing/sysfs-block | 766 ++++++++++++++++++--------
> >   Documentation/block/index.rst         |   1 -
> >   Documentation/block/queue-sysfs.rst   | 321 -----------
> >   MAINTAINERS                           |   2 +
> >   4 files changed, 545 insertions(+), 545 deletions(-)
> >   delete mode 100644 Documentation/block/queue-sysfs.rst
> 
> How about adding a patch that moves Documentation/ABI/testing/sysfs-block
> to Documentation/ABI/stable/sysfs-block? The block layer sysfs ABI is used
> widely by user space software and is considered stable.
> 

That would make sense.  I decided not to include it in this patch series since
some of the sysfs-block files were added recently, so may not be as "stable" as
ones that have been around for 18 years, and because about 90% of the sysfs
documentation is in the "testing" directory anyway so it is not unusual.  So I
felt it should be a separate change.

I think these patches should go in first, and then I can send a separate patch
that moves the file to the stable directory, if there is no objection to it.

- Eric

  reply	other threads:[~2021-12-02 21:05 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-01  8:45 [PATCH 0/7] docs: consolidate sysfs-block into Documentation/ABI/ Eric Biggers
2021-12-01  8:45 ` [PATCH 1/7] docs: sysfs-block: sort alphabetically Eric Biggers
2021-12-01  8:45 ` [PATCH 2/7] docs: sysfs-block: add contact for nomerges Eric Biggers
2021-12-01  8:45 ` [PATCH 3/7] docs: sysfs-block: fill in missing documentation from queue-sysfs.rst Eric Biggers
2021-12-01  8:45 ` [PATCH 4/7] docs: sysfs-block: document stable_writes Eric Biggers
2021-12-01  8:45 ` [PATCH 5/7] docs: sysfs-block: document virt_boundary_mask Eric Biggers
2021-12-01  8:45 ` [PATCH 6/7] docs: block: remove queue-sysfs.rst Eric Biggers
2021-12-01  8:45 ` [PATCH 7/7] MAINTAINERS: add entries for block layer documentation Eric Biggers
2021-12-01  8:51 ` [PATCH 0/7] docs: consolidate sysfs-block into Documentation/ABI/ Greg Kroah-Hartman
2021-12-01  9:00 ` Hannes Reinecke
2021-12-02 19:32 ` Bart Van Assche
2021-12-02 21:05   ` Eric Biggers [this message]
2021-12-08  0:36     ` Eric Biggers

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=Yak1I/xolvLIOtkf@sol.localdomain \
    --to=ebiggers@kernel.org \
    --cc=axboe@kernel.dk \
    --cc=bvanassche@acm.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@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;
as well as URLs for NNTP newsgroup(s).