Differences between revisions 22 and 31 (spanning 9 versions)
Revision 22 as of 2009-03-17 10:06:57
Size: 9176
Editor: NeilWilliams
Comment: correction for debconf setup and updates
Revision 31 as of 2010-05-31 13:48:29
Size: 1919
Editor: NeilWilliams
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= Emdebian Quick Start = = Emdebian Crush Quick Start =
Line 3: Line 3:
This is intended to be a quick start guide to Emdebian and ([[DebPkg:emdebian-tools|emdebian-tools]]). This is intended to be a quick start guide to Emdebian and ([[DebPkg:emdebian-crush|emdebian-crush]]).

Crush is the cross-built flavour of Emdebian with functional differences to standard Debian. Only ARM (OABI) packages exist for Crush 1.0 and there are significant problems adding any other architectures. Crush development is on hold until after squeeze release.

See [[http://www.emdebian.org/grip|the Emdebian website]] for more on Emdebian Grip - the flavour of Emdebian that is binary-compatible with standard Debian and available for seven architectures, arm, armel, mips, mipsel, powerpc, i386 and amd64.
Line 7: Line 11:
emdebian-tools (>= 0.9.0) has been split into multiple packages: emdebian-tools is only available now in Debian stable. In Debian unstable (and soon in testing), Crush is built using normal Debian build tools and then post-processed using the scripts in [[DebPkg:emdebian-grip|emdebian-grip]] and configuration files from [[DebPkg:emdebian-crush|emdebian-crush]].
Line 9: Line 13:
 * '''emdebian-tools''' - the build tools. If you expect to make any changes to the current set of packages available for ARM from Emdebian, you will need the build tools. {{{emdebian-tools}}} depends on all the other packages below.
 * '''emdebian-rootfs''' - the installer tools. If you only want to use the current Emdebian packages for ARM without modification to create a root filesystem you can use alongside your kernel and kernel modules, you will only need the installer tools. {{{emdebian-rootfs}}} depends on the keyring and library packages. See EmdebianRootfs for a quick start.
 * '''emdebian-archive-keyring''' - the key for SecureApt support. If you only want to use the current Emdebian toolchains without the Emdebian patches or prebuilt packages, you only need the keyring. You can use the key without using any other Emdebian packages.
 * '''libemdebian-tools-perl''' - used by [[DebPkg:emdebian-tools|emdebian-tools]] and [[DebPkg:emdebian-rootfs|emdebian-rootfs]].
See also EmdebianRootfs and [[Multistrap|Multistrap]].
Line 14: Line 15:
This guide concentrates on '''emdebian-tools''' - i.e. package building, not installation. See also EmdebianRootfs.

== emdebian-tools ==

You will need to install a package called emdebian-tools, either from Debian repositories or the Emdebian repository. {{{emdebian-tools}}} also brings in {{{apt-cross}}} and {{{dpkg-cross}}}. {{{subversion}}} is recommended by {{{emdebian-tools}}} and used by {{{emsource}}} later. (emdebian-tools >= 1.0.0 depends on subversion directly.)
== Install pdebuild-cross ==
Line 21: Line 18:
$ sudo apt-get install emdebian-tools $ sudo apt-get install pdebuild-cross
$ sudo pdebuild-cross-cre
ate
Line 24: Line 22:
If you are installing emdebian-tools within a chroot, you will also need to configure the debconf settings for the emdebian-tools scripts directly. `# dpkg-reconfigure libemdebian-tools-perl` == Customised Emdebian sources ==
Line 26: Line 24:
The configuration will ask you several questions, including where you want to build packages (ensure this directory is writable - the default is only intended for use within a chroot), your username for emdebian svn access if you have one and whether you want to use apt-get or aptitude for toolchain package installation. {{{dpkg-cross}}} will offer you the chance to set a default cross-building architecture which saves a lot of typing later on. If you choose {{{None}}}, you will need to add '{{{--arch ARCH}}}' to all the emdebian-tools commands. Emdebian keeps a few packages in customised versions, where such customisations will provide suitable functional differences and dependency changes. Alternatively, you can use your own modified packages.
Line 28: Line 26:
Installing `emdebian-tools` from Debian makes the updated versions in the Emdebian repository available to `apt`, so now check for an updated version of the packages, noting that some updates introduce new dependencies:
{{{
$ sudo apt-get update
$ sudo apt-get dist-upgrade
}}}
These steps are still experimental. In time, source packages will be available to download. For now, [[http://www.emdebian.org/svn/browser/current/target|some packages are available from SVN]].
Line 34: Line 28:
Always ensure you are running the latest version available of each emdebian-tools package.

After you have the tools, you need to setup an emdebian environment using {{{emsetup}}}. This sets up the {{{~/.apt-cross}}} dir which contains apt caches and configuration files and adds the Emdebian toolchain repository to your apt sources list. apt will then keep your toolchain updated as normal.

New users are recommended to use at least one {{{-v|--verbose}}} option to all emdebian-tools commands.


==== emdebian-tools and sudo/su ====

{{{emsetup}}}, like the rest of {{{emdebian-tools}}} does '''NOT''' need to be run as root or under {{{sudo}}}. Tools include code to avoid root as much as possible and the package depends on sudo so that sudo usage can be controlled within the script and used only when absolutely necessary. Using at least one {{{-v|--verbose}}} option will ensure that you will be reminded when {{{emdebian-tools}}} needs to use sudo so that you can enter the sudo passphrase if it is not already cached.

Running {{{emdebian-tools}}} or {{{apt-cross}}} as root or under sudo may complicate the subsequent use of {{{emdebian-tools}}} as a normal user. This includes installing the cross-building toolchain - you should let {{{emsetup}}} do that step rather than running {{{sudo apt-get install}}} yourself.


=== Install toolchain ===
Once you have the sources, {{{cd}}} into the package directory and cross-build.
Line 51: Line 31:
$ apt-cross --update
$ emsetup --verbose --simulate
$ cd /path/to/foo-0.1.23.4
$ pdebuild-cross
Line 54: Line 34:

Check that the output is acceptable, nothing changed yet.

{{{
$ emsetup -v
}}}

{{{emsetup}}} will install a toolchain for you if a suitable one is available from Emdebian.

If {{{/etc/dpkg-cross/cross-compile}}} isn't fully configured yet, (hint in the manpage), or you have chosen to have no default cross-building architecture, then emsetup requests the use of --arch to determine the target architecture:

{{{
$ emsetup -v -s --arch m68k
...
$ emsetup -a m68k
}}}

Once {{{emsetup}}} is complete, you can use {{{sudo apt-get update; sudo apt-get upgrade}}} to ensure you have the latest versions of {{{apt-cross}}} and {{{emdebian-tools}}} as updates are uploaded to Emdebian between Debian versions.

It is also possible to override the default configuration in {{{/etc/dpkg-cross/cross-compile}}} with {{{~/.apt-cross/cross-compile}}}.


=== Package source and Emdebian patches ===

Now you can run {{{emsource <package>}}} to get a debian package, unpack it and apply / generate any emdebian patches. This is directly equivalent to {{{apt-get source}}} in mainstream debian and then applying some patches. {{{emsource}}} tells you where the package has been unpacked - in an SVN tree beneath your emdebian working directory. ({{{target}}} denotes that these packages are intended for installation directly onto the target embedded device.)

{{{
$ emsource -v foo
Using foo 0.1.23.4-0.1
Working directory: '/path/to/working/dir'
Checking for existing emdebian patches
Checking out working copies of existing emdebian patches
Checked out revision 1234.
Checking for existing build tree in foo-0.1.23.4.

Emdebianised source tree for 'foo' exists at '/path/to/working/dir/target/trunk/f/foo/trunk/foo-0.1.23.4'
Change to this directory before running 'emdebuild'

}}}

Now you can cd into the package directory.

{{{
cd /path/to/working/dir/target/trunk/f/foo/trunk/foo-0.1.23.4
gedit debian/rules &
}}}

=== Emdebian patches ===

 * If you are using Emdebian for ARM, patches are prepared and maintained in Emdebian.
 * If you are using ARM but with a customised toolchain or libc environment, you will need to review and possibly modify the Emdebian patches.
 * If you are using a different architecture, you will need to review the current Emdebian patches and modify values in the architecture-specific cache files - see the [[EmdebianGuide| Emdebian Developer Guide]] for detailed information on cache files.

==== Manual edits of debian/* files ====

As with any automated packaging process, take a moment to read through amended {{{debian/rules}}} before attempting to do {{{emdebuild}}} to actually build the package. This will you familiarise yourself with the kind of changes that Emdebian makes to Debian packages.

Common additions are noted in the [[EmdebianGuide| Emdebian Developer Guide]] but always take care to check for manual rules that install documentation or manpages. You should always check that {{{copyright}}}, {{{changelog}}} and all manpages are removed. If the package uses {{{make install}}} to put such files into {{{debian/}}} directories, include a line to remove those directories before the debhelper or dpkg commands that build the package:

{{{
 $(pkgme) $(MAKE) -C . install
 $(pkgdev) $(MAKE) -C . install-dev
 $(pkglib) $(MAKE) -C . install-lib
 $(pkgme) $(MAKE) -C build src-manifest

 dh_strip
 dh_compress
 dh_fixperms
 dh_makeshlibs -N $(library)
 dh_makeshlibs -p $(library) -V 'libattr1 (>= 2.4.4-1)'
 dh_installdeb
 dh_shlibdeps
 dh_gencontrol

 dh_md5sums
 dh_builddeb
}}}
becomes:
{{{
 $(pkgme) $(MAKE) -C . install
 $(pkgdev) $(MAKE) -C . install-dev
 $(pkglib) $(MAKE) -C . install-lib
 $(pkgme) $(MAKE) -C build src-manifest

 $(RM) -r debian/libattr1-dev/usr/share/
 $(RM) -r debian/attr/usr/share/

 dh_strip
 dh_compress
 dh_fixperms
 dh_makeshlibs -N $(library)
 dh_makeshlibs -p $(library) -V 'libattr1 (>= 2.4.4-1)'
 dh_installdeb
 dh_shlibdeps
 dh_gencontrol

 dh_md5sums
 dh_builddeb
}}}

You will need to install any build dependencies as needed with apt-get or aptitude and cross-dependencies with {{{emdebuild --build-dep}}}. {{{emdebuild}}} creates a .build log for you.

{{{
$ emdebuild -v
}}}

Packages, .changes, .dsc, .diff.gz, patch files and the .build log are created in the directory above:

{{{
$ ls /path/to/working/dir/target/trunk/f/foo/trunk/
}}}

You could check the [[http://linux.codehelp.co.uk/emdebian/man/|Emdebian manpages]] and the [[Embedded_Debian]] wiki pages for documentation.

All questions to the debian-embedded mailing list - emdebian developers are also available on IRC. See the [[http://www.emdebian.org/|emdebian website]] for details.
Line 173: Line 38:
## This apge is referenced from http://www.emdebian.org/docs.html
## This page is referenced from http://www.emdebian.org/docs.html
Line 175: Line 41:

Emdebian Crush Quick Start

This is intended to be a quick start guide to Emdebian and (emdebian-crush).

Crush is the cross-built flavour of Emdebian with functional differences to standard Debian. Only ARM (OABI) packages exist for Crush 1.0 and there are significant problems adding any other architectures. Crush development is on hold until after squeeze release.

See the Emdebian website for more on Emdebian Grip - the flavour of Emdebian that is binary-compatible with standard Debian and available for seven architectures, arm, armel, mips, mipsel, powerpc, i386 and amd64.

emdebian-tools is only available now in Debian stable. In Debian unstable (and soon in testing), Crush is built using normal Debian build tools and then post-processed using the scripts in emdebian-grip and configuration files from emdebian-crush.

See also EmdebianRootfs and Multistrap.

Install pdebuild-cross

$ sudo apt-get install pdebuild-cross
$ sudo pdebuild-cross-create

Customised Emdebian sources

Emdebian keeps a few packages in customised versions, where such customisations will provide suitable functional differences and dependency changes. Alternatively, you can use your own modified packages.

These steps are still experimental. In time, source packages will be available to download. For now, some packages are available from SVN.

Once you have the sources, cd into the package directory and cross-build.

$ cd /path/to/foo-0.1.23.4
$ pdebuild-cross

The next stage is the Emdebian Developer Guide.


CategoryPermalink

CategoryEmdebian