Layer Publishing Guide - Revision history

PaulEggleton: Replace with a link to the OE Layers FAQ

2015-01-19T10:54:36Z

Replace with a link to the OE Layers FAQ

← Older revision		Revision as of 10:54, 19 January 2015
Line 1:		Line 1:
	~~{\| style="color:black; background-color:#ffcccc;" cellpadding="10" class="wikitable"~~		See [http://www.openembedded.org/Layers_FAQ#I.27ve_just_created_a_new_layer_and_would_like_to_publish_it_for_the_community._What_should_I_do.3F this entry] in the OE layers FAQ.
	~~\|'''Note: this page is a draft and is not yet complete.'''~~
	\|}

	~~There are a few important steps you should take in order to publish a layer for the community:~~

	# '''Existing layers:''' Ideally, ensure your layer does not overlap with other layers. If there must be an overlap and it is not practical to resolve it with the maintainer of the existing layer(s), document what the overlap is and why it is there.
	# '''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, 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].~~
	# ~~'''Announcement:''' Send an announcement to both of the following mailing lists telling people about the new layer:~~
	~~#* yocto@yoctoproject~~.~~org ([http://lists~~.~~yoctoproject~~.~~org/listinfo/yocto list info~~])
	~~#* openembedded-devel@lists.openembedded.org ([http://lists.linuxtogo.org/pipermail/openembedded-devel/ list info])~~
	~~# '''Index:''' Add~~ the ~~layer to the [http://www.openembedded.org/wiki/LayerIndex OpenEmbedded layer index]~~.

PaulEggleton: Created page with "{| style="color:black; background-color:#ffcccc;" cellpadding="10" class="wikitable" |'''Note: this page is a draft and is not yet complete.''' |} There are a few important step..."

2012-07-12T10:16:57Z

Created page with "{| style="color:black; background-color:#ffcccc;" cellpadding="10" class="wikitable" |'''Note: this page is a draft and is not yet complete.''' |} There are a few important step..."

New page

{| style="color:black; background-color:#ffcccc;" cellpadding="10" class="wikitable"
|'''Note: this page is a draft and is not yet complete.'''
|}

There are a few important steps you should take in order to publish a layer for the community:

# '''Existing layers:''' Ideally, ensure your layer does not overlap with other layers. If there must be an overlap and it is not practical to resolve it with the maintainer of the existing layer(s), document what the overlap is and why it is there.
# '''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, 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].
# '''Announcement:''' Send an announcement to both of the following mailing lists telling people about the new layer:
#* yocto@yoctoproject.org ([http://lists.yoctoproject.org/listinfo/yocto list info])
#* openembedded-devel@lists.openembedded.org ([http://lists.linuxtogo.org/pipermail/openembedded-devel/ list info])
# '''Index:''' Add the layer to the [http://www.openembedded.org/wiki/LayerIndex OpenEmbedded layer index].