From: Ian Jackson <ian.jackson@eu.citrix.com>
Date: Wed, 5 Nov 2014 14:26:59 +0000 (+0000)
Subject: libxl: CODING_STYLE: Mention function out parameters
X-Git-Tag: archive/raspbian/4.8.0-1+rpi1~1^2~4082
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=dbdd03d0ad4ad93f1db50341fac56a514c726552;p=xen.git

libxl: CODING_STYLE: Mention function out parameters

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>
---

diff --git a/tools/libxl/CODING_STYLE b/tools/libxl/CODING_STYLE
index 128cfea4ef..9a1d6e0933 100644
--- a/tools/libxl/CODING_STYLE
+++ b/tools/libxl/CODING_STYLE
@@ -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