This changes the suggested style to what is currently used in
spice-server codebase. This also removes a few sentences which
are not really related to how one should format their header guards.

Signed-off-by: Christophe Fergeau <cferg...@redhat.com>
---
 docs/spice_style.txt | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/docs/spice_style.txt b/docs/spice_style.txt
index c8a4cff66..bc18b1d9e 100644
--- a/docs/spice_style.txt
+++ b/docs/spice_style.txt
@@ -365,12 +365,10 @@ Headers should be protected against multiple inclusion 
using a macro that contai
 
 ...
 
-#endif // MY_MODULE_H
+#endif /* MY_MODULE_H */
 ----
 
-The macro may include additional information, e.g. a component. For example a 
file generally referenced as foo/bar.h could use a FOO_BAR_H macro.
-
-Historically, some headers added underscores liberally, e.g. MY_MODULE_H_. 
This is neither necessary nor discouraged, although as a reminder, a leading 
underscore followed by a capital letter is reserved for the implementation and 
should not be used, so _MY_MODULE_H is, technically speaking, invalid C.
+C++ headers would use C++ comments.
 
 Header inclusion
 ----------------
-- 
2.14.3

_______________________________________________
Spice-devel mailing list
Spice-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/spice-devel

Reply via email to