[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] docs: move CODING_STYLE into the developer documentation
From: |
Alex Bennée |
Subject: |
Re: [PATCH] docs: move CODING_STYLE into the developer documentation |
Date: |
Tue, 23 Feb 2021 12:03:43 +0000 |
User-agent: |
mu4e 1.5.8; emacs 28.0.50 |
Peter Maydell <peter.maydell@linaro.org> writes:
> 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 ?
Well I browsed to:
https://www.qemu.org/docs/master/
which re-directed me to the readthedocs URL. However it looks like:
https://www.qemu.org/docs/master/devel/index.html
DTRT so I can fix that.
>
> thanks
> -- PMM
--
Alex Bennée
- Re: [PATCH] docs: move CODING_STYLE into the developer documentation, (continued)
- 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é, 2021/02/23
- 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 <=