Re: [PATCH] docs: move CODING_STYLE into the developer documentation

From: "Alex Bennée" <alex.bennee@linaro.org>
To: "Philippe Mathieu-Daudé" <philmd@redhat.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
	Thomas Huth <thuth@redhat.com>,
	"Daniel P . Berrange" <berrange@redhat.com>,
	QEMU Developers <qemu-devel@nongnu.org>,
	Stefan Hajnoczi <stefanha@redhat.com>
Subject: Re: [PATCH] docs: move CODING_STYLE into the developer documentation
Date: Tue, 23 Feb 2021 13:37:45 +0000	[thread overview]
Message-ID: <87lfbe51oy.fsf@linaro.org> (raw)
In-Reply-To: <5a1c4191-b0e6-8dcf-d5db-7335b5f41628@redhat.com>

Philippe Mathieu-Daudé <philmd@redhat.com> writes:

> On 2/23/21 12:29 PM, Philippe Mathieu-Daudé wrote:
>> On 2/23/21 12:07 PM, Peter Maydell wrote:
>>> On Tue, 23 Feb 2021 at 10:02, Alex Bennée <alex.bennee@linaro.org> wrote:
>>>>
>>>> There is no particular reason to keep this on it's own in the root of
>>>> the tree. Move it into the rest of the fine developer manual and fixup
>>>> any links to it. The only tweak I've made is to fix the code-block
>>>> annotations to mention the language C.
>>>>
>>>> Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
>>>> ---
>>>> diff --git a/README.rst b/README.rst
>>>> index ce39d89077..f5d41e59b1 100644
>>>> --- a/README.rst
>>>> +++ b/README.rst
>>>> @@ -66,7 +66,9 @@ When submitting patches, one common approach is to use 'git
>>>>  format-patch' and/or 'git send-email' to format & send the mail to the
>>>>  qemu-devel@nongnu.org mailing list. All patches submitted must contain
>>>>  a 'Signed-off-by' line from the author. Patches should follow the
>>>> -guidelines set out in the CODING_STYLE.rst file.
>>>> +guidelines set out in the `style section
>>>> +<https://qemu.readthedocs.io/en/latest/devel/style.html>` of
>>>> +the Developers Guide.
>>>
>>> This is the first instance of a qemu.readthedocs.io URL in the
>>> tree. Do we really want to have our references to our documentation
>>> be to a third party website ?
>> 
>> We can use https://www.qemu.org/docs/master/devel/style.html:
>> 
>> $ curl https://www.qemu.org/docs/master/devel/style.html
>> <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
>> <html><head>
>> <title>302 Found</title>
>> </head><body>
>> <h1>Found</h1>
>> <p>The document has moved <a
>> href="https://qemu.readthedocs.io/en/latest/devel/style.html">here</a>.</p>
>> </body></html>

I think if we treat the qemu.org domain as being the canonical URL and
then let it redirect where it wants. 

> Or even better since we have a job pushing to Gitlab pages
> accessible on https://qemu-project.gitlab.io/qemu/:
>
> https://qemu-project.gitlab.io/qemu/devel/style.html
>
> Maybe the https://www.qemu.org/docs/ redirect should
> go to gitlab page now?

It could do either, I think the result is exactly the same.

>
> Phil.

-- 
Alex Bennée