github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-29 16:58:10 +00:00
Code Issues Projects Releases Wiki Activity

doc: update coding guidelines

Browse Source 
This patch updates coding guidelines about legal entity.

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
This commit is contained in:
Shiqing Gao 2019-05-14 09:33:25 +08:00 committed by David Kinder
parent 04ccaacb9c
commit 7e52067575
2 changed files with 70 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/developer-guides/asm_coding_guidelines.rst
View File

@ -704,6 +704,41 @@ Compliant example::
/* This is a comment. This is a comment. This is a comment. This is a comment. This is a comment. This is a comment. This is a comment. */ /* This is a comment. This is a comment. This is a comment. This is a comment. This is a comment. This is a comment. This is a comment. */
ASM-CS-08: Legal entity shall be documented in every file
=========================================================
Legal entity shall be documented in a separate comments block at the start of
every file.
The following information shall be included:
a) Copyright
b) License (using an `SPDX-License-Identifier <https://spdx.org/licenses/>`_)
Compliant example::
/* Legal entity shall be placed at the start of the file. */
-------------File Contents Start After This Line------------
/*
* Copyright (C) 2019 Intel Corporation.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/* Coding or implementation related comments start after the legal entity. */
.code64
.. rst-class:: non-compliant-code
Non-compliant example::
/* Neither copyright nor license information is included in the file. */
-------------------File Contents Start After This Line------------------
/* Coding or implementation related comments start directly. */
.code64
Naming Convention Naming Convention
***************** *****************

35
doc/developer-guides/c_coding_guidelines.rst
View File

@ -3286,6 +3286,41 @@ Compliant example::
int32_t func_showcase(uint32_t *param_1, uint32_t param_2, uint32_t param_3); int32_t func_showcase(uint32_t *param_1, uint32_t param_2, uint32_t param_3);
C-CS-19: Legal entity shall be documented in every file
=======================================================
Legal entity shall be documented in a separate comments block at the start of
every file.
The following information shall be included:
a) Copyright
b) License (using an `SPDX-License-Identifier <https://spdx.org/licenses/>`_)
Compliant example::
/* Legal entity shall be placed at the start of the file. */
-------------File Contents Start After This Line------------
/*
* Copyright (C) 2019 Intel Corporation.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/* Coding or implementation related comments start after the legal entity. */
#include <types.h>
.. rst-class:: non-compliant-code
Non-compliant example::
/* Neither copyright nor license information is included in the file. */
-------------------File Contents Start After This Line------------------
/* Coding or implementation related comments start directly. */
#include <types.h>
Naming Convention Naming Convention
***************** *****************