From 5f146e508bd062817ac440abe47c43e9608b4025 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 3 Oct 2016 10:20:55 -0700 Subject: [PATCH] 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 Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) 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 @@ + +
+ Following Recipe Style Guidelines + + + When writing recipes, it is good to conform to existing + style guidelines. + The + OpenEmbedded Styleguide + wiki page provides rough guidelines for preferred recipe style. + + + + 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 + = operators in assignments or ordering + recipe components in an erratic way, are widely seen as poor + style. + +