summaryrefslogtreecommitdiff
path: root/conf/documentation.conf
blob: feb572db46f8b3d54eac6008f905232fde815571 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# this file holds documentation for known keys, possible values and
# their meaning. Please update, correct and extend this documentation.
# Mail your changes to openembedded-devel@openembedded.org

# conf/bitbake.conf
PREFERRED_VERSION[doc] = 'Normally use it as PREFERRED_VERSION_package-name = "" to set the preferred \
version of more than one version for the package-name is available.'

BUILD_ARCH[doc] = "The name of the building architecture. E.g. i686."
BUILD_OS[doc] = "The operating system (in lower case) of the building architecture. E.g \
linux."
BUILD_VENDOR[doc] = "FIXME"
BUILD_SYS[doc] = "FIXME"
BUILD_PREFIX[doc] = "FIXME"
BUILD_CC_ARCH[doc] = "FIXME"

HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH. @see TARGET_ARCH @group base"
HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS. \
@see TARGET_OS @group base"
HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR. @see TARGET_VENDOR"
HOST_SYS[doc] = "FIXME"
HOST_PREFIX[doc] = "Normally same as the TARGET_PREFIX. @see TARGET_PREFIX @group base"
HOST_CC_ARCH[doc] = "Normally same as the TARGET_CC_ARCH. @see TARGET_CC_ARCH @group base"
HOST_NONSYSV[doc] = 'This flag can be set to "1" if the host system is not SysV compatible. E.g.\
fakeroot-native will be build with tcp as IPC implementation.'

TARGET_ARCH[doc] = "Build for which architecture. Examples are arm, i686, sh3, mips, powerpc."
TARGET_OS[doc]   = 'Build for which Operating System. Currently possible values are \
linux and linux-uclibc. When using linux-uclibc you might want to set USE_NLS_gcc-cross to "no".'
TARGET_VENDOR[doc] = "FIXME"
TARGET_SYS[doc] = "The target system is composed out of TARGET_ARCH,TARGET_VENDOR and TARGET_OS."
TARGET_PREFIX[doc] = "The prefix for the cross compile toolchain. E.g arm-linux- ."
TARGET_CC_ARCH[doc] = "FIXME"
TARGET_FPU[doc] = "Floating point option (mostly for FPU-less systems), can be 'soft' or empty \
for hardware floating point instructions."

PACKAGE_ARCH[doc] = 'The architecture needed for using a resulting package. If you have \
machine dependant configuration options in your bitbake file add a \
PACKAGE_ARCH  = "${MACHINE_ARCH}" to the file.'

IPKG_ARCHS[doc] = 'A list of architectures compatible with the given target in order of priority'
IPKG_EXTRA_ARCHS[doc] = 'Set this variable to add extra architectures to the list of supported architectures'

DATE[doc] = "The date the build was started Ymd"
TIME[doc] = "The time the build was started HMS"
DATETIME[doc] = "The date and time the build was started at"

PN[doc] = "PN holds the name of the package (Package Name). It is gathered from the bitbake-file filename"
PV[doc] = "PV holds the version of the package (Package Version). The default value is 1.0, it is \
retrieved from the bitbake-file filename but can be changed."
PR[doc] = "PR is the revision of the package (Package Revision). By default it is set to r0."
PF[doc] = "Package name - Package version - Package revision (PN-PV-PR)"
P[doc]  = "Package name - Package version (PN-PF)"
S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory."
SECTION[doc]  = "Section of the packages e.g. console/networking"
PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'."
DESCRIPTION[doc] = "A small description of the package."
LICENSE[doc] = "The license of the resulting package e.g. GPL"
AUTHOR[doc] = "The author of the files installed."
MAINTAINER[doc] = "Maintainer of the .bb file and the resulting package."
HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net."


# dependencies
GROUP_dependencies[doc] = "The keys in this group influence the dependency handling of BitBake \
and the resulting packages."
DEPENDS[doc]  = "Build time dependencies, things needed to build the package. @group dependencies"
RDEPENDS[doc] = "Run time dependencies, things needed for a given package to run.  This is used to populate the ipkg:Depends field. @group dependencies"
PROVIDES[doc] = "Names for additional build time dependencies that this package will provide. @group dependencies"
RPROVIDES[doc] = "Names for additional run time dependencies that this package will provide.  This is used to populate the ipkg:Provides field. @group dependencies"


# packaging
GROUP_packaging[doc] = "The keys in this group influence the package building process. They influence \
which packages will be generated and which files will be present in the generated packages."
PACKAGES[doc] = "Names of packages to be generated. @group packaging"
FILES[doc]    = "Files/Directories belonging to the package. @group packaging"



TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and other directories."
CACHE[doc]  = "The directory holding the cache of the metadata."

GROUP_fetcher[doc] = "The key highly influence the fetcher implementations."
DL_DIR[doc] = "The directory where tarballs will be stored. @group fetcher"
CVSDIR[doc] = "The directory where cvs checkouts will be stored in. @group fetcher"
GITDIR[doc] = "The directory where git clones will be stored. @group fetcher"

STAMP[doc]   = "The directory that holds files to keep track of what was built."
WORKDIR[doc] = "The directory where a concrete package will be unpacked and built."
T[doc]       = "Temporary directory within the WORKDIR."

GROUP_locale[doc] = "Locale generation of the GNU libc implementation"
ENABLE_BINARY_LOCALE_GENERATION[doc] = "Enable the use of qemu to generate locale information during build time on the host instead of runtime on the target. If you have trouble with qemu-native you should make this an empty var. @group locale"

PCMCIA_MANAGER[doc] = "Specify which package(s) to install to handle PCMCIA slots (usually pcmcia-cs or pcmciautils)."

SYSVINIT_ENABLED_GETTYS[doc] = "Specify which VTs should be running a getty, the default is 1"

# palmtop build class
PALMTOP_USE_MULTITHREADED_QT[doc] = "Set to yes, if you want to build qt apps with CONFIG+=thread"

COMPATIBLE_HOST[doc] = "A regular expression which matches the HOST_SYS names supported by the package/file. Failure to match will cause the file to be skipped by the parser."
COMPATIBLE_MACHINE[doc] = "A regular expression which matches the MACHINES support by the package/file. Failure to match will cause the file to be skipped by the parser."