Bug 10360

Summary:	Add link to the OpenEmbedded style guide
Product:	[Documentation] Development Manual	Reporter:	ulfalizer
Component:	development	Assignee:	Scott Rifenbark <srifenbark>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	Undecided	CC:	bluelightning, srifenbark
Version:	2.2
Target Milestone:	2.2 M4
Hardware:	x86
OS:	Multiple
Whiteboard:	03 Oct 2016: RESOLVED
OS type for building Yocto:	---	Type of Regression:	---
Verified:		Documentation change:	Done (doc changes complete)

Description ulfalizer 2016-10-01 14:12:19 UTC

Hello,

I think it would be helpful if the development manual linked to the
OpenEmbedded Styleguide wiki page. Here's a proposed new section:

  5.3.21. Recipe style

  The [OpenEmbedded Styleguide](http://www.openembedded.org/wiki/Styleguide)
  wiki page provides rough guidelines for preferred recipe style.

  It is common for existing recipes to deviate a bit from this style, but
  aiming for at least a consistent style is a good idea. Some practices, like
  omitting spaces around '=' in assignments or ordering recipe components in an
  erratic way, are widely seen as poor style.


As an unrelated nit, there's a missing " here:

  SRC_URI = "${DEBIAN_MIRROR}/main/a/apmd/apmd_3.2.2.orig.tar.gz;name=tarball \
             ${DEBIAN_MIRROR}/main/a/apmd/apmd_${PV}.diff.gz;name=patch


Cheers,
Ulf

Comment 1 Scott Rifenbark 2016-10-03 17:24:09 UTC

Ulf, 

Here is the new section - http://www.yoctoproject.org/docs/2.2/dev-manual/dev-manual.html#following-recipe-style-guidelines.

Here is the link to see the fix for the missing quote - http://www.yoctoproject.org/docs/2.2/dev-manual/dev-manual.html#new-recipe-fetching-code

Thanks, 
Scott

Comment 2 ulfalizer 2016-10-03 18:11:45 UTC

Looks good to me!

Thanks,
Ulf

Comment 3 Scott Rifenbark 2016-10-03 19:30:24 UTC

Thanks, 

Setting to RESOLOVED and putting the doc flag to "done."

Scott