From: Joel Nider <joeln@il.ibm.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Jason Gunthorpe <jgg@ziepe.ca>, Leon Romanovsky <leon@kernel.org>,
Doug Ledford <dledford@redhat.com>,
Mike Rapoport <rppt@linux.ibm.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: updating user verbs documentation
Date: Mon, 14 Jan 2019 11:00:48 +0200 [thread overview]
Message-ID: <1547456451-7102-1-git-send-email-joeln@il.ibm.com> (raw)
A small patchset to update the verbs API documentation with some
information regarding the ioctl syscall. First patch converts the
file format to ReST, since this is the new preferred format. 2nd
patch links this file to the main index so we can actually find
it by browsing (search will work in any case). 3rd patch adds the
new content, documenting a bit of the internal workings of the
kernel side of the API functions. The goal is to make it easier
for developers unfamiliar with the structure to understand what
is going on when adding a new function.
[PATCH 1/3] docs-rst: infiniband: Convert user verbs doc to rst
[PATCH 2/3] docs-rst: update index file with infiniband docs
[PATCH 3/3] docs-rst: infiniband: update verbs API details
next reply other threads:[~2019-01-14 9:01 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-14 9:00 Joel Nider [this message]
2019-01-14 9:00 ` [PATCH 1/3] docs-rst: infiniband: Convert user verbs doc to rst Joel Nider
2019-01-14 16:56 ` Jason Gunthorpe
2019-01-14 17:34 ` Jonathan Corbet
2019-01-14 18:52 ` Joel Nider
2019-01-14 18:56 ` Jason Gunthorpe
2019-01-14 9:00 ` [PATCH 2/3] docs-rst: update index file with infiniband docs Joel Nider
2019-01-14 16:54 ` Jason Gunthorpe
2019-01-14 9:00 ` [PATCH 3/3] docs-rst: infiniband: update verbs API details Joel Nider
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=1547456451-7102-1-git-send-email-joeln@il.ibm.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 \
/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