From: "Alex Bennée" <alex.bennee@linaro.org>
To: "Philippe Mathieu-Daudé" <philmd@redhat.com>
Cc: qemu-devel@nongnu.org, Peter Maydell <peter.maydell@linaro.org>,
"Daniel P . Berrange" <berrange@redhat.com>,
Markus Armbruster <armbru@redhat.com>,
Darren Kenny <darren.kenny@oracle.com>
Subject: Re: [PATCH-for-6.2? v2 1/5] docs/devel/style: Render C types as monospaced text
Date: Wed, 15 Dec 2021 14:20:54 +0000 [thread overview]
Message-ID: <874k7agd6b.fsf@linaro.org> (raw)
In-Reply-To: <20211118145716.4116731-2-philmd@redhat.com>
Philippe Mathieu-Daudé <philmd@redhat.com> writes:
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
> docs/devel/style.rst | 59 ++++++++++++++++++++++----------------------
> 1 file changed, 30 insertions(+), 29 deletions(-)
>
> diff --git a/docs/devel/style.rst b/docs/devel/style.rst
> index e00af62e763..3e519dc6ade 100644
> --- a/docs/devel/style.rst
> +++ b/docs/devel/style.rst
> @@ -111,7 +111,7 @@ Variables are lower_case_with_underscores; easy to type and read. Structured
> type names are in CamelCase; harder to type but standing out. Enum type
> names and function type names should also be in CamelCase. Scalar type
> names are lower_case_with_underscores_ending_with_a_t, like the POSIX
> -uint64_t and family. Note that this last convention contradicts POSIX
> +``uint64_t`` and family. Note that this last convention contradicts POSIX
> and is therefore likely to be changed.
>
> Variable Naming Conventions
> @@ -290,57 +290,57 @@ a few useful guidelines here.
> Scalars
> -------
>
> -If you're using "int" or "long", odds are good that there's a better type.
> -If a variable is counting something, it should be declared with an
> -unsigned type.
> +If you're using '``int``' or '``long``', odds are good that there's a
> better
We seem to be switching between quoted and unquoted ``types``. Are the
quotes really needed if they are also highlighted by the monospace font?
Either way:
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
next prev parent reply other threads:[~2021-12-15 15:34 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-18 14:57 [PATCH-for-6.2? v2 0/5] docs/devel/style: Improve rST rendering Philippe Mathieu-Daudé
2021-11-18 14:57 ` [PATCH-for-6.2? v2 1/5] docs/devel/style: Render C types as monospaced text Philippe Mathieu-Daudé
2021-12-15 14:20 ` Alex Bennée [this message]
2021-11-18 14:57 ` [PATCH-for-6.2? v2 2/5] docs/devel/style: Improve Error** functions rST rendering Philippe Mathieu-Daudé
2021-12-15 14:26 ` Alex Bennée
2021-11-18 14:57 ` [PATCH-for-6.2? v2 3/5] docs/devel/style: Improve string format " Philippe Mathieu-Daudé
2021-12-15 14:31 ` Alex Bennée
2021-11-18 14:57 ` [PATCH-for-6.2? v2 4/5] docs/devel/style: Render C function names as monospaced text Philippe Mathieu-Daudé
2021-12-15 14:36 ` Alex Bennée
2021-11-18 14:57 ` [PATCH-for-6.2? v2 5/5] docs/devel/style: Misc rST rendering improvements Philippe Mathieu-Daudé
2021-12-15 14:39 ` Alex Bennée
2021-11-18 15:32 ` [PATCH-for-6.2? v2 0/5] docs/devel/style: Improve rST rendering Darren Kenny
2021-12-15 10:33 ` Philippe Mathieu-Daudé
2021-12-15 14:39 ` Alex Bennée
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=874k7agd6b.fsf@linaro.org \
--to=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=darren.kenny@oracle.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.