qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki


From: Kashyap Chamarthy
Subject: Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages
Date: Wed, 29 Sep 2021 09:53:48 +0200

On Tue, Sep 28, 2021 at 07:31:26PM +0200, Paolo Bonzini wrote:
> On 22/09/21 14:10, Kashyap Chamarthy wrote:

[...]

> >   docs/devel/spell-check.rst        |  29 ++
> >   docs/devel/submitting-a-patch.rst | 460 ++++++++++++++++++++++++++++++
> >   docs/devel/trivial-patches.rst    |  53 ++++
> >   3 files changed, 542 insertions(+)
> >   create mode 100644 docs/devel/spell-check.rst
> >   create mode 100644 docs/devel/submitting-a-patch.rst
> >   create mode 100644 docs/devel/trivial-patches.rst
> > 
> 
> I think this is missing a link to the new documents in the toctree?

You're right; will do in v2.  (I accidentally added 'toctree' to the
same doc, but then I realized, "no, you should update the index.rst" and
I still missed it.)

> Also, I would prefer to have the headings as "===" "---" "~~~" consistently
> (I have posted some patches this morning that do this for a few more files).

Sure.  I actually checked a couple of existing docs in-tree
build-system.rst and qapi-code-gen.rst) before I used this set of
headings. 

[1] 
https://www.kernel.org/doc/html/v4.10/doc-guide/sphinx.html#specific-guidelines-for-the-kernel-documentation

-- 
/kashyap




reply via email to

[Prev in Thread] Current Thread [Next in Thread]