[Spice-devel] [PATCH] style: add some documentation for names

[Frediano Ziglio]

Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
---
 docs/spice_style.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/spice_style.txt b/docs/spice_style.txt
index b042d79..957e017 100644
--- a/docs/spice_style.txt
+++ b/docs/spice_style.txt
@@ -131,6 +131,21 @@ Names
 * Structures, class and enum names - one or more words, each word start with upper case (e.g., Name, SampleStructName)
 * Defines and enum items names - uppercase words separated using underscores (e.g., NAME, SAMPLE_DEFINE_NAME)
 
+Type prefix
+~~~~~~~~~~~
+In the code there are some common prefixes for types, `Red` and `Spice`.
+As a basic rule `Spice` refers to types in the public external headers while `Red` is used for internal types.
+
+Common abbreviations
+~~~~~~~~~~~~~~~~~~~~
+`rcc` RedChannelClient
+
+`dcc` DisplayChannelClient
+
+`sin` spice instance
+
+`sif` spice interface
+
 Optimization
 ------------
 
-- 
2.7.4