linux-kernel - [PATCH v3 0/3] update infiniband uverbs documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Tue, 22 Jan 2019 12:00:32 +0200
From:   Joel Nider <joeln@...ibm.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     Jason Gunthorpe <jgg@...pe.ca>, Leon Romanovsky <leon@...nel.org>,
        Doug Ledford <dledford@...hat.com>,
        Mike Rapoport <rppt@...ux.ibm.com>,
        Joel Nider <joeln@...ibm.com>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH v3 0/3] update infiniband uverbs documentation

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