qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] docs: simplify each section title


From: John Snow
Subject: Re: [PATCH] docs: simplify each section title
Date: Mon, 22 Mar 2021 14:15:57 -0400
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.8.0

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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]