sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Added new section on recipe style guidelines 

Fixes [YOCTO #10360]

Added a new section to reference into the OpenEmbedded Styleguide.
This will help people writing new recipes to conform to known
styles.

(From yocto-docs rev: 40c12742c78f5aba5bb4e43f759e8c478470fd83)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-10-03 10:20:55 -07:00 committed by Richard Purdie
parent 81698ab05d
commit 5f146e508b
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -3368,6 +3368,28 @@
</para>
</section>
</section>
<section id="following-recipe-style-guidelines">
<title>Following Recipe Style Guidelines</title>
<para>
When writing recipes, it is good to conform to existing
style guidelines.
The
<ulink url='http://www.openembedded.org/wiki/Styleguide'>OpenEmbedded Styleguide</ulink>
wiki page provides rough guidelines for preferred recipe style.
</para>
<para>
It is common for existing recipes to deviate a bit from this
style.
However, aiming for at least a consistent style is a good idea.
Some practices, such as omitting spaces around
<filename>=</filename> operators in assignments or ordering
recipe components in an erratic way, are widely seen as poor
style.
</para>
</section>
</section>
<section id="platdev-newmachine">