From: "Daniel P. Berrangé" <berrange@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: Paolo Bonzini <pbonzini@redhat.com>,
QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [PATCH 1/7] docs: name included files ".rst.inc"
Date: Thu, 30 Sep 2021 15:51:44 +0100 [thread overview]
Message-ID: <YVXPAI5RfPvpavnA@redhat.com> (raw)
In-Reply-To: <CAFEAcA_BPE47ibbkobDsa2qH3yTOKd_iU3YjR4t452wN-PzDaQ@mail.gmail.com>
On Thu, Sep 30, 2021 at 03:47:46PM +0100, Peter Maydell wrote:
> On Thu, 30 Sept 2021 at 14:33, Paolo Bonzini <pbonzini@redhat.com> wrote:
> >
> > Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
>
> > --- a/docs/devel/ci.rst
> > +++ b/docs/devel/ci.rst
> > @@ -8,6 +8,6 @@ found at::
> >
> > https://wiki.qemu.org/Testing/CI
> >
> > -.. include:: ci-definitions.rst
> > -.. include:: ci-jobs.rst
> > -.. include:: ci-runners.rst
> > +.. include:: ci-definitions.rst.inc
> > +.. include:: ci-jobs.rst.inc
> > +.. include:: ci-runners.rst.inc
>
> Why are these includes anyway? I think we should either make them
> proper separate documents (pulled in via a toctree), or just fold
> the whole thing into a single file if we think it should only be
> one page. I think it's probably better to reserve the include
> directive for places where we really do need to textually pull in
> another file, ie where we have the same text in several documents.
When editting them I find myself getting lost in the rst file. Each
of them is covering an essentially self-contained topic, so while
it makes sense for the rendered page to be all one, for editors it
is nicer for them to be separate.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
next prev parent reply other threads:[~2021-09-30 14:53 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-30 13:32 [PATCH 0/7] Cleanup sectioning in a few doc files Paolo Bonzini
2021-09-30 13:32 ` [PATCH 1/7] docs: name included files ".rst.inc" Paolo Bonzini
2021-09-30 14:47 ` Peter Maydell
2021-09-30 14:51 ` Daniel P. Berrangé [this message]
2021-09-30 15:02 ` Peter Maydell
2021-10-01 5:14 ` Markus Armbruster
2021-10-01 9:20 ` Peter Maydell
2021-10-01 12:19 ` Paolo Bonzini
2021-09-30 13:32 ` [PATCH 2/7] docs: move notes inside the body of the document Paolo Bonzini
2021-09-30 15:15 ` Peter Maydell
2021-09-30 13:32 ` [PATCH 3/7] docs: put "make" information together in build-system.rst Paolo Bonzini
2021-09-30 15:16 ` Peter Maydell
2021-09-30 13:32 ` [PATCH 4/7] docs: reorganize qgraph.rst Paolo Bonzini
2021-09-30 13:32 ` [PATCH 5/7] docs: reorganize tcg-plugins.rst Paolo Bonzini
2021-09-30 13:32 ` [PATCH 6/7] docs: move gcov section at the end of testing.rst Paolo Bonzini
2021-09-30 15:17 ` Peter Maydell
2021-09-30 13:32 ` [PATCH 7/7] docs: reorganize testing.rst Paolo Bonzini
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=YVXPAI5RfPvpavnA@redhat.com \
--to=berrange@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).