libxl: CODING_STYLE: Mention function out parameters
authorIan Jackson <ian.jackson@eu.citrix.com>
Wed, 5 Nov 2014 14:26:59 +0000 (14:26 +0000)
committerIan Jackson <Ian.Jackson@eu.citrix.com>
Tue, 18 Nov 2014 14:51:55 +0000 (14:51 +0000)
We seem to use both `_r' and `_out'.  Document both.

Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Acked-by: Wei Liu <wei.liu2@citrix.com>
Release-Acked-by: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
tools/libxl/CODING_STYLE

index 128cfea4ef6f4afb57091a174736093dc54d0aa5..9a1d6e093332df678a7b34b76bca7571aced337c 100644 (file)
@@ -241,6 +241,9 @@ Local variables used to store return values should have descriptive name
 like "rc" or "ret". Following the same reasoning the label used as exit
 path should be called "out".
 
+Function arguments which are used to return values to the caller
+should be suffixed `_r' or `_out'.
+
 Variables, type names and function names are
 lower_case_with_underscores.
 Type names and function names use the prefix libxl__ when internal to