diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index ee9331affa..bda509e9a0 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
| @@ -3368,6 +3368,28 @@ | |||
| 3368 | </para> | 3368 | </para> |
| 3369 | </section> | 3369 | </section> |
| 3370 | </section> | 3370 | </section> |
| 3371 | |||
| 3372 | <section id="following-recipe-style-guidelines"> | ||
| 3373 | <title>Following Recipe Style Guidelines</title> | ||
| 3374 | |||
| 3375 | <para> | ||
| 3376 | When writing recipes, it is good to conform to existing | ||
| 3377 | style guidelines. | ||
| 3378 | The | ||
| 3379 | <ulink url='http://www.openembedded.org/wiki/Styleguide'>OpenEmbedded Styleguide</ulink> | ||
| 3380 | wiki page provides rough guidelines for preferred recipe style. | ||
| 3381 | </para> | ||
| 3382 | |||
| 3383 | <para> | ||
| 3384 | It is common for existing recipes to deviate a bit from this | ||
| 3385 | style. | ||
| 3386 | However, aiming for at least a consistent style is a good idea. | ||
| 3387 | Some practices, such as omitting spaces around | ||
| 3388 | <filename>=</filename> operators in assignments or ordering | ||
| 3389 | recipe components in an erratic way, are widely seen as poor | ||
| 3390 | style. | ||
| 3391 | </para> | ||
| 3392 | </section> | ||
| 3371 | </section> | 3393 | </section> |
| 3372 | 3394 | ||
| 3373 | <section id="platdev-newmachine"> | 3395 | <section id="platdev-newmachine"> |
