diff options
| author | Mohammed Suhail Munshi <MohammedSuhail.Munshi@arm.com> | 2023-04-13 16:44:36 +0100 |
|---|---|---|
| committer | Mohmun02 <MohammedSuhail.Munshi@arm.com> | 2023-04-17 14:00:57 +0000 |
| commit | 99145f787e9e99b45522f16d861c8527583f2b4e (patch) | |
| tree | ba1e17615d9f0e1e1937112e7c35cf710d9c11b4 | |
| parent | b84df20f17f1fe8d098fb8531543c263541355de (diff) | |
| download | ComputeLibrary-99145f787e9e99b45522f16d861c8527583f2b4e.tar.gz | |
Update contibutor guidelines with rules for header guards
- Includes an example
Resolves: [COMPMID-5867]
Signed-off-by: Mohammed Suhail Munshi <MohammedSuhail.Munshi@arm.com>
Change-Id: I02c0cafecf56e9cbaf9e8284d43f8ef87af8f4d8
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/c/VisualCompute/ComputeLibrary/+/510081
Comments-Addressed: bsgcomp <bsgcomp@arm.com>
Tested-by: bsgcomp <bsgcomp@arm.com>
Reviewed-by: Viet-Hoa Do <viet-hoa.do@arm.com>
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/9441
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Pablo Marquez Tello <pablo.tello@arm.com>
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Benchmark: Arm Jenkins <bsgcomp@arm.com>
| -rw-r--r-- | docs/contributor_guide/contribution_guidelines.dox | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/contributor_guide/contribution_guidelines.dox b/docs/contributor_guide/contribution_guidelines.dox index d0287341b4..30ee41af0f 100644 --- a/docs/contributor_guide/contribution_guidelines.dox +++ b/docs/contributor_guide/contribution_guidelines.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2019-2022 Arm Limited. +/// Copyright (c) 2019-2023 Arm Limited. /// /// SPDX-License-Identifier: MIT /// @@ -240,6 +240,18 @@ class ClassName }; @endcode +- In header files, use header guards that use the full file path from the project root and prepend it with "ACL_" + +@code{cpp} +// For File arm_compute/runtime/NEON/functions/NEBatchNormalizationLayer.h +#ifndef ACL_ARM_COMPUTE_RUNTIME_NEON_FUNCTIONS_NEBATCHNORMALIZATIONLAYER +#define ACL_ARM_COMPUTE_RUNTIME_NEON_FUNCTIONS_NEBATCHNORMALIZATIONLAYER +. +. +. +#endif /* ACL_ARM_COMPUTE_RUNTIME_NEON_FUNCTIONS_NEBATCHNORMALIZATIONLAYER */ +@endcode + - Use quotes instead of angular brackets to include local headers. Use angular brackets for system headers. - Also include the module header first, then local headers, and lastly system headers. All groups should be separated by a blank line and sorted lexicographically within each group. - Where applicable the C++ version of system headers has to be included, e.g. cstddef instead of stddef.h. |