[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] docs: move CODING_STYLE into the developer documentation
|
From: |
Philippe Mathieu-Daudé |
|
Subject: |
Re: [PATCH] docs: move CODING_STYLE into the developer documentation |
|
Date: |
Tue, 23 Feb 2021 12:29:07 +0100 |
|
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.7.0 |
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>
- [PATCH] docs: move CODING_STYLE into the developer documentation, Alex Bennée, 2021/02/23
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Claudio Fontana, 2021/02/23
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Peter Maydell, 2021/02/23
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation,
Philippe Mathieu-Daudé <=
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Philippe Mathieu-Daudé, 2021/02/23
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Alex Bennée, 2021/02/23
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Stefan Hajnoczi, 2021/02/24
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Daniel P . Berrangé, 2021/02/24
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Stefan Hajnoczi, 2021/02/24
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Daniel P . Berrangé, 2021/02/24
Re: [PATCH] docs: move CODING_STYLE into the developer documentation, Alex Bennée, 2021/02/23