Re: [Qemu-devel] [PATCH 2/4] docs: merge HACKING.md contents into CODING_STYLE.md

[Alex Bennée]

Eric Blake <address@hidden> 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é <address@hidden>
>> ---
>>  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