We don't use ifdefs in the main code.  Actually document this.

Signed-off-by: Ian Jackson <iwj@xenproject.org>
---
 tools/libs/light/CODING_STYLE | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/tools/libs/light/CODING_STYLE b/tools/libs/light/CODING_STYLE
index 3d572f6925..c2342c9d3b 100644
--- a/tools/libs/light/CODING_STYLE
+++ b/tools/libs/light/CODING_STYLE
@@ -121,6 +121,16 @@ permitted exceptions to the usual libxl code formatting rules.
 
 
 
+ARCHITECTURE-SPECIFIC CODE, CONDITIONAL COMPILATION
+---------------------------------------------------
+
+Architecture-specific code should be isolated in libxl_<arch>.c,
+with a function call interface, whereever possible.
+
+#ifdefs should be avoided, and in any case not interspersed through
+the primary functional code.
+
+
 IDEMPOTENT DATA STRUCTURE CONSTRUCTION/DESTRUCTION
 --------------------------------------------------
 
-- 
2.20.1

On Tue, Oct 12, 2021 at 03:52:26PM +0100, Ian Jackson wrote:
> We don't use ifdefs in the main code.  Actually document this.
> 
> Signed-off-by: Ian Jackson <iwj@xenproject.org>
> ---
>  tools/libs/light/CODING_STYLE | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/tools/libs/light/CODING_STYLE b/tools/libs/light/CODING_STYLE
> index 3d572f6925..c2342c9d3b 100644
> --- a/tools/libs/light/CODING_STYLE
> +++ b/tools/libs/light/CODING_STYLE
> @@ -121,6 +121,16 @@ permitted exceptions to the usual libxl code formatting rules.
>  
>  
>  
> +ARCHITECTURE-SPECIFIC CODE, CONDITIONAL COMPILATION
> +---------------------------------------------------
> +
> +Architecture-specific code should be isolated in libxl_<arch>.c,
> +with a function call interface, whereever possible.

s/whereever/wherever/ ?

> +
> +#ifdefs should be avoided, and in any case not interspersed through
> +the primary functional code.
> +
> +
>  IDEMPOTENT DATA STRUCTURE CONSTRUCTION/DESTRUCTION
>  --------------------------------------------------
>  

Sounds good,

Acked-by: Anthony PERARD <anthony.perard@citrix.com>

-- 
Anthony PERARD

Anthony PERARD writes ("Re: [PATCH] libxl: CODING_STYLE: Explicitly deprecate #ifdef"):
> On Tue, Oct 12, 2021 at 03:52:26PM +0100, Ian Jackson wrote:
> > +Architecture-specific code should be isolated in libxl_<arch>.c,
> > +with a function call interface, whereever possible.
> 
> s/whereever/wherever/ ?

Fixed, thanks.

> Acked-by: Anthony PERARD <anthony.perard@citrix.com>

Juergen Gross writes ("Re: [PATCH] libxl: CODING_STYLE: Explicitly deprecate #ifdef"):
> Reviewed-by: Juergen Gross <jgross@suse.com>

And committed.

Thanks,
Ian.

On 12.10.21 16:52, Ian Jackson wrote:
> We don't use ifdefs in the main code.  Actually document this.
> 
> Signed-off-by: Ian Jackson <iwj@xenproject.org>

Reviewed-by: Juergen Gross <jgross@suse.com>


Juergen