From: Stefano Stabellini <stefano.stabellini@xilinx.com>
Date: Wed, 1 Jun 2022 01:44:02 +0000 (-0700)
Subject: docs/misra: add Rule 5.1
X-Git-Tag: archive/raspbian/4.17.0-1+rpi1^2~33^2~604
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=8c1cc69748f4719e6ba8a275c2ecd60747c52c21;p=xen.git

docs/misra: add Rule 5.1

Add Rule 5.1, with the additional note that the character limit for Xen
is 40 characters.

The max length identifiers found by ECLAIR are:

__mitigate_spectre_bhb_clear_insn_start
domain_pause_by_systemcontroller_nosync

Both of them are 40 characters long.

Explicitly mention that public headers might have longer identifiers.

Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
Acked-by: Julien Grall <jgrall@amazon.com>
---

diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index 7d6a9fe063..6ccff07765 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -82,6 +82,13 @@ existing codebase are work-in-progress.
      - Line-splicing shall not be used in // comments
      -
 
+   * - `Rule 5.1 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_05_01_2.c>`_
+     - Required
+     - External identifiers shall be distinct
+     - The Xen characters limit for identifiers is 40. Public headers
+       (xen/include/public/) are allowed to retain longer identifiers
+       for backward compatibility.
+
    * - `Rule 6.2 <https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_06_02.c>`_
      - Required
      - Single-bit named bit fields shall not be of a signed type