linux-kernel - Re: [PATCH v2 1/2] docs-rst: Convert user verbs doc to rst

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-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190115110218.3d844efc@lwn.net>
Date:   Tue, 15 Jan 2019 11:02:18 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Jason Gunthorpe <jgg@...pe.ca>
Cc:     Joel Nider <joeln@...ibm.com>, Leon Romanovsky <leon@...nel.org>,
        Doug Ledford <dledford@...hat.com>,
        Mike Rapoport <rppt@...ux.ibm.com>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 1/2] docs-rst: Convert user verbs doc to rst

On Tue, 15 Jan 2019 08:14:02 -0700
Jason Gunthorpe <jgg@...pe.ca> wrote:

> > Move user_verbs from infiniband to userspace while changing the
> > format. Replace the existing Documentation/infiniband/user_verbs.txt
> > with Documentation/userspace-api/user_verbs.rst. No substantial changes
> > to the content - just some minor reformatting to have the rendering
> > come out nicely.
> > 
> > Since 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 <joeln@...ibm.com>
> > ---
> >  Documentation/infiniband/user_verbs.txt    | 69 -----------------------------
> >  Documentation/userspace-api/index.rst      |  1 +
> >  Documentation/userspace-api/user_verbs.rst | 70 ++++++++++++++++++++++++++++++
> >  3 files changed, 71 insertions(+), 69 deletions(-)
> >  delete mode 100644 Documentation/infiniband/user_verbs.txt
> >  create mode 100644 Documentation/userspace-api/user_verbs.rst  
> 
> Need to update MAINTAINERS for the new file.. Maybe call this
> rdma_user_verbs.rst as we could also have rdma_umad, rdma_cm, etc

Both of those suggestions make sense.  Joel, can you do a quick respin
along those lines?  Then I think this one is ready.

Thanks,

jon