提交 3409c3b1 编写于 作者: W wusongqing

updated errors in contribute

Signed-off-by: Nwusongqing <wusongqing@huawei.com>
上级 7f331b1e
......@@ -897,9 +897,9 @@ Note: The sample code used in this article sees extensive use of the '//' post-c
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
......@@ -1483,7 +1483,7 @@ The number of parameters in a function must not exceed 5. If the number of param
## <a name="c5-3"></a>Inline Functions
An inline function is a function optimization method introduced by C99. Function inlining can eliminate the overhead of function calls; thanks to inlining, combination with the called code is implemented, so that the compiler can achieve further code optimization from a larger perspective. The inline function is similar to a function-like macro. For details, see [Rec 6.1](#a6-1).
An inline function is a function optimization method introduced by C99. Function inlining can eliminate the overhead of function calls; thanks to inlining, combination with the called code is implemented, so that the compiler can achieve further code optimization from a larger perspective. The inline function is similar to a function-like macro. For details, see [Rec 6.1](#rec-61-use-functions-instead-of-function-like-macros).
### <a name="a5-7"></a>Rec 5.7 Include no more than 10 lines in an inline function (excluding blank lines and comments).
......@@ -1548,8 +1548,8 @@ Before defining a function-like macro, consider whether it can be replaced with
The disadvantages of the function-like macro are as follows:
- Function-like macros haves no type check, which is not as strict as the function call check. For the example code, see [Below](#macro_lack_of_type_check__example).
- If macro parameters are not calculated during macro expansion, unexpected results may be generated. For details, see [Rule 6.1](#r6-1) and [Rule 6.3](#r6-3).
- A macro has no independent scope. When it is used together with control flow statements, unexpected results described in [Rule 6.2](#r6-2) may be generated.
- If macro parameters are not calculated during macro expansion, unexpected results may be generated. For details, see [Rule 6.1](#rule-61-use-complete-parentheses-for-macro-parameters-when-defining-a-macro) and [Rule 6.3](#rule-63-do-not-pass-expressions-with-side-effects-to-a-function-like-macro).
- A macro has no independent scope. When it is used together with control flow statements, unexpected results described in [Rule 6.2](#rule-62-place-implementation-statements-of-function-like-macros-that-contain-multiple-statements-in-a-do-while0) may be generated.
- There are high skill requirements on the proper use of macros (for example, the usage of `#` and wide use of parentheses), which reduces readability.
- Extensions of some macros can only be implemented by specific compilers in specific scenarios, such as `statement expression` of `gcc`, reducing the portability.
- After the macro is expanded during precompilation, it is invisible during subsequent compilation, linking, and debugging. Besides, macros that contain multiple lines are expanded into a line.
......
# Contributing Documents
# Contribution Guide
- [Contribution](contribution.md)
- [How to Contribute](how-to-contribute.md)
- [Code of Conduct](code-of-conduct.md)
- [Code Contribution](code-contribution.md)
- [Contribution Process](contribution-process.md)
......
# Contribution Guide
- [How to Contribute](how-to-contribute.md)
- [Code of Conduct](code-of-conduct.md)
- [Code Contribution](code-contribution.md)
- [Contribution Process](contribution-process.md)
- [FAQs](FAQ.md)
- [Documentation Contribution](documentation-contribution.md)
- [Writing Instructions](writing-instructions.md)
- [Communication in Community](communication-in-community.md)
......@@ -36,7 +36,7 @@ Perform the following steps to download the code in the repository to your compu
2. Clone the remote repository.
- You can copy the address of the remote repository on the repository page.
**Figure 1** <a name="fig1772512534014"></a>
![](figures/clone.png)
- Run the following command on the local host:
......@@ -185,9 +185,11 @@ Access the fork repository on Gitee, click the button for creating a PR, and sel
For details, visit [https://gitee.com/help/articles/4128](https://gitee.com/help/articles/4128).
>![](public_sys-resources/icon-notice.gif) **NOTICE:**
>![](public_sys-resources/icon-notice.gif) **NOTICE**
>
>**How do I create PRs at the same time if multiple code repositories have compilation dependencies?**
>During the development of the operating system \(OS\), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitee uses issues as the dependency identifiers for code repositories with compilation dependencies to commit the PRs. Follow the operations below:
>
>1. Create an issue in any of the code repositories.
>2. Associate PRs that need to be built and merged at the same time with the issue. For details, visit [https://gitee.com/help/articles/4142](https://gitee.com/help/articles/4142).
>3. After the build is triggered, the build center identifies the PRs associated with the same issue, downloads the build, and merges the PRs into the code library after the code is approved.
......@@ -237,5 +239,5 @@ Visit [CI portal](http://ci.openharmony.cn/#/pipeLine).
For details, visit [https://gitee.com/help/articles/4304](https://gitee.com/help/articles/4304).
Related topic: [FAQs](faqs.md)
Related topic: [FAQs](FAQ.md)
......@@ -26,7 +26,8 @@ Your feedback matters. Submit issues and leave as detailed information as possib
1. On the Gitee page, click the **Issues** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details.
2. Click **New** to submit the issue. The Docs team will confirm the issue.
>![](public_sys-resources/icon-note.gif) **Note:**
>![](public_sys-resources/icon-note.gif) **Note**
>
>**How can I provide a high-quality issue?**
>
>- Provide a clear description of the issue, including the missing, outdated, incorrect, or to-be-improved content.
......@@ -65,7 +66,7 @@ You are welcome to contribute documents to the release. For details, see [Writin
You are welcome to share your experience and expertise with other developers to help them get started. For example, you can contribute tutorials and FAQs by using the following templates:
- [Tutorial Template](template/tutorial-template.md.md)
- [FAQ Template](template/faq-template.md.md)
- [Tutorial Template](template/tutorial-template.md)
- [FAQ Template](template/faq-template.md)
More writing templates are available in the **contribute** folder in the **Docs** repository.
......@@ -75,9 +75,9 @@ For details, see [OpenHarmony Release Notes](release-notes/Readme.md).
## How to Contribute
A great open-source project wouldn't be possible without the hard work of many contributors. We'd like to invite anyone from around the world to [participate](contribute/contribution.md) in this exciting journey, and we're grateful for your time, passion, and efforts!
A great open-source project wouldn't be possible without the hard work of many contributors. We'd like to invite anyone from around the world to [participate](en/contribute/how-to-contribute.md) in this exciting journey, and we're grateful for your time, passion, and efforts!
You can evaluate available documents, make simple modifications, provide feedback on document quality, and contribute your original content. For details, see [Documentation Contribution](contribute/documentation-contribution.md).
You can evaluate available documents, make simple modifications, provide feedback on document quality, and contribute your original content. For details, see [Documentation Contribution](en/contribute/documentation-contribution.md).
Excellent contributors will be awarded and the contributions will be publicized in the developer community.
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册