* [PATCH] docs: simplify each section title
@ 2021-03-22 15:50 marcandre.lureau
2021-03-22 16:36 ` Peter Maydell
0 siblings, 1 reply; 4+ messages in thread
From: marcandre.lureau @ 2021-03-22 15:50 UTC (permalink / raw)
To: qemu-devel; +Cc: Marc-André Lureau, berrange
From: Marc-André Lureau <marcandre.lureau@redhat.com>
Now that we merged into one doc, it makes the nav looks nicer.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
docs/devel/index.rst | 4 ++--
docs/interop/index.rst | 4 ++--
docs/specs/index.rst | 4 ++--
docs/system/index.rst | 4 ++--
docs/tools/index.rst | 4 ++--
docs/user/index.rst | 4 ++--
6 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index 7c424ea6d7..09d21d3514 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -1,8 +1,8 @@
.. This is the top level page for the 'devel' manual.
-QEMU Developer's Guide
-======================
+Developers
+==========
This manual documents various parts of the internals of QEMU.
You only need to read it if you are interested in reading or
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 95d56495f6..219a5e5fc5 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -1,8 +1,8 @@
.. This is the top level page for the 'interop' manual.
-QEMU System Emulation Management and Interoperability Guide
-===========================================================
+System Emulation Management and Interoperability
+================================================
This manual contains documents and specifications that are useful
for making QEMU interoperate with other software.
diff --git a/docs/specs/index.rst b/docs/specs/index.rst
index 1b0eb979d5..7b08314d33 100644
--- a/docs/specs/index.rst
+++ b/docs/specs/index.rst
@@ -1,8 +1,8 @@
.. This is the top level page for the 'specs' manual
-QEMU System Emulation Guest Hardware Specifications
-===================================================
+System Emulation Guest Hardware Specifications
+==============================================
Contents:
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 6ad9c93806..02d0707181 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -1,8 +1,8 @@
.. This is the top level page for the 'system' manual.
-QEMU System Emulation User's Guide
-==================================
+System Emulation
+================
This manual is the overall guide for users using QEMU
for full system emulation (as opposed to user-mode emulation).
diff --git a/docs/tools/index.rst b/docs/tools/index.rst
index 3a5829c17a..d923834a73 100644
--- a/docs/tools/index.rst
+++ b/docs/tools/index.rst
@@ -1,8 +1,8 @@
.. This is the top level page for the 'tools' manual
-QEMU Tools Guide
-================
+Tools
+=====
Contents:
diff --git a/docs/user/index.rst b/docs/user/index.rst
index e030dadf65..a5b47459ec 100644
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -1,8 +1,8 @@
.. This is the top level page for the 'user' manual.
-QEMU User Mode Emulation User's Guide
-=====================================
+User Mode Emulation
+===================
This manual is the overall guide for users using QEMU
for user-mode emulation. In this mode, QEMU can launch
--
2.29.0
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] docs: simplify each section title
2021-03-22 15:50 [PATCH] docs: simplify each section title marcandre.lureau
@ 2021-03-22 16:36 ` Peter Maydell
2021-03-22 18:15 ` John Snow
0 siblings, 1 reply; 4+ messages in thread
From: Peter Maydell @ 2021-03-22 16:36 UTC (permalink / raw)
To: Marc-André Lureau; +Cc: Daniel P. Berrange, QEMU Developers
On Mon, 22 Mar 2021 at 16:03, <marcandre.lureau@redhat.com> wrote:
>
> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>
> Now that we merged into one doc, it makes the nav looks nicer.
>
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> ---
> docs/devel/index.rst | 4 ++--
> docs/interop/index.rst | 4 ++--
> docs/specs/index.rst | 4 ++--
> docs/system/index.rst | 4 ++--
> docs/tools/index.rst | 4 ++--
> docs/user/index.rst | 4 ++--
> 6 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/docs/devel/index.rst b/docs/devel/index.rst
> index 7c424ea6d7..09d21d3514 100644
> --- a/docs/devel/index.rst
> +++ b/docs/devel/index.rst
> @@ -1,8 +1,8 @@
> .. This is the top level page for the 'devel' manual.
>
>
> -QEMU Developer's Guide
> -======================
> +Developers
> +==========
I think this should be "Developer's Guide" or "Developer Information"
or something. Just "Developers" doesn't really read right to me:
it is not "documentation of developers" in the way that the "Tools"
section is "documentation of tools", etc.
thanks
-- PMM
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] docs: simplify each section title
2021-03-22 16:36 ` Peter Maydell
@ 2021-03-22 18:15 ` John Snow
2021-03-22 19:48 ` Marc-André Lureau
0 siblings, 1 reply; 4+ messages in thread
From: John Snow @ 2021-03-22 18:15 UTC (permalink / raw)
To: Peter Maydell, Marc-André Lureau; +Cc: Daniel P. Berrange, QEMU Developers
On 3/22/21 12:36 PM, Peter Maydell wrote:
> On Mon, 22 Mar 2021 at 16:03, <marcandre.lureau@redhat.com> wrote:
>>
>> From: Marc-André Lureau <marcandre.lureau@redhat.com>
>>
>> Now that we merged into one doc, it makes the nav looks nicer.
>>
>> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
>> ---
>> docs/devel/index.rst | 4 ++--
>> docs/interop/index.rst | 4 ++--
>> docs/specs/index.rst | 4 ++--
>> docs/system/index.rst | 4 ++--
>> docs/tools/index.rst | 4 ++--
>> docs/user/index.rst | 4 ++--
>> 6 files changed, 12 insertions(+), 12 deletions(-)
>>
>> diff --git a/docs/devel/index.rst b/docs/devel/index.rst
>> index 7c424ea6d7..09d21d3514 100644
>> --- a/docs/devel/index.rst
>> +++ b/docs/devel/index.rst
>> @@ -1,8 +1,8 @@
>> .. This is the top level page for the 'devel' manual.
>>
>>
>> -QEMU Developer's Guide
>> -======================
>> +Developers
>> +==========
>
> I think this should be "Developer's Guide" or "Developer Information"
> or something. Just "Developers" doesn't really read right to me:
> it is not "documentation of developers" in the way that the "Tools"
> section is "documentation of tools", etc.
>
> thanks
> -- PMM
>
Changing it to a verb - "Development" - might fit the intent, by analogy
with "System Emulation Management and Interoperability", "System
Emulation", and "User Mode Emulation".
Keeping it as a noun with "Developer Information" or "Information for
Developers" also reads fine to me.
--js
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] docs: simplify each section title
2021-03-22 18:15 ` John Snow
@ 2021-03-22 19:48 ` Marc-André Lureau
0 siblings, 0 replies; 4+ messages in thread
From: Marc-André Lureau @ 2021-03-22 19:48 UTC (permalink / raw)
To: John Snow; +Cc: Peter Maydell, Daniel P. Berrange, QEMU Developers
[-- Attachment #1: Type: text/plain, Size: 1992 bytes --]
Hi
On Mon, Mar 22, 2021 at 10:23 PM John Snow <jsnow@redhat.com> wrote:
> On 3/22/21 12:36 PM, Peter Maydell wrote:
> > On Mon, 22 Mar 2021 at 16:03, <marcandre.lureau@redhat.com> wrote:
> >>
> >> From: Marc-André Lureau <marcandre.lureau@redhat.com>
> >>
> >> Now that we merged into one doc, it makes the nav looks nicer.
> >>
> >> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> >> ---
> >> docs/devel/index.rst | 4 ++--
> >> docs/interop/index.rst | 4 ++--
> >> docs/specs/index.rst | 4 ++--
> >> docs/system/index.rst | 4 ++--
> >> docs/tools/index.rst | 4 ++--
> >> docs/user/index.rst | 4 ++--
> >> 6 files changed, 12 insertions(+), 12 deletions(-)
> >>
> >> diff --git a/docs/devel/index.rst b/docs/devel/index.rst
> >> index 7c424ea6d7..09d21d3514 100644
> >> --- a/docs/devel/index.rst
> >> +++ b/docs/devel/index.rst
> >> @@ -1,8 +1,8 @@
> >> .. This is the top level page for the 'devel' manual.
> >>
> >>
> >> -QEMU Developer's Guide
> >> -======================
> >> +Developers
> >> +==========
> >
> > I think this should be "Developer's Guide" or "Developer Information"
> > or something. Just "Developers" doesn't really read right to me:
> > it is not "documentation of developers" in the way that the "Tools"
> > section is "documentation of tools", etc.
> >
> > thanks
> > -- PMM
> >
>
> Changing it to a verb - "Development" - might fit the intent, by analogy
> with "System Emulation Management and Interoperability", "System
> Emulation", and "User Mode Emulation".
>
> Keeping it as a noun with "Developer Information" or "Information for
> Developers" also reads fine to me.
>
>
It's a collection of developer's documents regrouped in a section. Maybe we
should consider a title like "Internals" instead? Tbh, I think "Developers"
was about right too.. "Guide" does not uphold its promise.
Ok, last call for "Developer Information" ?
--
Marc-André Lureau
[-- Attachment #2: Type: text/html, Size: 3104 bytes --]
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-03-22 19:50 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-22 15:50 [PATCH] docs: simplify each section title marcandre.lureau
2021-03-22 16:36 ` Peter Maydell
2021-03-22 18:15 ` John Snow
2021-03-22 19:48 ` Marc-André Lureau
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.