From: "Joel Nider" <JOELN@il.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Doug Ledford <dledford@redhat.com>,
Jason Gunthorpe <jgg@ziepe.ca>, Leon Romanovsky <leon@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Mike Rapoport <rppt@linux.ibm.com>,
Matthew Wilcox <willy@infradead.org>
Subject: Re: [PATCH v2 2/2] docs-rst: userspace: update verbs API details
Date: Thu, 17 Jan 2019 08:33:17 +0200 [thread overview]
Message-ID: <OF50C1BD06.78985B8A-ONC2258384.004ECD0A-C2258385.0024016B@notes.na.collabserv.com> (raw)
In-Reply-To: <20190115143859.4cbd5d9c@lwn.net>
Jonathan Corbet <corbet@lwn.net> wrote on 01/15/2019 11:38:59 PM:
> We are not attempting to duplicate the man pages; there's been
occasional
> talk of bringing them into the kernel tree, but enthusiasm for that is
> scarce for a number of good reasons. But there's a lot of information
> about the user-space API that isn't in the man pages, including the
piece
> you are converting to RST.
My next task is to update the man pages for rdma-core since I touched
libibverbs as well (the _other_ side of this API). So I just want to make
sure everything is documented exactly once (no more, no less) and in the
correct place.
> For something like this, driver-api seems like the right place. Someday,
> in some glorious future, it could contain a full manual on how these
> drivers are written, using all of the nice kerneldoc comments that
already
> exist under drivers/infiniband.
>
> > OK, just to be clear - you are asking me to leave the original file
as-is
> > (well, after .rst conversion) but move it to the new location
> > (Documentation/userspace-api), and put my new content into a new file
in
> > the old location (Documentation/infiniband)?
>
> I'd rather see you put the new stuff under Documentation/driver-api,
either
> in a standalone file or in a new subdirectory.
I took a quick look at what is already there, and I don't see how the RDMA
stuff fits. It looks like the majority is about various busses (SPI, PCI,
I2C, USB, etc) or other general platform support (clk, edac) that I would
use when writing a driver. My changes are very infiniband-specific, and
user-facing and don't really seem to fit in with the aforementioned
modules. It seems to me that if it does not belong in userspace-api, then
leaving it where it is is the best choice.
Regards,
Joel
prev parent reply other threads:[~2019-01-17 6:33 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-15 10:26 docs-rst: update infiniband uverbs doc Joel Nider
2019-01-15 10:26 ` [PATCH v2 1/2] docs-rst: Convert user verbs doc to rst Joel Nider
2019-01-15 15:14 ` Jason Gunthorpe
2019-01-15 18:02 ` Jonathan Corbet
2019-01-15 20:41 ` Joel Nider
2019-01-15 10:26 ` [PATCH v2 2/2] docs-rst: userspace: update verbs API details Joel Nider
2019-01-15 15:31 ` Matthew Wilcox
2019-01-15 16:29 ` Joel Nider
2019-01-15 18:08 ` Jonathan Corbet
2019-01-15 20:37 ` Joel Nider
2019-01-15 21:38 ` Jonathan Corbet
2019-01-17 0:06 ` Mike Rapoport
2019-01-17 6:33 ` Joel Nider [this message]
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=OF50C1BD06.78985B8A-ONC2258384.004ECD0A-C2258385.0024016B@notes.na.collabserv.com \
--to=joeln@il.ibm.com \
--cc=corbet@lwn.net \
--cc=dledford@redhat.com \
--cc=jgg@ziepe.ca \
--cc=leon@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rppt@linux.ibm.com \
--cc=willy@infradead.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).