ELBE XML Reference¶
RootFileSystem type: rfs:RootFileSystemType¶
describes one elbe project. An elbe project contains the creation of abuild environemt and the definition of a elbe target rootfilesystem.
SIMPLE TYPE: revisionNr¶
is used to decide if your elbe version is compatiblewith the given xml file
Base Type¶
integer
Restrictions¶
minInclusive | 6 |
maxInclusive | 6 |
TYPE: binary-url¶
e.g. “http://myhost/debian /” or “http://debian.org/debian main”
Example¶
no sequence
TYPE: url-list¶
links to additional debian mirrors
Example¶
<url-list>
<url> rfs:url </url>
</url-list>
TYPE: project¶
describes elbe project settings that apply to the creation of the targetrootfilesystem and include the definition of the build environment
Example¶
no sequence
SIMPLE TYPE: memory_restriction¶
Memory can be specified using binary unit prefixes like MiB and GiB,or SI prefixes like GB,MB or simply G or M.
Base Type¶
string
SIMPLE TYPE: fw_proto_restriction¶
only tcp and udp are allowed protocols for forwarding
Base Type¶
string
Restrictions¶
enumeration | tcp |
enumeration | udp |
TYPE: forward¶
forward a network port from the build environment to the host machine
Example¶
no sequence
TYPE: portforwarding¶
forward network ports from the build environment to the host machine
Example¶
<portforwarding>
<forward> rfs:forward </forward>
</portforwarding>
Element description¶
- forward rfs:forward
- describes a single port forward
TYPE: debootstrapvarianttype¶
Enhanced restriction type specifying debootstrap variants.
Example¶
no sequence
SIMPLE TYPE: debootstrapvarianttype_restriction¶
Restriction type specifying debootstrap variants.Supported debootstrap variants are minbase, buildd and fakechroot.The variant scratchbox is not supported by th used debootstrap.
Base Type¶
string
Restrictions¶
enumeration | minbase |
enumeration | buildd |
enumeration | fakechroot |
SIMPLE TYPE: ubi_type_restriction¶
a ubi volume can be either static or dynamic
Base Type¶
string
Restrictions¶
enumeration | static |
enumeration | dynamic |
TYPE: ubivg¶
container for all ubi volumes of a mtd device
Example¶
<ubivg>
<label> rfs:string </label>
<miniosize> rfs:string </miniosize>
<maxlogicaleraseblockcount> rfs:string </maxlogicaleraseblockcount>
<logicaleraseblocksize> rfs:string </logicaleraseblocksize>
<physicaleraseblocksize> rfs:string </physicaleraseblocksize>
<subpagesize> rfs:string </subpagesize>
</ubivg>
Element description¶
- label rfs:string
- human readable name; used to generate filename for the flashable image file
- miniosize rfs:string
- flash parameter minimal i/o size
- maxlogicaleraseblockcount rfs:string
- flash parameter maximum logical erase block count
- logicaleraseblocksize rfs:string
- flash parameter logical erase block size
- physicaleraseblocksize rfs:string
- flash parameter physical erase block size
- subpagesize rfs:string
- flash parameter subpagesize
TYPE: gpthd¶
describes a harddisk
Example¶
<gpthd>
<name> rfs:string </name>
<size> rfs:part_size </size>
<grub-install> rfs:string </grub-install>
<partition> rfs:partition </partition>
</gpthd>
Element description¶
- name rfs:string
- human readable name of the harddisk, this will be used as name for the image file
- size rfs:part_size
- size of the harddisk
- grub-install rfs:string
- human readable name of the harddisk, this will be used as name for the image file
- partition rfs:partition
- Partition Entries of this harddisk
TYPE: msdoshd¶
describes a harddisk
Example¶
<msdoshd>
<name> rfs:string </name>
<size> rfs:part_size </size>
<grub-install> rfs:string </grub-install>
<binary> rfs:binaryblob </binary>
<partition> rfs:partition </partition>
<extended> rfs:extended </extended>
<partition> rfs:partition </partition>
</msdoshd>
Element description¶
- name rfs:string
- human readable name of the harddisk, this will be used as name for the image file
- size rfs:part_size
- size of the harddisk
- grub-install rfs:string
- human readable name of the harddisk, this will be used as name for the image file
- binary rfs:binaryblob optional
- binary blob that is dd’ed to the specified offset
- partition rfs:partition
- Partition Entries of this harddisk (max: 4)
- extended rfs:extended
- Extended Partition Entries of this harddisk (max: 1)
- partition rfs:partition
- Partition Entries of this harddisk (max: 3)
TYPE: images¶
container for all storage devices of the target
Example¶
<images>
<mtd> rfs:mtd </mtd>
<msdoshd> rfs:msdoshd </msdoshd>
<gpthd> rfs:gpthd </gpthd>
<passno> rfs:string </passno>
</images>
Element description¶
- mtd rfs:mtd
- container for all mtd devices of the target
- msdoshd rfs:msdoshd
- container for Harddisks with msdos Partitionlabel.
- gpthd rfs:gpthd
- container for Harddisks with GPT Partitionlabel
- passno rfs:string
- passno order for fsck
TYPE: fstab¶
container for mounts
Example¶
<fstab>
<bylabel> rfs:bylabel </bylabel>
<bydev> rfs:bydev </bydev>
</fstab>
Element description¶
- bylabel rfs:bylabel
- describes a mount by a volume or partition label
- bydev rfs:bydev
- describes a mount based on a device node or a mount of a virtual filesystem like debugfs or tmpfs
TYPE: extended¶
describes a extended partition of a harddisk
Example¶
<extended>
<size> rfs:part_size </size>
<logical> rfs:partition </logical>
</extended>
Element description¶
- size rfs:part_size
- size of the partition
- logical rfs:partition
- logical partition of this extended partition
TYPE: part_size¶
Helper around part_size_restriction to allow XML base attribute
Example¶
no sequence
SIMPLE TYPE: part_size_restriction¶
format of the partition size
Base Type¶
string
Restrictions¶
pa tte rn | (d +(k | M | G | kB | MB | GB | kiB | MiB | GiB )? | rem ain ) |
SIMPLE TYPE: part_nr_restriction¶
allow maximum 4 primary partitions
Base Type¶
integer
Restrictions¶
minInclusive | 1 |
maxInclusive | 4 |
TYPE: part_type¶
Helper around part_type_restriction to allow XML base attribute
Example¶
no sequence
SIMPLE TYPE: part_type_restriction¶
list of supported partition types
Base Type¶
string
Restrictions¶
enumeration | linux |
enumeration | swap |
SIMPLE TYPE: fs_type_restriction¶
list of supported filesystems
Base Type¶
string
Restrictions¶
enumeration | ext2 |
enumeration | ext3 |
enumeration | ext4 |
enumeration | xfs |
enumeration | ubifs |
enumeration | tmpfs |
enumeration | debugfs |
enumeration | configfs |
enumeration | devpts |
enumeration | proc |
enumeration | sysfs |
enumeration | vfat |
enumeration | btrfs |
enumeration | devtmpfs |
TYPE: finetuning¶
container for finetuning commands; these commands are executed in theroot of the target filesystem after the target filesystem was created
Example¶
<finetuning>
</finetuning>
Element description¶
TYPE: project-finetuning¶
container for project-finetuning commands; these commands are executed in theproject directory, after the images have been generated.
Example¶
<project-finetuning>
</project-finetuning>
Element description¶
TYPE: losetup¶
Container for image_finetuning commands; these commands are executed in theproject directory, while a drive image is setup as a loop device.The loop device id is passed to the individual actions.
Example¶
<losetup>
</losetup>
Element description¶
TYPE: extract_partition¶
Describe the partition to be extracted (nr) and the destination filename.The value of the tag describes the filename of the generated Imagefile.The Image is per default compressed with gzip afterwards.
Example¶
no sequence
TYPE: addgroup¶
describes an additional user group to be created. the following parameters areavailable:’gid’ - group id.’system = “True” - system group.The value of the tag describes the group name namefor the account.
Example¶
no sequence
TYPE: adduser¶
describes an additional user account, the following parameters areavailable:’shell’ - the login shell for the user.passwd - the (optional) password for the user.groups - a comma separated list of groups the user is member of.uid - (optional) user of the user.gid - (optional) primary group, may be numeric or a name.home - home directory.system=”True” - system user.create_home=”False” - do not create the home directory.create_group = “False” - Do not create the primary group.The value of the tag describes the login name for the account.
Example¶
no sequence
TYPE: rm¶
describes a removal of a pattern from the rootfilesystem.Including an exclude pattern
Example¶
no sequence
TYPE: svn_src¶
URI of the svn repository, e.g. “svn://myhost/myrepo/tags/my_tag”
Example¶
no sequence
TYPE: pbuilder¶
reference to debian source packages
Example¶
<pbuilder>
<git> rfs:git_src </git>
<svn> rfs:svn_src </svn>
</pbuilder>
Element description¶
- git rfs:git_src
- reference to a git tree hosting a debian source package. The source will be build with a pbuilder before the image generation. Use the install attribute to specify which binary packages should be installed in the target image.
- svn rfs:svn_src
- reference to a svn repository hosting a debian source package. The source will be build with a pbuilder before the image generation. Use the install attribute to specify which binary packages should be installed in the target image.
TYPE: blacklist¶
blacklists of debian packages
Example¶
<blacklist>
<sysroot> rfs:pkg-list </sysroot>
</blacklist>
Element description¶
- sysroot rfs:pkg-list
- avoid installing the specified packages into the sysroot
TYPE: fullpkg-list¶
List of packages to be validated against the installed list.
Example¶
<fullpkg-list>
<pkg> rfs:pkg </pkg>
</fullpkg-list>