[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-qu
From: |
Peter Maydell |
Subject: |
Re: [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-quickstart |
Date: |
Fri, 1 Feb 2019 16:46:57 +0000 |
On Fri, 1 Feb 2019 at 16:41, Alex Bennée <address@hidden> wrote:
>
>
> Peter Maydell <address@hidden> writes:
> > +# General information about the project.
> > +project = u'QEMU'
> > +copyright = u'2019, The QEMU Project Developers'
>
> Hmm I bet we forget to update this date. Does it have to be the date the
> text was last touched or could we just go from the last commit in the tree?
Yeah, this isn't ideal, but the same applies to the
string in QEMU_COPYRIGHT in qemu-common.h (as you can tell
from the fact that still says 2018!). If we can fix that
to be generated from something else we can fish it out when
we do the docs build too.
> > +author = u'The QEMU Project Developers'
> > +
> > +# The version info for the project you're documenting, acts as replacement
> > for
> > +# |version| and |release|, also used in various other places throughout the
> > +# built documents.
> > +#
> > +# The short X.Y version.
> > +version = u'4.0'
> > +# The full version, including alpha/beta/rc tags.
> > +release = u'4.0'
>
> Surely these need to come from the build system the same way the
> build-id does?
Yes, see later patch in the series. The idea with the patchset
structure here was that this patch is basically just the
autogenerated stuff (sphinx-quickstart asks a few simple questions
like project name and author which fills these in), and then
the following patches customize that. That seemed to me like
it would be easier to review than if I just squashed everything
into a single patch.
thanks
-- PMM
- [Qemu-devel] [PATCH 00/11] Enable build and install of our rST docs, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 01/11] docs/cpu-hotplug.rst: Fix rST markup issues, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 04/11] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 06/11] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 05/11] docs/conf.py: Configure the 'alabaster' theme, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 02/11] docs: Convert memory.txt to rst format, Peter Maydell, 2019/02/01