QEMU-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: Eric Blake <eblake@redhat.com>
Cc: "Daniel P. Berrangé" <berrange@redhat.com>, qemu-devel@nongnu.org
Subject: Re: [Qemu-devel] [PATCH 2/4] docs: merge HACKING.md contents into CODING_STYLE.md
Date: Wed, 28 Aug 2019 16:06:20 +0100
Message-ID: <87a7bt5nyr.fsf@linaro.org> (raw)
In-Reply-To: <3345a7e9-c0de-78d8-4656-0255fa1e34fd@redhat.com>


Eric Blake <eblake@redhat.com> writes:

> On 8/23/19 11:39 AM, Daniel P. Berrangé wrote:
>> The split of information between the two docs is rather arbitary and
>> unclear. It is simpler for contributors if all the information is in
>> one file.
>>
>> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
>> ---
>>  CODING_STYLE.md | 262 +++++++++++++++++++++++++++++++++++++++++++++++
>>  HACKING.md      | 263 ------------------------------------------------
>>  README          |   2 +-
>>  3 files changed, 263 insertions(+), 264 deletions(-)
>>  delete mode 100644 HACKING.md
>
> Is it worth trying to group related sections as part of the combination?
>  (Your solution of just concatenating at the end is obviously the
> fastest, but may result in odd ordering where similar things are
> mentioned twice but in different parts of the file).

It is a bit all over the place, but just moving trace-events and
automatic memory de-allocation we could group it like this:

Formatting and style:

  * [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)

Language usage:

  * [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)
  * [Automatic memory deallocation](#automatic-memory-deallocation)

QEMU Specific Idioms

  * [trace-events style](#trace-events-style)
    + [0x prefix](#0x-prefix)
    + ['#' printf flag](#----printf-flag)
  * [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)


--
Alex Bennée


  reply index

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 [this message]
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 ` [Qemu-devel] [PATCH 4/4] docs: add table of contents to CODING_STYLE.md Daniel P. Berrangé
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 publically 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=87a7bt5nyr.fsf@linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=berrange@redhat.com \
    --cc=eblake@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

QEMU-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/qemu-devel/0 qemu-devel/git/0.git
	git clone --mirror https://lore.kernel.org/qemu-devel/1 qemu-devel/git/1.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 qemu-devel qemu-devel/ https://lore.kernel.org/qemu-devel \
		qemu-devel@nongnu.org
	public-inbox-index qemu-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.nongnu.qemu-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git