mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
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>, Joel Nider <joeln@il.ibm.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v3 0/3] update infiniband uverbs documentation
Date: Tue, 22 Jan 2019 12:00:32 +0200	[thread overview]
Message-ID: <1548151235-386-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, moves
the file to Documentation/userspace-api, and updates the index.
The 2nd 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.
The 3rd patch updates the MAINTAINERS file.

v3 addresses comments from Jon, Willy and Jason:
 The location of the new content should be driver-api
 The location of the old (converted) content should be userspace-api
 MAINTAINERS file must be updated

Joel Nider (3):
  docs-rst: Convert user verbs doc to rst
  docs-rst: driver-api: Add infiniband interface documentation
  MAINTAINERS: add new RDMA/Infiniband documentation

 Documentation/driver-api/index.rst              |  1 +
 Documentation/driver-api/infiniband.rst         | 73 +++++++++++++++++++++++++
 Documentation/infiniband/user_verbs.txt         | 69 -----------------------
 Documentation/userspace-api/index.rst           |  1 +
 Documentation/userspace-api/rdma_user_verbs.rst | 70 ++++++++++++++++++++++++
 MAINTAINERS                                     |  2 +
 6 files changed, 147 insertions(+), 69 deletions(-)
 create mode 100644 Documentation/driver-api/infiniband.rst
 delete mode 100644 Documentation/infiniband/user_verbs.txt
 create mode 100644 Documentation/userspace-api/rdma_user_verbs.rst

-- 
2.7.4


             reply	other threads:[~2019-01-22 10:01 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-22 10:00 Joel Nider [this message]
2019-01-22 10:00 ` [PATCH v3 1/3] docs-rst: Convert user verbs doc to rst Joel Nider
2019-01-22 10:00 ` [PATCH v3 2/3] docs-rst: driver-api: Add infiniband interface documentation Joel Nider
2019-02-01 17:09   ` Jason Gunthorpe
2019-01-22 10:00 ` [PATCH v3 3/3] MAINTAINERS: add new RDMA/Infiniband documentation Joel Nider
2019-01-30 12:57 ` [PATCH v3 0/3] update infiniband uverbs documentation Joel Nider
2019-01-30 19:24   ` Jonathan Corbet
2019-02-01 16:52 ` Jason Gunthorpe
2019-02-01 23:15   ` Jonathan Corbet
2019-02-03 12:54     ` 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=1548151235-386-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

all inboxes | Powered by JetHome®