[v4,11/12] Point out that the coding style is for all SPICE components

Submitted by Christophe de Dinechin on Feb. 15, 2018, 4:06 p.m.

Details

Message ID 20180215160625.75406-12-christophe@dinechin.org
State New
Headers show
Series "Updates to the style guide" ( rev: 3 ) in Spice

Not browsing as part of any series.

Commit Message

Christophe de Dinechin Feb. 15, 2018, 4:06 p.m.
From: Christophe de Dinechin <dinechin@redhat.com>

Historically, the coding style was created in the server component, and
that's where it's built from. However, it applies also to other components,
and is presently being reworked in large part because of the introduction of
a large amount of C++ in the streaming agent.

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

Patch hide | download patch | download mbox

diff --git a/docs/spice_style.txt b/docs/spice_style.txt
index 4c29a410..13bd3809 100644
--- a/docs/spice_style.txt
+++ b/docs/spice_style.txt
@@ -34,6 +34,9 @@  another. For example, we prefer methods with snake_names instead of
 CamelCase, because that's the SPICE C style for functions. Similarly,
 we prefer CamelCase for classes because that's the SPICE C style for structs.
 
+The coding style described here, while hosted in the server code for historical reasons,
+applies to all SPICE components.
+
 This style guide only indicates what we aim to achieve. It does not
 necessarily reflect the current state of the code. Consistency matters.
 It may be preferable to ignore a guideline documented here if it helps