code.vuplus.com Git - vuplus_openembedded/blob - conf/documentation.conf

   1 # this file holds documentation for known keys, possible values and their meaning
   2 # feel free to send updates and corrections to oe@handhelds.org
   3
   4 # conf/bitbake.conf
   5 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
   8 BUILD_ARCH[doc] = "The name of the building architecture. For example i686"
   9 BUILD_OS[doc] = "The operating system (in lower case) of the building architecture. For example \
  10 linux"
  11 BUILD_VENDOR[doc] = "FIXME"
  12 BUILD_SYS[doc] = "FIXME"
  13 BUILD_PREFIX[doc] = "FIXME"
  14 BUILD_CC_ARCH[doc] = "FIXME"
  15
  16 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 @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_SYS[doc] = "FIXME"
  21 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
  24 TARGET_ARCH[doc] = "Build for which architecture. Examples are arm, i686, sh3, mips, powerpc"
  25 TARGET_OS[doc]   = "Build for which Operating System. Currently possible values are \
  26 linux and linux-uclibc. When using linux-uclibc you might want to set USE_NLS_gcc-cross to \"no\"."
  27 TARGET_VENDOR[doc] = "FIXME"
  28 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-"
  30 TARGET_CC_ARCH[doc] = "FIXME"
  31 TARGET_FPU[doc] = "Floating point option (mostly for FPU-less systems), can be 'soft' or empty"
  32
  33 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 \
  35 PACKAGE_ARCH  = \"${MACHINE_ARCH}\" to the file"
  36
  37
  38 DATE[doc] = "The date the build was started Ymd"
  39 TIME[doc] = "The time the build was started HMS"
  40 DATETIME[doc] = "The date and time the build was started at"
  41
  42 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 \
  44 retrieved from the bitbake-file filename."
  45 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)"
  47 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"
  49 SECTION[doc]  = "Section of the packages e.g. console/networking"
  50 PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'"
  51 DESCRIPTION[doc] = "A small description of the package"
  52 LICENSE[doc] = "The license of the resulting package e.g. GPL"
  53 AUTHOR[doc] = "The author of the stuff contained in the package"
  54 MAINTAINER[doc] = "Maintainer of the .bb and the resulting package"
  55 HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net"
  56
  57
  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
  62
  63 PACKAGES[doc] = "Names of packages to be generated"
  64 FILES[doc]    = "Files/Directories belonging to the package"
  65
  66
  67
  68 TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and some more dirs"
  69 CACHE[doc]  = "The directory holding the parsing cache."
  70 DL_DIR[doc] = "The directory where tarballs will be downloaded."
  71 CVSDIR[doc] = "The directory where cvs checkouts will be stored in."
  72
  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"