Layers FAQ - Revision history

PaulEggleton: Add info on submitting a bug

2023-02-23T20:45:38Z

Add info on submitting a bug

← Older revision		Revision as of 20:45, 23 February 2023
Line 70:		Line 70:
	=== How can I edit the entry for my layer? ===		=== How can I edit the entry for my layer? ===

	If you're already listed as one of the maintainers for the layer, you can create an account using the same email address as the maintainer entry, and once you log in you'll automatically be able to edit the entry (using the "Edit layer" button in the top right hand corner of the layer details page for the layer).		If you're already listed as one of the maintainers for the layer, you can create an account using the ''same email address'' as the maintainer entry, and once you log in you'll automatically be able to edit the entry (using the "Edit layer" button in the top right hand corner of the layer details page for the layer).

	Alternatively if you're not able to do this, please send an email to paul.eggleton@microsoft.com with your request.		Alternatively if you're not able to do this, please send an email to paul.eggleton@microsoft.com with your request.
Line 98:		Line 98:

	This is usually because the recipe failed to parse correctly when the layer index tried to process it. Note that the layer index update script will not set MACHINE or DISTRO to special values depending on the layer being parsed, so if parts of your layer fail to parse when these are set to other values then this will be a problem - ideally layers should still parse correctly no matter what the value of MACHINE or DISTRO is. Another cause of parse failures can be missing layer dependencies - ensure that all of the appropriate dependencies are listed against the layer in the index.		This is usually because the recipe failed to parse correctly when the layer index tried to process it. Note that the layer index update script will not set MACHINE or DISTRO to special values depending on the layer being parsed, so if parts of your layer fail to parse when these are set to other values then this will be a problem - ideally layers should still parse correctly no matter what the value of MACHINE or DISTRO is. Another cause of parse failures can be missing layer dependencies - ensure that all of the appropriate dependencies are listed against the layer in the index.

			=== How do I report an issue with the layer index? ===

			On the [https://lists.yoctoproject.org/g/yocto yocto mailing list], or if you have a concise description of a bug, please file it in the [http://bugzilla.yoctoproject.org Yocto Project bugzilla].

	=== I'd like to contribute improvements to the layer index code/design, how can I do that? ===		=== I'd like to contribute improvements to the layer index code/design, how can I do that? ===

PaulEggleton: Update my email address

2020-11-23T16:07:18Z

Update my email address

← Older revision		Revision as of 16:07, 23 November 2020
Line 72:		Line 72:
	If you're already listed as one of the maintainers for the layer, you can create an account using the same email address as the maintainer entry, and once you log in you'll automatically be able to edit the entry (using the "Edit layer" button in the top right hand corner of the layer details page for the layer).		If you're already listed as one of the maintainers for the layer, you can create an account using the same email address as the maintainer entry, and once you log in you'll automatically be able to edit the entry (using the "Edit layer" button in the top right hand corner of the layer details page for the layer).

	Alternatively if you're not able to do this, please send an email to paul.eggleton@~~linux.intel~~.com with your request.		Alternatively if you're not able to do this, please send an email to paul.eggleton@microsoft.com with your request.

	=== How do I choose the appropriate "layer type" for my layer? ===		=== How do I choose the appropriate "layer type" for my layer? ===

PaulEggleton: Remove gitorious reference

2017-06-22T13:55:37Z

Remove gitorious reference

← Older revision		Revision as of 13:55, 22 June 2017
Line 54:		Line 54:
	# '''Maintainer:''' If you are publishing the layer as a repository, ensure there is a commitment from at least one person to be the maintainer for the layer. The maintainer's role is to accept, review and (if satisfactory) merge patches from the community.		# '''Maintainer:''' If you are publishing the layer as a repository, ensure there is a commitment from at least one person to be the maintainer for the layer. The maintainer's role is to accept, review and (if satisfactory) merge patches from the community.
	# '''README:''' Ensure the layer has a README text file in the root which describes briefly what the layer is for, how to use it (if there are any special instructions), the other layers it depends upon, who it is maintained by, and most importantly where and how people should submit patches for it.		# '''README:''' Ensure the layer has a README text file in the root which describes briefly what the layer is for, how to use it (if there are any special instructions), the other layers it depends upon, who it is maintained by, and most importantly where and how people should submit patches for it.
	# '''Publish:''' Publish the layer in a place where it can be easily accessed. [http://git.yoctoproject.org/cgit/cgit.cgi/ git.yoctoproject.org] and [http://cgit.openembedded.org/cgit.cgi/ openembedded.org] can provide hosting, otherwise it is common to host layers on sites such as [http://github.org github~~] or [http://gitorious.org gitorious~~].		# '''Publish:''' Publish the layer in a place where it can be easily accessed. [http://git.yoctoproject.org/cgit/cgit.cgi/ git.yoctoproject.org] and [http://cgit.openembedded.org/cgit.cgi/ openembedded.org] can provide hosting, otherwise it is common to host layers on sites such as [http://github.org github].
	# '''Index:''' Submit the layer to the [http://layers.openembedded.org OpenEmbedded layer index].		# '''Index:''' Submit the layer to the [http://layers.openembedded.org OpenEmbedded layer index].
	# '''Announcement:''' Send an announcement to both of the following mailing lists telling people about the new layer:		# '''Announcement:''' Send an announcement to both of the following mailing lists telling people about the new layer:

PaulEggleton: Add link to OE-Classic section of the layer index

2017-03-14T02:32:27Z

Add link to OE-Classic section of the layer index

← Older revision		Revision as of 02:32, 14 March 2017
Line 86:		Line 86:
	Assuming you have searched the [http://layers.openembedded.org layer index] and haven't found anything, there are a few different avenues you can explore:		Assuming you have searched the [http://layers.openembedded.org layer index] and haven't found anything, there are a few different avenues you can explore:

	* You may be able to find an older version of the recipe in the [http://cgit.openembedded.org/cgit.cgi/openembedded OE-Classic git repository] which you can bring up-to-date by following [[Migrating metadata to OE-Core]].		* You may be able to find an older version of the recipe in the [http://cgit.openembedded.org/cgit.cgi/openembedded OE-Classic git repository] which you can bring up-to-date by following [[Migrating metadata to OE-Core]]. These recipes can also be found in the [http://layers.openembedded.org/layerindex/oe-classic/recipes/ OE-Classic] section in the layer index.
	* Try <code>devtool add</code> - this will attempt to automatically create a recipe for a given source tree and set up an environment where you can patch the source easily (which you often need to do when you're writing a recipe). See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#use-devtool-to-integrate-new-code Use devtool add to Integrate New Code] in the Yocto Project Development Manual.		* Try <code>devtool add</code> - this will attempt to automatically create a recipe for a given source tree and set up an environment where you can patch the source easily (which you often need to do when you're writing a recipe). See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#use-devtool-to-integrate-new-code Use devtool add to Integrate New Code] in the Yocto Project Development Manual.
	* Create your own recipe - it's usually not too difficult. See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#new-recipe-writing-a-new-recipe Writing a New Recipe] in the Yocto Project Development Manual for some instructions and examples. You may also find it useful to start by copying another recipe.		* Create your own recipe - it's usually not too difficult. See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#new-recipe-writing-a-new-recipe Writing a New Recipe] in the Yocto Project Development Manual for some instructions and examples. You may also find it useful to start by copying another recipe.

PaulEggleton: /* I'd like to contribute improvements to the layer index code/design, how can I do that? */

2016-10-26T02:59:13Z

I'd like to contribute improvements to the layer index code/design, how can I do that?

← Older revision		Revision as of 02:59, 26 October 2016
Line 101:		Line 101:
	=== I'd like to contribute improvements to the layer index code/design, how can I do that? ===		=== I'd like to contribute improvements to the layer index code/design, how can I do that? ===

	The code can be found on [http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/ git.yoctoproject.org]. It ~~is written in~~ Django and split into two parts - the web-based frontend that you interact with, and an update script that runs periodically to gather information about all of the layers in the database. There's further information in the README file on how to contribute.		The code can be found on [http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/ git.yoctoproject.org]. It uses the Django web framework and split into two parts - the web-based frontend that you interact with, and an update script that runs periodically to gather information about all of the layers in the database. There's further information in the README file on how to contribute.

	[[Category:FAQ]]		[[Category:FAQ]]

PaulEggleton: Add question on layer index contributions

2016-10-26T02:57:43Z

Add question on layer index contributions

← Older revision		Revision as of 02:57, 26 October 2016
Line 98:		Line 98:

	This is usually because the recipe failed to parse correctly when the layer index tried to process it. Note that the layer index update script will not set MACHINE or DISTRO to special values depending on the layer being parsed, so if parts of your layer fail to parse when these are set to other values then this will be a problem - ideally layers should still parse correctly no matter what the value of MACHINE or DISTRO is. Another cause of parse failures can be missing layer dependencies - ensure that all of the appropriate dependencies are listed against the layer in the index.		This is usually because the recipe failed to parse correctly when the layer index tried to process it. Note that the layer index update script will not set MACHINE or DISTRO to special values depending on the layer being parsed, so if parts of your layer fail to parse when these are set to other values then this will be a problem - ideally layers should still parse correctly no matter what the value of MACHINE or DISTRO is. Another cause of parse failures can be missing layer dependencies - ensure that all of the appropriate dependencies are listed against the layer in the index.

			=== I'd like to contribute improvements to the layer index code/design, how can I do that? ===

			The code can be found on [http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/ git.yoctoproject.org]. It is written in Django and split into two parts - the web-based frontend that you interact with, and an update script that runs periodically to gather information about all of the layers in the database. There's further information in the README file on how to contribute.

	[[Category:FAQ]]		[[Category:FAQ]]

PaulEggleton: create-recipe is dead, long live devtool / recipetool

2016-07-12T04:55:22Z

create-recipe is dead, long live devtool / recipetool

← Older revision		Revision as of 04:55, 12 July 2016
Line 87:		Line 87:

	* You may be able to find an older version of the recipe in the [http://cgit.openembedded.org/cgit.cgi/openembedded OE-Classic git repository] which you can bring up-to-date by following [[Migrating metadata to OE-Core]].		* You may be able to find an older version of the recipe in the [http://cgit.openembedded.org/cgit.cgi/openembedded OE-Classic git repository] which you can bring up-to-date by following [[Migrating metadata to OE-Core]].
	* Try ~~the~~ <code>~~create-recipe~~</code> ~~tool~~ (~~scripts~~/~~create~~-~~recipe)~~. ~~It's not particularly sophisticated but at~~ the ~~very least it can give you a skeleton you can start from~~.		* Try <code>devtool add</code> - this will attempt to automatically create a recipe for a given source tree and set up an environment where you can patch the source easily (which you often need to do when you're writing a recipe). See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#use-devtool-to-integrate-new-code Use devtool add to Integrate New Code] in the Yocto Project Development Manual.
	* Create your own recipe - it's usually not too difficult. See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#new-recipe-writing-a-new-recipe Writing a New Recipe] in the Yocto Project Development Manual for some instructions and examples. You may also find it useful to start by copying another recipe.		* Create your own recipe - it's usually not too difficult. See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#new-recipe-writing-a-new-recipe Writing a New Recipe] in the Yocto Project Development Manual for some instructions and examples. You may also find it useful to start by copying another recipe.
	* Ask the community on the mailing list if anyone has/is planning on writing the recipe.		* Ask the community on the mailing list if anyone has/is planning on writing the recipe.

PaulEggleton: /* Can I overlay/append an inc file from another layer in my layer? */ extend possible solutions

2015-02-19T11:28:57Z

Can I overlay/append an inc file from another layer in my layer?: extend possible solutions

← Older revision		Revision as of 11:28, 19 February 2015
Line 43:		Line 43:
	=== Can I overlay/append an inc file from another layer in my layer? ===		=== Can I overlay/append an inc file from another layer in my layer? ===

	No, ~~you can't;~~ inc files aren't handled in the same manner as .bb and .bbappend files. The ~~best way~~ to ~~handle~~ this ~~is to~~ bbappend each recipe that includes the inc file.		There is no mechanism for this, no - inc files aren't handled in the same manner as .bb and .bbappend files. The possible solutions if you find you need to do this:
			* bbappend each recipe that includes the inc file (and you can use % as a wildcard, for example <code>meta-yocto/recipes-core/busybox/busybox_%.bbappend</code>)
			* Get an appropriate fix into the inc file itself - which may be adding a variable so that you can select the behaviour you want externally

	=== I've just created a new layer and would like to publish it for the community. What should I do? ===		=== I've just created a new layer and would like to publish it for the community. What should I do? ===

PaulEggleton: Update YP manual link for Writing a New Recipe

2014-04-29T16:12:30Z

Update YP manual link for Writing a New Recipe

← Older revision		Revision as of 16:12, 29 April 2014
Line 86:		Line 86:
	* You may be able to find an older version of the recipe in the [http://cgit.openembedded.org/cgit.cgi/openembedded OE-Classic git repository] which you can bring up-to-date by following [[Migrating metadata to OE-Core]].		* You may be able to find an older version of the recipe in the [http://cgit.openembedded.org/cgit.cgi/openembedded OE-Classic git repository] which you can bring up-to-date by following [[Migrating metadata to OE-Core]].
	* Try the <code>create-recipe</code> tool (scripts/create-recipe). It's not particularly sophisticated but at the very least it can give you a skeleton you can start from.		* Try the <code>create-recipe</code> tool (scripts/create-recipe). It's not particularly sophisticated but at the very least it can give you a skeleton you can start from.
	* Create your own recipe - it's usually not too difficult. See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#~~usingpoky~~-~~extend~~-~~addpkg Adding~~ a ~~Package~~] in the Yocto Project Development Manual for some instructions and examples. You may also find it useful to start by copying another recipe.		* Create your own recipe - it's usually not too difficult. See [http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#new-recipe-writing-a-new-recipe Writing a New Recipe] in the Yocto Project Development Manual for some instructions and examples. You may also find it useful to start by copying another recipe.
	* Ask the community on the mailing list if anyone has/is planning on writing the recipe.		* Ask the community on the mailing list if anyone has/is planning on writing the recipe.

PaulEggleton: Add entry about blank fields

2013-06-12T12:12:47Z

Add entry about blank fields

← Older revision		Revision as of 12:12, 12 June 2013
Line 92:		Line 92:

	Currently, the update script runs once every three hours, fetching the latest version of every repository and updating the index for any changes.		Currently, the update script runs once every three hours, fetching the latest version of every repository and updating the index for any changes.

			=== A recipe in my layer has blank values for some fields even though they are specified in the recipe, why is this? ===

			This is usually because the recipe failed to parse correctly when the layer index tried to process it. Note that the layer index update script will not set MACHINE or DISTRO to special values depending on the layer being parsed, so if parts of your layer fail to parse when these are set to other values then this will be a problem - ideally layers should still parse correctly no matter what the value of MACHINE or DISTRO is. Another cause of parse failures can be missing layer dependencies - ensure that all of the appropriate dependencies are listed against the layer in the index.

	[[Category:FAQ]]		[[Category:FAQ]]