diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2015-11-18 11:03:48 -0500 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-11-20 17:31:42 +0300 |
| commit | fa4c0972ca651116b7e02be0c8954238cacaf5c7 (patch) | |
| tree | d44dc47c92c29602ea3b60441ed9088d473a2c71 /CONTRIBUTING | |
| parent | 605ed61bc0ecb885ff616e7ba4881d1a80cd9b3c (diff) | |
CONTRIBUTING: add user doc guidelines
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'CONTRIBUTING')
| -rw-r--r-- | CONTRIBUTING | 33 |
1 files changed, 31 insertions, 2 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index 75fb711f1..4ad964e49 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -7,7 +7,8 @@ Table of content: 2. ODP patch expectations as an open source project 3. Common Errors in Patch and Commit Messages 4. Documenting the code -5. References +5. Documenting the user docs +6. References 1. New Development ------------------ @@ -103,7 +104,35 @@ Code without a proper signoff cannot be merged into the mainline. - Functions return values should all be specified using @return or @retval - There should be no doxygen warnings or errors generated. -5. References +5. Documenting the user docs +---------------------------- +- Users guides are stored in asciidoc format in the odp/docs directory and in + sub directories of it as appropriate. +- ODP code references such as types and enums are highlighted using the + + syntax. For example text referring to the type odp_pktio_t would decorate the + type thus:- + +odp_pktio_t+ +- Section heading use the = syntax. For example:- + == Level 1 + Text. + + === Level 2 + Text. +- Code and scripting excerpts are decorated with the block syntax:- + .Optional Title + [source,perl] + ---- + <code here> + ---- +- Images are decorated with :- + .Optional Title + image::../images/<image name>.png[align="center"] +- The images are stored in the doc/images directory as svg files and rendered as + png and eps during the build process. +- Body text shall wrap at the 80 char point. +- No warnings may be generated by the asciidoc tool. + +6. References ------------- [1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle [2] http://ldn.linuxfoundation.org/book/how-participate-linux-community |