From: "Daniel P. Berrangé" <berrange@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Alex Bennée" <alex.bennee@linaro.org>,
"Daniel P. Berrangé" <berrange@redhat.com>
Subject: [Qemu-devel] [PATCH 4/4] docs: add table of contents to CODING_STYLE.md
Date: Fri, 23 Aug 2019 17:39:31 +0100 [thread overview]
Message-ID: <20190823163931.7442-5-berrange@redhat.com> (raw)
In-Reply-To: <20190823163931.7442-1-berrange@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
CODING_STYLE.md | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/CODING_STYLE.md b/CODING_STYLE.md
index f37b6c2d01..0841edb2f7 100644
--- a/CODING_STYLE.md
+++ b/CODING_STYLE.md
@@ -1,6 +1,37 @@
QEMU Coding Style
=================
+#### Table Of Contents
+
+ * [Whitespace](#whitespace)
+ + [Multiline Indent](#multiline-indent)
+ * [Line width](#line-width)
+ * [Naming](#naming)
+ * [Block structure](#block-structure)
+ * [Declarations](#declarations)
+ * [Conditional statements](#conditional-statements)
+ * [Comment style](#comment-style)
+ * [trace-events style](#trace-events-style)
+ + [0x prefix](#0x-prefix)
+ + ['#' printf flag](#----printf-flag)
+ * [Preprocessor](#preprocessor)
+ + [Variadic macros](#variadic-macros)
+ + [Include directives](#include-directives)
+ * [C types](#c-types)
+ + [Scalars](#scalars)
+ + [Pointers](#pointers)
+ + [Typedefs](#typedefs)
+ + [Reserved namespaces in C and POSIX](#reserved-namespaces-in-c-and-posix)
+ * [Low level memory management](#low-level-memory-management)
+ * [String manipulation](#string-manipulation)
+ * [Printf-style functions](#printf-style-functions)
+ * [C standard, implementation defined and undefined behaviors](#c-standard--implementation-defined-and-undefined-behaviors)
+ * [Error handling and reporting](#error-handling-and-reporting)
+ + [Reporting errors to the human user](#reporting-errors-to-the-human-user)
+ + [Propagating errors](#propagating-errors)
+ + [Handling errors](#handling-errors)
+ * [Automatic memory deallocation](#automatic-memory-deallocation)
+
Please use the script checkpatch.pl in the scripts directory to check
patches before submitting.
--
2.21.0
next prev parent reply other threads:[~2019-08-23 16:43 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-23 16:39 [Qemu-devel] [PATCH 0/4] docs: add docs about use of automatic cleanup functions Daniel P. Berrangé
2019-08-23 16:39 ` [Qemu-devel] [PATCH 1/4] docs: convert CODING_STYLE and HACKING to markdown syntax Daniel P. Berrangé
2019-08-28 12:25 ` Alex Bennée
2019-08-28 13:08 ` Daniel P. Berrangé
2019-08-23 16:39 ` [Qemu-devel] [PATCH 2/4] docs: merge HACKING.md contents into CODING_STYLE.md Daniel P. Berrangé
2019-08-23 19:35 ` Eric Blake
2019-08-28 15:06 ` Alex Bennée
2019-08-28 15:10 ` Daniel P. Berrangé
2019-08-23 16:39 ` [Qemu-devel] [PATCH 3/4] docs: document use of automatic cleanup functions in glib Daniel P. Berrangé
2019-08-23 19:53 ` Eric Blake
2019-08-28 9:00 ` Stefan Hajnoczi
2019-08-28 15:14 ` Alex Bennée
2019-08-28 15:20 ` Daniel P. Berrangé
2019-08-28 16:04 ` Alex Bennée
2019-08-23 16:39 ` Daniel P. Berrangé [this message]
2019-08-23 21:48 ` [Qemu-devel] [PATCH 0/4] docs: add docs about use of automatic cleanup functions Marc-André Lureau
2019-08-28 12:30 ` Alex Bennée
2019-08-28 13:07 ` Daniel P. Berrangé
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=20190823163931.7442-5-berrange@redhat.com \
--to=berrange@redhat.com \
--cc=alex.bennee@linaro.org \
--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 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).