diff options
Diffstat (limited to 'openembedded/conf/documentation.conf')
| -rw-r--r-- | openembedded/conf/documentation.conf | 104 |
1 files changed, 0 insertions, 104 deletions
diff --git a/openembedded/conf/documentation.conf b/openembedded/conf/documentation.conf deleted file mode 100644 index c07c8fa68b..0000000000 --- a/openembedded/conf/documentation.conf +++ /dev/null | |||
| @@ -1,104 +0,0 @@ | |||
| 1 | # this file holds documentation for known keys, possible values and | ||
| 2 | # their meaning. Please update, correct and extend this documentation. | ||
| 3 | # Mail your changes to oe@handhelds.org | ||
| 4 | |||
| 5 | # conf/bitbake.conf | ||
| 6 | PREFERRED_VERSION[doc] = 'Normally use it as PREFERRED_VERSION_package-name = "" to set the preferred \ | ||
| 7 | version of more than one version for the package-name is available.' | ||
| 8 | |||
| 9 | BUILD_ARCH[doc] = "The name of the building architecture. E.g. i686." | ||
| 10 | BUILD_OS[doc] = "The operating system (in lower case) of the building architecture. E.g \ | ||
| 11 | linux." | ||
| 12 | BUILD_VENDOR[doc] = "FIXME" | ||
| 13 | BUILD_SYS[doc] = "FIXME" | ||
| 14 | BUILD_PREFIX[doc] = "FIXME" | ||
| 15 | BUILD_CC_ARCH[doc] = "FIXME" | ||
| 16 | |||
| 17 | HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH. @see TARGET_ARCH @group base" | ||
| 18 | HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS. \ | ||
| 19 | @see TARGET_OS @group base" | ||
| 20 | HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR. @see TARGET_VENDOR" | ||
| 21 | HOST_SYS[doc] = "FIXME" | ||
| 22 | HOST_PREFIX[doc] = "Normally same as the TARGET_PREFIX. @see TARGET_PREFIX @group base" | ||
| 23 | HOST_CC_ARCH[doc] = "Normally same as the TARGET_CC_ARCH. @see TARGET_CC_ARCH @group base" | ||
| 24 | HOST_NONSYSV[doc] = 'This flag can be set to "1" if the host system is not SysV compatible. E.g.\ | ||
| 25 | fakeroot-native will be build with tcp as IPC implementation.' | ||
| 26 | |||
| 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".' | ||
| 30 | TARGET_VENDOR[doc] = "FIXME" | ||
| 31 | TARGET_SYS[doc] = "The target system is composed out of TARGET_ARCH,TARGET_VENDOR and TARGET_OS." | ||
| 32 | TARGET_PREFIX[doc] = "The prefix for the cross compile toolchain. E.g arm-linux- ." | ||
| 33 | TARGET_CC_ARCH[doc] = "FIXME" | ||
| 34 | TARGET_FPU[doc] = "Floating point option (mostly for FPU-less systems), can be 'soft' or empty \ | ||
| 35 | for hardware floating point instructions." | ||
| 36 | |||
| 37 | PACKAGE_ARCH[doc] = 'The architecture needed for using a resulting package. If you have \ | ||
| 38 | machine dependant configuration options in your bitbake file add a \ | ||
| 39 | PACKAGE_ARCH = "${MACHINE_ARCH}" to the file.' | ||
| 40 | |||
| 41 | IPKG_ARCHS[doc] = 'A list of architectures compatible with the given target in order of priority' | ||
| 42 | IPKG_EXTRA_ARCHS[doc] = 'Set this variable to add extra architectures to the list of supported architectures' | ||
| 43 | |||
| 44 | DATE[doc] = "The date the build was started Ymd" | ||
| 45 | TIME[doc] = "The time the build was started HMS" | ||
| 46 | DATETIME[doc] = "The date and time the build was started at" | ||
| 47 | |||
| 48 | PN[doc] = "PN holds the name of the package (Package Name). It is gathered from the bitbake-file filename" | ||
| 49 | PV[doc] = "PV holds the version of the package (Package Version). The default value is 1.0, it is \ | ||
| 50 | retrieved from the bitbake-file filename but can be changed." | ||
| 51 | PR[doc] = "PR is the revision of the package (Package Revision). By default it is set to r0." | ||
| 52 | PF[doc] = "Package name - Package version - Package revision (PN-PV-PR)" | ||
| 53 | P[doc] = "Package name - Package version (PN-PF)" | ||
| 54 | S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory." | ||
| 55 | SECTION[doc] = "Section of the packages e.g. console/networking" | ||
| 56 | PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'." | ||
| 57 | DESCRIPTION[doc] = "A small description of the package." | ||
| 58 | LICENSE[doc] = "The license of the resulting package e.g. GPL" | ||
| 59 | AUTHOR[doc] = "The author of the files installed." | ||
| 60 | MAINTAINER[doc] = "Maintainer of the .bb file and the resulting package." | ||
| 61 | HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net." | ||
| 62 | |||
| 63 | |||
| 64 | # dependencies | ||
| 65 | GROUP_dependencies[doc] = "The keys in this group influence the dependency handling of BitBake \ | ||
| 66 | and the resulting packages." | ||
| 67 | DEPENDS[doc] = "Build time dependencies, things needed to build the package. @group dependencies" | ||
| 68 | RDEPENDS[doc] = "Run time dependencies, things needed for a given package to run. This is used to populate the ipkg:Depends field. @group dependencies" | ||
| 69 | PROVIDES[doc] = "Names for additional build time dependencies that this package will provide. @group dependencies" | ||
| 70 | RPROVIDES[doc] = "Names for additional run time dependencies that this package will provide. This is used to populate the ipkg:Provides field. @group dependencies" | ||
| 71 | |||
| 72 | |||
| 73 | # packaging | ||
| 74 | GROUP_packaging[doc] = "The keys in this group influence the package building process. They influence \ | ||
| 75 | which packages will be generated and which files will be present in the generated packages." | ||
| 76 | PACKAGES[doc] = "Names of packages to be generated. @group packaging" | ||
| 77 | FILES[doc] = "Files/Directories belonging to the package. @group packaging" | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and other directories." | ||
| 82 | CACHE[doc] = "The directory holding the cache of the metadata." | ||
| 83 | |||
| 84 | GROUP_fetcher[doc] = "The key highly influence the fetcher implementations." | ||
| 85 | DL_DIR[doc] = "The directory where tarballs will be stored. @group fetcher" | ||
| 86 | CVSDIR[doc] = "The directory where cvs checkouts will be stored in. @group fetcher" | ||
| 87 | GITDIR[doc] = "The directory where git clones will be stored. @group fetcher" | ||
| 88 | |||
| 89 | STAMP[doc] = "The directory that holds files to keep track of what was built." | ||
| 90 | WORKDIR[doc] = "The directory where a concrete package will be unpacked and built." | ||
| 91 | T[doc] = "Temporary directory within the WORKDIR." | ||
| 92 | |||
| 93 | GROUP_locale[doc] = "Locale generation of the GNU libc implementation" | ||
| 94 | 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" | ||
| 95 | |||
| 96 | PCMCIA_MANAGER[doc] = "Specify which package(s) to install to handle PCMCIA slots (usually pcmcia-cs or pcmciautils)." | ||
| 97 | |||
| 98 | SYSVINIT_ENABLED_GETTYS[doc] = "Specify which VTs should be running a getty, the default is 1" | ||
| 99 | |||
| 100 | # palmtop build class | ||
| 101 | PALMTOP_USE_MULTITHREADED_QT[doc] = "Set to yes, if you want to build qt apps with CONFIG+=thread" | ||
| 102 | |||
| 103 | 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." | ||
| 104 | 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." | ||
