Openembedded.org - User contributions [en]

How to create a bitbake recipe for dummies

2010-09-17T14:37:22Z

Coolaj86: /* wrapped with make */

== Introduction ==

Currently only limited documentation is available on how to create a bitbake recipe. This article is a stub.

* [http://www.gumstix.net/Setup-and-Programming/view/Build-system-overview/Hello-world-tutorial/111.html Gumstix Hello world tutorial]
* [http://www.google.com/search?hl=en&q=bitbake+recipe+site:lists.linuxtogo.org/pipermail/openembedded-devel/ OpenEmbedded Mailing List Archives ]

== Recipe Template ==

Every recipe should start like this (pretend the package name is CHANGME:

DESCRIPTION = ""
HOMEPAGE = ""
LICENSE = ""
DEPENDS = ""
SRC_URI = " \
"
# SRC_URI could also point to a git repository, eg:
# SRC_URI = " git://host:port/path/to/repo.git;branch=win;protocol=ssh;user=username"

# any .patch files included here will be auto-magically applied, increasing the -p level until it sticks.
# SRC_URI = "file://omap_ctrl_readl.patch"

PR = "r0" # Package Revision, Update this whenever you change the recipe.

# For tarball packages (as opposed to git / svn which include the commit in the URI)
SRC_URI[md5sum] = ""
SRC_URI[sha256sum] = ""
S = "${WORKDIR}/CHANGEME-${PV}"
do_configure () {
./configure --prefix=${prefix}
}
do_compile () {
make
}
do_install () {
DESTDIR=${D} oe_runmake install
}

* '''PV''' refers to the revision. I.E. PV=0.2.1 for nodejs_0.2.1.bb

== Examples ==

=== wrapped with make ===

This example shows waf wrapped in make

DESCRIPTION = "nodeJS Evented I/O for V8 JavaScript"
HOMEPAGE = "http://nodejs.org"
LICENSE = "MIT"
DEPENDS = "openssl"
SRC_URI = " \
http://nodejs.org/dist/node-v${PV}.tar.gz \
file://libev-cross-cc.patch \
file://node-cross-cc.patch \
"
SRC_URI[md5sum] = "c6051dd216817bf0f95bea80c42cf262"
SRC_URI[sha256sum] = "5bb7d084b2138ce43fcb34739ed894379c450a1dd569a1c710405bc39d2861c2"
S = "${WORKDIR}/node-v${PV}"
do_configure () {
./configure --prefix=${prefix} --without-snapshot
}
do_compile () {
make
}
do_install () {
DESTDIR=${D} oe_runmake install
}

=== make ===

TODO

=== autotools ===

TODO

=== scons ===

TODO

=== waf ===

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

How to create a bitbake recipe for dummies

2010-09-17T14:36:04Z

Coolaj86: /* Recipe Template */

== Introduction ==

Currently only limited documentation is available on how to create a bitbake recipe. This article is a stub.

* [http://www.gumstix.net/Setup-and-Programming/view/Build-system-overview/Hello-world-tutorial/111.html Gumstix Hello world tutorial]
* [http://www.google.com/search?hl=en&q=bitbake+recipe+site:lists.linuxtogo.org/pipermail/openembedded-devel/ OpenEmbedded Mailing List Archives ]

== Recipe Template ==

Every recipe should start like this (pretend the package name is CHANGME:

DESCRIPTION = ""
HOMEPAGE = ""
LICENSE = ""
DEPENDS = ""
SRC_URI = " \
"
# SRC_URI could also point to a git repository, eg:
# SRC_URI = " git://host:port/path/to/repo.git;branch=win;protocol=ssh;user=username"

# any .patch files included here will be auto-magically applied, increasing the -p level until it sticks.
# SRC_URI = "file://omap_ctrl_readl.patch"

PR = "r0" # Package Revision, Update this whenever you change the recipe.

# For tarball packages (as opposed to git / svn which include the commit in the URI)
SRC_URI[md5sum] = ""
SRC_URI[sha256sum] = ""
S = "${WORKDIR}/CHANGEME-${PV}"
do_configure () {
./configure --prefix=${prefix}
}
do_compile () {
make
}
do_install () {
DESTDIR=${D} oe_runmake install
}

* '''PV''' refers to the revision. I.E. PV=0.2.1 for nodejs_0.2.1.bb

== Examples ==

=== wrapped with make ===

This example shows waf wrapped in make

DESCRIPTION = "nodeJS Evented I/O for V8 JavaScript"
HOMEPAGE = "http://nodejs.org"
LICENSE = "MIT"
DEPENDS = "openssl"
SRC_URI = " \
http://nodejs.org/dist/node-v${PV}.tar.gz \
file://libev-cross-cc.patch \
file://node-cross-cc.patch \
"
SRC_URI[md5sum] = "c6051dd216817bf0f95bea80c42cf262"
SRC_URI[sha256sum] = "5bb7d084b2138ce43fcb34739ed894379c450a1dd569a1c710405bc39d2861c2"
S = "${WORKDIR}/node-v${PV}"
do_configure () {
./configure --without-snapshot
}
do_compile () {
make
}
do_install () {
#oe_runmake install # doesn't install to correct location

# This works
install -d ${D}${bindir}/
install -m 0755 ${S}/build/default/node ${D}${bindir}/
install -m 0755 ${S}/bin/node-waf ${D}${bindir}/
install -m 0755 ${S}/bin/node-repl ${D}${bindir}/
}
FILES_${PN} = "${bindir}/node ${bindir}/node-repl ${bindir}/node-waf"

=== make ===

TODO

=== autotools ===

TODO

=== scons ===

TODO

=== waf ===

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

How to create a bitbake recipe for dummies

2010-09-15T17:39:01Z

Coolaj86: New page: == Introduction == Currently only limited documentation is available on how to create a bitbake recipe. This article is a stub. * [http://www.gumstix.net/Setup-and-Programming/view/Build...

== Introduction ==

Currently only limited documentation is available on how to create a bitbake recipe. This article is a stub.

* [http://www.gumstix.net/Setup-and-Programming/view/Build-system-overview/Hello-world-tutorial/111.html Gumstix Hello world tutorial]
* [http://www.google.com/search?hl=en&q=bitbake+recipe+site:lists.linuxtogo.org/pipermail/openembedded-devel/ OpenEmbedded Mailing List Archives ]

== Recipe Template ==

Every recipe should start like this (pretend the package name is CHANGME:

DESCRIPTION = ""
HOMEPAGE = ""
LICENSE = ""
DEPENDS = ""
SRC_URI = " \
"
# For tarball packages (as opposed to git / svn which include the commit in the URI)
SRC_URI[md5sum] = ""
SRC_URI[sha256sum] = ""
S = "${WORKDIR}/CHANGEME-${PV}"
do_configure () {
./configure
}
do_compile () {
oe_runmake
}
do_install () {
oe_runmake install
}

* '''PV''' refers to the revision. I.E. PV=0.2.1 for nodejs_0.2.1.bb

== Examples ==

=== wrapped with make ===

This example shows waf wrapped in make

DESCRIPTION = "nodeJS Evented I/O for V8 JavaScript"
HOMEPAGE = "http://nodejs.org"
LICENSE = "MIT"
DEPENDS = "openssl"
SRC_URI = " \
http://nodejs.org/dist/node-v${PV}.tar.gz \
file://libev-cross-cc.patch \
file://node-cross-cc.patch \
"
SRC_URI[md5sum] = "c6051dd216817bf0f95bea80c42cf262"
SRC_URI[sha256sum] = "5bb7d084b2138ce43fcb34739ed894379c450a1dd569a1c710405bc39d2861c2"
S = "${WORKDIR}/node-v${PV}"
do_configure () {
./configure --without-snapshot
}
do_compile () {
make
}
do_install () {
#oe_runmake install # doesn't install to correct location

# This works
install -d ${D}${bindir}/
install -m 0755 ${S}/build/default/node ${D}${bindir}/
install -m 0755 ${S}/bin/node-waf ${D}${bindir}/
install -m 0755 ${S}/bin/node-repl ${D}${bindir}/
}
FILES_${PN} = "${bindir}/node ${bindir}/node-repl ${bindir}/node-waf"

=== make ===

TODO

=== autotools ===

TODO

=== scons ===

TODO

=== waf ===

How to submit a patch to OpenEmbedded

2010-09-15T16:55:32Z

Coolaj86: /* Create and Commit your patch */

== A task-oriented guide to creating a patch ==

'''Note''': More details are available on the policy pages, but this document is good enough for most beginners.

* [[Patchwork]]
* [[Commit Policy]]

Let's say you [[How to create a bitbake recipe for dummies|create a new bitbake recipe for OpenEmbedded]] and you'd like to submit it for inclusion (and you've already tested that it works, of course).

=== Set up git ===

Properly configuring git (using tekkub@gmail.com as an example user)

On Debain / Ubuntu (Note: Fedora and OpenSuse use `yum`)

sudo aptitude install git-core git-email

These are important to the commit meta-data

git config --global user.name "Tekkub"
git config --global user.email "tekkub@gmail.com"

Any Google Apps account

git config --global sendemail.smtpserver smtp.gmail.com
git config --global sendemail.smtpserverport 587
git config --global sendemail.smtpencryption tls
git config --global sendemail.smtpuser tekkupl@gmail.com

=== Create and Commit your patch ===

1. Commit with a concise and descriptive message - one that explains your changes in a way others get a short overview without
looking at the code.

cd org.openembedded.dev/ # or whereever you keep your clone of the repo
git add recipes/nodejs/
git commit # don't use the -m option

nodejs: added recipe for v0.2.1

* included libev-cross patch which prevents wscript from executing cross-compiled code
* included node-cross patch which forwards DEST_CPU to v8's ARCH

2. Create your patch. '''Use -N for N commits''' to be included in the patch. '''Use -s to add a signoff line''' like "Signed-off-by: Tekku B. <tekkub@gmail.com>"

git format-patch -1 -s # creating a patch for my only commit and including my signature

If you are submitting a second version also add "--subject-prefix [v2]"

3. Send your patch to patchwork

git send-email --to=openembedded-devel@lists.openembedded.org 001-nodejs-added-recipe-for-v0.2.1

Your patch will be immediately visible on http://patchwork.openembedded.org/patch/

4. Once your patch has been accepted or rejected, create an account and update the status to "accepted" or "rejected"

4++. If you get '''soft-rejected (a lot of feedback)''', you should make changes according to the feedback, submit the next version, and update the status of the previous patch to "superseded". Remember to use `--subject-prefix` to mark the patch iteration.

== Appendix ==

=== steps for people which don't have snmp access for git ===

Patches should not be set as attachment but inline.

If you do not have snmp access to your email account you have two options:

1. use a different account (e.g. gmail). you can make one especially
for this. Note that the account may differ from the one in signed-off
(although that is inconvenient)

2. just include the patch in the body of your email. Make sure you use
an email client that does not touch the message (turn spaces in tabs,
wrap lines etc etc).

A good mail client to do so is '''pine''' (or '''alpine''')

How to submit a patch to OpenEmbedded

2010-09-15T16:54:18Z

Coolaj86: format update... wiki isn't markdown...

== A task-oriented guide to creating a patch ==

'''Note''': More details are available on the policy pages, but this document is good enough for most beginners.

* [[Patchwork]]
* [[Commit Policy]]

Let's say you [[How to create a bitbake recipe for dummies|create a new bitbake recipe for OpenEmbedded]] and you'd like to submit it for inclusion (and you've already tested that it works, of course).

=== Set up git ===

Properly configuring git (using tekkub@gmail.com as an example user)

On Debain / Ubuntu (Note: Fedora and OpenSuse use `yum`)

sudo aptitude install git-core git-email

These are important to the commit meta-data

git config --global user.name "Tekkub"
git config --global user.email "tekkub@gmail.com"

Any Google Apps account

git config --global sendemail.smtpserver smtp.gmail.com
git config --global sendemail.smtpserverport 587
git config --global sendemail.smtpencryption tls
git config --global sendemail.smtpuser tekkupl@gmail.com

=== Create and Commit your patch ===

1. Commit with a concise and descriptive message - one that explains your changes in a way others get a short overview without
looking at the code.

git add recipes/nodejs/
git commit # don't use the -m option

nodejs: added recipe for v0.2.1

* included libev-cross patch which prevents wscript from executing cross-compiled code
* included node-cross patch which forwards DEST_CPU to v8's ARCH

2. Create your patch. '''Use -N for N commits''' to be included in the patch. '''Use -s to add a signoff line''' like "Signed-off-by: Tekku B. <tekkub@gmail.com>"

git format-patch -1 -s # creating a patch for my only commit and including my signature

If you are submitting a second version also add "--subject-prefix [v2]"

3. Send your patch to patchwork

git send-email --to=openembedded-devel@lists.openembedded.org 001-nodejs-added-recipe-for-v0.2.1

Your patch will be immediately visible on http://patchwork.openembedded.org/patch/

4. Once your patch has been accepted or rejected, create an account and update the status to "accepted" or "rejected"

4++. If you get '''soft-rejected (a lot of feedback)''', you should make changes according to the feedback, submit the next version, and update the status of the previous patch to "superseded". Remember to use `--subject-prefix` to mark the patch iteration.

== Appendix ==

=== steps for people which don't have snmp access for git ===

Patches should not be set as attachment but inline.

If you do not have snmp access to your email account you have two options:

1. use a different account (e.g. gmail). you can make one especially
for this. Note that the account may differ from the one in signed-off
(although that is inconvenient)

2. just include the patch in the body of your email. Make sure you use
an email client that does not touch the message (turn spaces in tabs,
wrap lines etc etc).

A good mail client to do so is '''pine''' (or '''alpine''')

How to submit a patch to OpenEmbedded

2010-09-15T16:49:57Z

Coolaj86: New page: == A task-oriented guide to creating a patch == '''Note''': More details are available on the policy pages, but this document is good enough for most beginners. * Patchwork * [[Com...

== A task-oriented guide to creating a patch ==

'''Note''': More details are available on the policy pages, but this document is good enough for most beginners.

* [[Patchwork]]
* [[Commit Policy]]

Let's say you [[How to create a bitbake recipe for dummies|create a new bitbake recipe for OpenEmbedded]] and you'd like to submit it for inclusion (and you've already tested that it works, of course).

=== Set up git ===

Properly configuring git (using tekkub@gmail.com as an example user)

# On Debain / Ubuntu (Note: Fedora and OpenSuse use `yum`)
sudo aptitude install git-core git-email

# These are important to the commit meta-data
git config --global user.name "Tekkub"
git config --global user.email "tekkub@gmail.com"

# any Google Apps account
git config --global sendemail.smtpserver smtp.gmail.com
git config --global sendemail.smtpserverport 587
git config --global sendemail.smtpencryption tls
git config --global sendemail.smtpuser tekkupl@gmail.com

=== Create and Commit your patch ===

1. Commit with a concise and descriptive message - one that explains your changes in a way others get a short overview without
looking at the code.

git add recipes/nodejs/
git commit # don't use the -m option

nodejs: added recipe for v0.2.1

* included libev-cross patch which prevents wscript from executing cross-compiled code
* included node-cross patch which forwards DEST_CPU to v8's ARCH

2. Create your patch. '''Use -N for N commits''' to be included in the patch. '''Use -s to add a signoff line''' like "Signed-off-by: Tekku B. <tekkub@gmail.com>"

git format-patch -1 -s # creating a patch for my only commit and including my signature

If you are submitting a second version also add "--subject-prefix [v2]"

3. Send your patch to patchwork

git send-email --to=openembedded-devel@lists.openembedded.org 001-nodejs-added-recipe-for-v0.2.1

Your patch will be immediately visible on http://patchwork.openembedded.org/patch/

4. Once your patch has been accepted or rejected, create an account and update the status to "accepted" or "rejected"

4++. If you get '''soft-rejected (a lot of feedback)''', you should make changes according to the feedback, submit the next version, and update the status of the previous patch to "superseded". Remember to use `--subject-prefix` to mark the patch iteration.

== Appendix ==

=== steps for people which don't have snmp access for git ===

Patches should not be set as attachment but inline.

If you do not have snmp access to your email account you have two options:

1. use a different account (e.g. gmail). you can make one especially
for this. Note that the account may differ from the one in signed-off
(although that is inconvenient)

2. just include the patch in the body of your email. Make sure you use
an email client that does not touch the message (turn spaces in tabs,
wrap lines etc etc).

A good mail client to do so is '''pine''' (or '''alpine''')

User:Coolaj86

2010-09-15T16:11:32Z

Coolaj86: New page: AJ ONeal coolaj86 at google's mail http://coolaj86.github.com

AJ ONeal

coolaj86 at google's mail

http://coolaj86.github.com