Jonathan Corbet wrote on 02/02/2019 01:15:33 AM:
> Subject: Re: [PATCH v3 0/3] update infiniband uverbs documentation
>
> On Fri, 1 Feb 2019 09:52:52 -0700
> Jason Gunthorpe wrote:
>
> > Doc folks, what is the feedback on these patches? Should I take
> > them through the rdma tree?
>
> If you
Hi Jon,
Have you had a chance to review this patchset?
Thanks,
Joel Nider/Haifa/IBM@IBMIL wrote on 01/22/2019 12:00:32 PM:
> From: Joel Nider/Haifa/IBM@IBMIL
> To: "Jonathan Corbet"
> Cc: "Jason Gunthorpe" , "Leon Romanovsky"
,
> "Doug Ledfor
A short document regarding the user verbs interface implementation on
the kernel side. Also, the corresponding index entry in the
documentation tree.
Signed-off-by: Joel Nider
---
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/infiniband.rst | 73
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
responsibility of the new files.
Signed-off-by: Joel Nider
---
MAINTAINERS | 2 ++
1 file changed, 2 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index 2cf9c1c..977b83d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7487,6 +7487,8 @@ T:git
git://git.kernel.org/pub/scm/linux/kernel
.
Since this documents a userspace API, its home should be with the
other userspace API docs.
Signed-off-by: Joel Nider
---
Documentation/infiniband/user_verbs.txt | 69
Documentation/userspace-api/index.rst | 1 +
Documentation/userspace-api
Jonathan Corbet 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 AP
Jonathan Corbet wrote on 01/15/2019 08:02:18 PM:
> From: Jonathan Corbet
> To: Jason Gunthorpe
> Cc: Joel Nider , Leon Romanovsky ,
Doug
> Ledford , Mike Rapoport ,
linux-
> d...@vger.kernel.org, linux-ker...@vger.kernel.org
> Date: 01/15/2019 08:14 PM
> Subject: Re: [P
Jonathan Corbet wrote on 01/15/2019 08:08:54 PM:
> From: Jonathan Corbet
> To: "Joel Nider"
> Cc: Matthew Wilcox , Doug Ledford
,
> Jason Gunthorpe , Leon Romanovsky ,
linux-
> d...@vger.kernel.org, linux-ker...@vger.kernel.org, Mike Rapoport
> Date: 01/15
Matthew Wilcox wrote on 01/15/2019 05:31:28 PM:
> From: Matthew Wilcox
> To: Joel Nider
> Cc: Jonathan Corbet , Jason Gunthorpe ,
Leon
> Romanovsky , Doug Ledford , Mike
> Rapoport , linux-doc@vger.kernel.org,
linux-ker...@vger.kernel.org
> Date: 01/15/2019 05:31 PM
>
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, d
the stable parts so as to avoid
incorrect information since documentation changes tend to lag behind
code changes.
Signed-off-by: Joel Nider
---
Documentation/userspace-api/user_verbs.rst | 69 +-
1 file changed, 68 insertions(+), 1 deletion(-)
diff --git a
this documents a userspace API, its home should be with the
other userspace API docs.
This is in preparation for updating the content in a subsequent
patch.
Signed-off-by: Joel Nider
---
Documentation/infiniband/user_verbs.txt| 69 -
Documentation/userspace-api
Jonathan Corbet wrote on 01/14/2019 07:34:21 PM:
> From: Jonathan Corbet
> To: Jason Gunthorpe
> Cc: Joel Nider , Leon Romanovsky ,
Doug
> Ledford , Mike Rapoport ,
linux-
> d...@vger.kernel.org, linux-ker...@vger.kernel.org
> Date: 01/14/2019 07:37 PM
> Subject: Re:
the stable parts so as to avoid
incorrect information since documentation changes tend to lag behind
code changes.
Signed-off-by: Joel Nider
---
Documentation/infiniband/user_verbs.rst | 69 -
1 file changed, 68 insertions(+), 1 deletion(-)
diff --git a
Link the previously converted Documentation/infiniband/user_verbs.rst
to the main index by creating a new subsystem (Infiniband) under the
root document. This manifests as a new section under "Kernel API
Documentation" in the index.html, as well as a new section in the
table of contents pane.
This
-by: Joel Nider
---
Documentation/infiniband/user_verbs.rst | 70 +
Documentation/infiniband/user_verbs.txt | 69
2 files changed, 70 insertions(+), 69 deletions(-)
create mode 100644 Documentation/infiniband/user_verbs.rst
delete
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
While using this guide to learn the new documentation method, I saw
a few phrases that I felt could be improved. These small changes
improve the grammar and choice of words to further enhance the
installation instructions.
Signed-off-by: Joel Nider
Acked-by: Matthew Wilcox
---
v2: address
While using this guide to learn the new documentation method, I saw
a few phrases that I felt could be improved. These small changes
improve the grammar and choice of words to further enhance the
installation instructions.
Signed-off-by: Joel Nider
---
Documentation/doc-guide/sphinx.rst | 12
20 matches
Mail list logo
