Sync conf files with OE - includes adding zaurusd to images and fixing PCMCIA_MANAGER handling

git-svn-id: https://svn.o-hand.com/repos/poky/trunk@327 311d38ba-8fff-0310-9ca6-ca027cbcb966
author: Richard Purdie <richard@openedhand.com> 2006-03-23 22:30:35 +0000
committer: Richard Purdie <richard@openedhand.com> 2006-03-23 22:30:35 +0000
commit: b3f42b759915ee078b192c43b37a86a219d15ebf (patch)
tree: 4378dddb69c532781870fc683f24a498e7fb52d3 /openembedded/conf/documentation.conf
parent: f7f54600f1ce3763705c6c6337bea052f77c5e33 (diff)
download: poky-b3f42b759915ee078b192c43b37a86a219d15ebf.tar.gz
1 files changed, 58 insertions, 41 deletions
diff --git a/openembedded/conf/documentation.conf b/openembedded/conf/documentation.conf
index 19aaf2dd48..320361398e 100644
--- a/openembedded/conf/documentation.conf
+++ b/openembedded/conf/documentation.conf
@@ -1,38 +1,42 @@
-# this file holds documentation for known keys, possible values and their meaning
+# this file holds documentation for known keys, possible values and
-# feel free to send updates and corrections to oe@handhelds.org
+# their meaning. Please update, correct and extend this documentation.
+# Mail your changes to oe@handhelds.org
 # conf/bitbake.conf
-PREFERRED_VERSION[doc] = "Normally use it as PREFERRED_VERSION_package-name = \"\" to set the preferred \
+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."
+version of more than one version for the package-name is available.'
-BUILD_ARCH[doc] = "The name of the building architecture. For example i686"
+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. For example \
+BUILD_OS[doc] = "The operating system (in lower case) of the building architecture. E.g \
-linux"
+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_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 \
+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_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_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_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.\
-TARGET_ARCH[doc] = "Build for which architecture. Examples are arm, i686, sh3, mips, powerpc"
+fakeroot-native will be build with tcp as IPC implementation.'
-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_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_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. For example arm-linux-"
+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" 
+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 \
+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"
+PACKAGE_ARCH  = "${MACHINE_ARCH}" to the file.'
 DATE[doc] = "The date the build was started Ymd"
@@ -41,35 +45,48 @@ 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."
+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"
+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 here"
+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'"
+PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'."
-DESCRIPTION[doc] = "A small description of the package"
+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 stuff contained in the package"
+AUTHOR[doc] = "The author of the files installed."
-MAINTAINER[doc] = "Maintainer of the .bb and the resulting package"
+MAINTAINER[doc] = "Maintainer of the .bb file and the resulting package."
-HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net"
+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. @group dependencies"
+PROVIDES[doc] = "Names for additional dependencies that this package will provide. @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"
-DEPENDS[doc]  = "Build time dependencies, things needed to build the package"
-RDEPENDS[doc] = "Run time dependencies, things needed for a given package to run"
-PROVIDES[doc] = "Names for additional dependencies that this package will provide"
-PACKAGES[doc] = "Names of packages to be generated"
+TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and other directories."
-FILES[doc]    = "Files/Directories belonging to the package"
+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."
-TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and some more dirs"
+GROUP_locale[doc] = "Locale generation of the GNU libc implementation"
-CACHE[doc]  = "The directory holding the parsing cache."
+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"
-DL_DIR[doc] = "The directory where tarballs will be downloaded."
-CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
-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"
author	Richard Purdie <richard@openedhand.com>	2006-03-23 22:30:35 +0000
committer	Richard Purdie <richard@openedhand.com>	2006-03-23 22:30:35 +0000
commit	b3f42b759915ee078b192c43b37a86a219d15ebf (patch)
tree	4378dddb69c532781870fc683f24a498e7fb52d3 /openembedded/conf/documentation.conf
parent	f7f54600f1ce3763705c6c6337bea052f77c5e33 (diff)
download	poky-b3f42b759915ee078b192c43b37a86a219d15ebf.tar.gz

diff --git a/openembedded/conf/documentation.conf b/openembedded/conf/documentation.conf index 19aaf2dd48..320361398e 100644 --- a/openembedded/conf/documentation.conf +++ b/openembedded/conf/documentation.conf
@@ -1,38 +1,42 @@
1	# this file holds documentation for known keys, possible values and their meaning	1	# this file holds documentation for known keys, possible values and
2	# feel free to send updates and corrections to oe@handhelds.org	2	# their meaning. Please update, correct and extend this documentation.
		3	# Mail your changes to oe@handhelds.org
3		4
4	# conf/bitbake.conf	5	# conf/bitbake.conf
5	PREFERRED_VERSION[doc] = "Normally use it as PREFERRED_VERSION_package-name = \"\" to set the preferred \	6	PREFERRED_VERSION[doc] = 'Normally use it as PREFERRED_VERSION_package-name = "" to set the preferred \
6	version of more than one version for the package-name is available."	7	version of more than one version for the package-name is available.'
7		8
8	BUILD_ARCH[doc] = "The name of the building architecture. For example i686"	9	BUILD_ARCH[doc] = "The name of the building architecture. E.g. i686."
9	BUILD_OS[doc] = "The operating system (in lower case) of the building architecture. For example \	10	BUILD_OS[doc] = "The operating system (in lower case) of the building architecture. E.g \
10	linux"	11	linux."
11	BUILD_VENDOR[doc] = "FIXME"	12	BUILD_VENDOR[doc] = "FIXME"
12	BUILD_SYS[doc] = "FIXME"	13	BUILD_SYS[doc] = "FIXME"
13	BUILD_PREFIX[doc] = "FIXME"	14	BUILD_PREFIX[doc] = "FIXME"
14	BUILD_CC_ARCH[doc] = "FIXME"	15	BUILD_CC_ARCH[doc] = "FIXME"
15		16
16	HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH @see TARGET_ARCH @group base"	17	HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH. @see TARGET_ARCH @group base"
17	HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS \	18	HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS. \
18	@see TARGET_OS @group base"	19	@see TARGET_OS @group base"
19	HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR @see TARGET_VENDOR"	20	HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR. @see TARGET_VENDOR"
20	HOST_SYS[doc] = "FIXME"	21	HOST_SYS[doc] = "FIXME"
21	HOST_PREFIX[doc] = "Normally same as the TARGET_PREFIX @see TARGET_PREFIX @group base"	22	HOST_PREFIX[doc] = "Normally same as the TARGET_PREFIX. @see TARGET_PREFIX @group base"
22	HOST_CC_ARCH[doc] = "Normally same as the TARGET_CC_ARCH @see TARGET_CC_ARCH @group base"	23	HOST_CC_ARCH[doc] = "Normally same as the TARGET_CC_ARCH. @see TARGET_CC_ARCH @group base"
23		24	HOST_NONSYSV[doc] = 'This flag can be set to "1" if the host system is not SysV compatible. E.g.\
24	TARGET_ARCH[doc] = "Build for which architecture. Examples are arm, i686, sh3, mips, powerpc"	25	fakeroot-native will be build with tcp as IPC implementation.'
25	TARGET_OS[doc] = "Build for which Operating System. Currently possible values are \	26
26	linux and linux-uclibc. When using linux-uclibc you might want to set USE_NLS_gcc-cross to \"no\"."	27	TARGET_ARCH[doc] = "Build for which architecture. Examples are arm, i686, sh3, mips, powerpc."
		28	TARGET_OS[doc] = 'Build for which Operating System. Currently possible values are \
		29	linux and linux-uclibc. When using linux-uclibc you might want to set USE_NLS_gcc-cross to "no".'
27	TARGET_VENDOR[doc] = "FIXME"	30	TARGET_VENDOR[doc] = "FIXME"
28	TARGET_SYS[doc] = "The target system is composed out of TARGET_ARCH,TARGET_VENDOR and TARGET_OS"	31	TARGET_SYS[doc] = "The target system is composed out of TARGET_ARCH,TARGET_VENDOR and TARGET_OS."
29	TARGET_PREFIX[doc] = "The prefix for the cross compile toolchain. For example arm-linux-"	32	TARGET_PREFIX[doc] = "The prefix for the cross compile toolchain. E.g arm-linux- ."
30	TARGET_CC_ARCH[doc] = "FIXME"	33	TARGET_CC_ARCH[doc] = "FIXME"
31	TARGET_FPU[doc] = "Floating point option (mostly for FPU-less systems), can be 'soft' or empty"	34	TARGET_FPU[doc] = "Floating point option (mostly for FPU-less systems), can be 'soft' or empty \
		35	for hardware floating point instructions."
32		36
33	PACKAGE_ARCH[doc] = "The architecture needed for using a resulting package. If you have \	37	PACKAGE_ARCH[doc] = 'The architecture needed for using a resulting package. If you have \
34	machine dependant configuration options in your bitbake file add a \	38	machine dependant configuration options in your bitbake file add a \
35	PACKAGE_ARCH = \"${MACHINE_ARCH}\" to the file"	39	PACKAGE_ARCH = "${MACHINE_ARCH}" to the file.'
36		40
37		41
38	DATE[doc] = "The date the build was started Ymd"	42	DATE[doc] = "The date the build was started Ymd"
@@ -41,35 +45,48 @@ DATETIME[doc] = "The date and time the build was started at"
41		45
42	PN[doc] = "PN holds the name of the package (Package Name). It is gathered from the bitbake-file filename"	46	PN[doc] = "PN holds the name of the package (Package Name). It is gathered from the bitbake-file filename"
43	PV[doc] = "PV holds the version of the package (Package Version). The default value is 1.0, it is \	47	PV[doc] = "PV holds the version of the package (Package Version). The default value is 1.0, it is \
44	retrieved from the bitbake-file filename."	48	retrieved from the bitbake-file filename but can be changed."
45	PR[doc] = "PR is the revision of the package (Package Revision). By default it is set to r0"	49	PR[doc] = "PR is the revision of the package (Package Revision). By default it is set to r0."
46	PF[doc] = "Package name - Package version - Package revision (PN-PV-PR)"	50	PF[doc] = "Package name - Package version - Package revision (PN-PV-PR)"
47	P[doc] = "Package name - Package version (PN-PF)"	51	P[doc] = "Package name - Package version (PN-PF)"
48	S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from here"	52	S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory."
49	SECTION[doc] = "Section of the packages e.g. console/networking"	53	SECTION[doc] = "Section of the packages e.g. console/networking"
50	PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'"	54	PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'."
51	DESCRIPTION[doc] = "A small description of the package"	55	DESCRIPTION[doc] = "A small description of the package."
52	LICENSE[doc] = "The license of the resulting package e.g. GPL"	56	LICENSE[doc] = "The license of the resulting package e.g. GPL"
53	AUTHOR[doc] = "The author of the stuff contained in the package"	57	AUTHOR[doc] = "The author of the files installed."
54	MAINTAINER[doc] = "Maintainer of the .bb and the resulting package"	58	MAINTAINER[doc] = "Maintainer of the .bb file and the resulting package."
55	HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net"	59	HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net."
		60
		61
		62	# dependencies
		63	GROUP_dependencies[doc] = "The keys in this group influence the dependency handling of BitBake \
		64	and the resulting packages."
		65	DEPENDS[doc] = "Build time dependencies, things needed to build the package. @group dependencies"
		66	RDEPENDS[doc] = "Run time dependencies, things needed for a given package to run. @group dependencies"
		67	PROVIDES[doc] = "Names for additional dependencies that this package will provide. @group dependencies"
		68
56		69
		70	# packaging
		71	GROUP_packaging[doc] = "The keys in this group influence the package building process. They influence \
		72	which packages will be generated and which files will be present in the generated packages."
		73	PACKAGES[doc] = "Names of packages to be generated. @group packaging"
		74	FILES[doc] = "Files/Directories belonging to the package. @group packaging"
57		75
58	DEPENDS[doc] = "Build time dependencies, things needed to build the package"
59	RDEPENDS[doc] = "Run time dependencies, things needed for a given package to run"
60	PROVIDES[doc] = "Names for additional dependencies that this package will provide"
61		76
62		77
63	PACKAGES[doc] = "Names of packages to be generated"	78	TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and other directories."
64	FILES[doc] = "Files/Directories belonging to the package"	79	CACHE[doc] = "The directory holding the cache of the metadata."
65		80
		81	GROUP_fetcher[doc] = "The key highly influence the fetcher implementations."
		82	DL_DIR[doc] = "The directory where tarballs will be stored. @group fetcher"
		83	CVSDIR[doc] = "The directory where cvs checkouts will be stored in. @group fetcher"
		84	GITDIR[doc] = "The directory where git clones will be stored. @group fetcher"
66		85
		86	STAMP[doc] = "The directory that holds files to keep track of what was built."
		87	WORKDIR[doc] = "The directory where a concrete package will be unpacked and built."
		88	T[doc] = "Temporary directory within the WORKDIR."
67		89
68	TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and some more dirs"	90	GROUP_locale[doc] = "Locale generation of the GNU libc implementation"
69	CACHE[doc] = "The directory holding the parsing cache."	91	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"
70	DL_DIR[doc] = "The directory where tarballs will be downloaded."
71	CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
72		92
73	STAMP[doc] = "The directory that holds files to keep track of what was built"
74	WORKDIR[doc] = "The directory where a concrete package will be unpacked and built"
75	T[doc] = "Temporary directory within the WORKDIR"