From: Kashyap Chamarthy <kchamart@redhat.com>
To: Paolo Bonzini <pbonzini@redhat.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
Thomas Huth <thuth@redhat.com>, John Snow <jsnow@redhat.com>,
Michael Tokarev <mjt@tls.msk.ru>,
Laurent Vivier <laurent@vivier.eu>,
qemu-devel@nongnu.org, Stefan Hajnoczi <stefanha@redhat.com>,
Eric Blake <eblake@redhat.com>
Subject: Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages
Date: Wed, 29 Sep 2021 09:53:48 +0200 [thread overview]
Message-ID: <YVQbjBMyPnE2uQ5p@paraplu.home> (raw)
In-Reply-To: <36a4b1a7-2027-dd67-cc4f-64f5f525c7d6@redhat.com>
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
next prev parent reply other threads:[~2021-09-29 7:55 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-22 12:10 [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages Kashyap Chamarthy
2021-09-22 12:10 ` [PATCH 1/3] docs: rSTify the "SpellCheck" wiki Kashyap Chamarthy
2021-09-22 13:10 ` Peter Maydell
2021-09-22 13:48 ` Kashyap Chamarthy
2021-09-22 12:10 ` [PATCH 2/3] docs: rSTify the "TrivialPatches" wiki Kashyap Chamarthy
2021-09-22 13:05 ` Philippe Mathieu-Daudé
2021-09-22 13:16 ` Kashyap Chamarthy
2021-09-22 13:18 ` Daniel P. Berrangé
2021-09-22 12:10 ` [PATCH 3/3] docs: rSTify the "SubmitAPatch" wiki Kashyap Chamarthy
2021-09-22 13:05 ` [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages Peter Maydell
2021-09-22 13:23 ` Kashyap Chamarthy
2021-09-28 17:31 ` Paolo Bonzini
2021-09-29 7:53 ` Kashyap Chamarthy [this message]
2021-10-05 14:01 ` Stefan Hajnoczi
2021-10-05 14:11 ` Kashyap Chamarthy
2021-10-05 14:24 ` Stefan Hajnoczi
2021-10-05 14:39 ` Kashyap Chamarthy
2021-10-05 15:07 ` Philippe Mathieu-Daudé
2021-10-05 15:37 ` Daniel P. Berrangé
2021-10-05 16:03 ` In-tree docs vs. Wiki [Was: Re: [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki pages] Kashyap Chamarthy
2021-10-05 16:06 ` Philippe Mathieu-Daudé
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=YVQbjBMyPnE2uQ5p@paraplu.home \
--to=kchamart@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=laurent@vivier.eu \
--cc=mjt@tls.msk.ru \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
--cc=thuth@redhat.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;
as well as URLs for NNTP newsgroup(s).