Signed-off-by: Mike Holmes <[email protected]> --- CONTRIBUTING | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING b/CONTRIBUTING index 75fb711..4ad964e 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 -- 2.5.0 _______________________________________________ lng-odp mailing list [email protected] https://lists.linaro.org/mailman/listinfo/lng-odp
