[v3,05/11] Rephrase section about constants

Submitted by Christophe de Dinechin on Feb. 8, 2018, 11:25 a.m.

Details

Message ID 20180208112531.19601-6-christophe@dinechin.org
State New
Headers show
Series "Updates to the style guide" ( rev: 2 1 ) in Spice

Not browsing as part of any series.

Commit Message

Christophe de Dinechin Feb. 8, 2018, 11:25 a.m.
From: Christophe de Dinechin <dinechin@redhat.com>

The indent of the rephrasing is that:

- If you have a single constant, use const, e.g. (visible in debugger)
    const unsigned max_stuff = 42;

- If you have multiple constants, prefer enums over #define, as
    already suggested later in the guide:
    enum {
       A = 0,
       B = 42,
       C = -1
    }

Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
---
 docs/spice_style.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Patch hide | download patch | download mbox

diff --git a/docs/spice_style.txt b/docs/spice_style.txt
index eef4880f..b92b5b00 100644
--- a/docs/spice_style.txt
+++ b/docs/spice_style.txt
@@ -131,7 +131,9 @@  Using goto is allowed in C code for error handling. In any other case it will be
 Defining Constant values
 ------------------------
 
-Use defines for constant values for improving readability and ease of changes. Alternatively, use global `const` variables.
+Use defines for constant values for improving readability and ease of changes.
+Alternatively, use global `const` variables for individual values.
+If multiple related constants are to be defined, consider the use of enumerations with initializers.
 
 Short functions
 ---------------