diff --git a/doc/developer-guides/asm_coding_guidelines.rst b/doc/developer-guides/asm_coding_guidelines.rst index 82514d66f..936757b36 100644 --- a/doc/developer-guides/asm_coding_guidelines.rst +++ b/doc/developer-guides/asm_coding_guidelines.rst @@ -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. */ +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 `_) + +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 ***************** diff --git a/doc/developer-guides/c_coding_guidelines.rst b/doc/developer-guides/c_coding_guidelines.rst index 92ab8e522..eb589ee89 100644 --- a/doc/developer-guides/c_coding_guidelines.rst +++ b/doc/developer-guides/c_coding_guidelines.rst @@ -3286,6 +3286,41 @@ Compliant example:: 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 `_) + +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 + +.. 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 + + Naming Convention *****************