Re: [PATCH v2 2/7] docs/devel: create "Developing QEMU" subsection

[John Snow <jsnow@redhat.com>]

[-- Attachment #1: Type: text/plain, Size: 2161 bytes --]

On Fri, Aug 6, 2021 at 12:42 PM Philippe Mathieu-Daudé <f4bug@amsat.org>
wrote:

> On 8/6/21 6:40 PM, Philippe Mathieu-Daudé wrote:
> > On 8/6/21 5:51 PM, John Snow wrote:
> >> Signed-off-by: John Snow <jsnow@redhat.com>
> >> Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
> >> Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
> >> ---
> >>  docs/devel/index.rst               |  6 +-----
> >>  docs/devel/section-development.rst | 12 ++++++++++++
> >>  2 files changed, 13 insertions(+), 5 deletions(-)
> >>  create mode 100644 docs/devel/section-development.rst
> >>
> >> diff --git a/docs/devel/index.rst b/docs/devel/index.rst
> >> index 008d489d751..57016edd841 100644
> >> --- a/docs/devel/index.rst
> >> +++ b/docs/devel/index.rst
> >> @@ -10,9 +10,7 @@ modifying QEMU's source code.
> >>     :includehidden:
> >>
> >>     section-community-governance
> >> -   build-system
> >> -   style
> >> -   kconfig
> >> +   section-development
> >>     testing
> >>     fuzzing
> >>     control-flow-integrity
> >> @@ -20,11 +18,9 @@ modifying QEMU's source code.
> >>     memory
> >>     migration
> >>     atomics
> >> -   stable-process
> >>     ci
> >>     qtest
> >>     decodetree
> >> -   secure-coding-practices
> >>     tcg
> >>     tcg-icount
> >>     tracing
> >> diff --git a/docs/devel/section-development.rst
> b/docs/devel/section-development.rst
> >> new file mode 100644
> >> index 00000000000..bba4fea30cb
> >> --- /dev/null
> >> +++ b/docs/devel/section-development.rst
> >> @@ -0,0 +1,12 @@
> >> +Developing QEMU
> >> +===============
> >> +
> >> +.. toctree::
> >> +   :maxdepth: 2
> >> +   :includehidden:
> >> +
> >
> > Could we order from generic to specific?
>
> Oh this is alphetically sorted, nevermind.
>
>
If you want to give them a better "armchair order", I personally welcome
it. A good intro paragraph or two directly in the section-*.rst that
introduces the contents to follow, alongside a brief copy-editing of the
layout and organization of the docs in the section would be very helpful.
It was just more than I wanted to tackle with a quick series.

[-- Attachment #2: Type: text/html, Size: 3181 bytes --]