qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: Thomas Huth <thuth@redhat.com>, qemu-devel@nongnu.org
Cc: qemu-trivial@nongnu.org, Peter Maydell <peter.maydell@linaro.org>
Subject: Re: [PATCH] README: Add Documentation blurb
Date: Thu, 4 Feb 2021 19:49:39 -0500	[thread overview]
Message-ID: <9d31519b-76ca-38a7-4c26-06c98d4d578b@redhat.com> (raw)
In-Reply-To: <16d9f8d6-170d-633e-6c52-a6f3ee1de6fb@redhat.com>

On 2/4/21 9:07 AM, Thomas Huth wrote:
> On 04/11/2020 20.30, John Snow wrote:
>> Add it in a prominent place: Right after figuring out what QEMU is,
>> users may wish to know how to use it more than they want to know how to
>> build their own version of it.
>>
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   README.rst | 11 +++++++++++
>>   1 file changed, 11 insertions(+)
>>
>> diff --git a/README.rst b/README.rst
>> index 58b9f2dc15c4..758ea8fd2ff0 100644
>> --- a/README.rst
>> +++ b/README.rst
>> @@ -31,6 +31,17 @@ QEMU as a whole is released under the GNU General 
>> Public License,
>>   version 2. For full licensing details, consult the LICENSE file.
>> +Documentation
>> +=============
>> +
>> +Documentation can be found hosted online at
>> +`<https://www.qemu.org/documentation/>`_. The documentation for the
>> +current development version that is available at
>> +`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
> 
> That URL is now redirecting to https://qemu.readthedocs.io/en/latest/ 
> ... could you maybe update your patch and resend?
> 
>   Thanks,
>    Thomas

does "v: latest" on readthedocs mean 5.2.0 or the current development 
head? Looks like the current development head.

https://www.qemu.org/documentation/ points to /docs/master, which is why 
I took that link. Is it worth updating that link, too? The website in 
particular should be rephrased to point to the latest stable release 
docs as a default, I suspect.

The README should probably keep pointing to the latest development docs.

--js



      reply	other threads:[~2021-02-05  0:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-04 19:30 [PATCH] README: Add Documentation blurb John Snow
2021-02-04 14:07 ` Thomas Huth
2021-02-05  0:49   ` John Snow [this message]

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=9d31519b-76ca-38a7-4c26-06c98d4d578b@redhat.com \
    --to=jsnow@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-trivial@nongnu.org \
    --cc=thuth@redhat.com \
    /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).