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

   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 openembedded-devel@openembedded.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 ASSUME_PROVIDED[doc] = "List of packages (recipes actually) which are assumed to be implicitly available.\
  38  These packages won't be built by bitbake."
  39 ASSUME_SHLIBS[doc] = "List of shlib:package[_version] mappings. Useful for lib packages in ASSUME_PROVIDED,\
  40  for which automatic shlib dependency tracking doesn't work."
  41
  42 PACKAGE_ARCH[doc] = 'The architecture needed for using a resulting package. If you have \
  43 machine dependant configuration options in your bitbake file add a \
  44 PACKAGE_ARCH  = "${MACHINE_ARCH}" to the file.'
  45
  46 PACKAGE_ARCHS[doc] = 'A list of architectures compatible with the given target in order of priority'
  47 PACKAGE_EXTRA_ARCHS[doc] = 'Set this variable to add extra architectures to the list of supported architectures'
  48
  49 DATE[doc] = "The date the build was started Ymd"
  50 TIME[doc] = "The time the build was started HMS"
  51 DATETIME[doc] = "The date and time the build was started at"
  52
  53 PN[doc] = "PN holds the name of the package (Package Name). It is gathered from the bitbake-file filename"
  54 PV[doc] = "PV holds the version of the package (Package Version). The default value is 1.0, it is \
  55 retrieved from the bitbake-file filename but can be changed."
  56 PR[doc] = "PR is the revision of the package (Package Revision). By default it is set to r0."
  57 PF[doc] = "Package name - Package version - Package revision (PN-PV-PR)"
  58 P[doc]  = "Package name - Package version (PN-PF)"
  59 S[doc] = "Directory that holds the sources to build, WORKDIR/PN-PV by default. The 'make' or equivalent command is run from this directory."
  60 SECTION[doc]  = "Section of the packages e.g. console/networking"
  61 PRIORITY[doc] = "Importance of package, default values are 'optional' or 'needed'."
  62 DESCRIPTION[doc] = "A small description of the package."
  63 LICENSE[doc] = "The license of the resulting package e.g. GPL"
  64 AUTHOR[doc] = "The author of the files installed."
  65 MAINTAINER[doc] = "Distributions can put this in their .conf file to add their contact information into packages, this is not valid inside recipes"
  66 HOMEPAGE[doc] = "Homepage of the package e.g. http://www.project.net."
  67
  68
  69 # dependencies
  70 GROUP_dependencies[doc] = "The keys in this group influence the dependency handling of BitBake \
  71 and the resulting packages."
  72 DEPENDS[doc]  = "Build time dependencies, things needed to build the package. @group dependencies"
  73 RDEPENDS[doc] = "Run time dependencies, things needed for a given package to run.  This is used to populate the ipkg:Depends field. @group dependencies"
  74 PROVIDES[doc] = "Names for additional build time dependencies that this package will provide. @group dependencies"
  75 RPROVIDES[doc] = "Names for additional run time dependencies that this package will provide.  This is used to populate the ipkg:Provides field. @group dependencies"
  76
  77
  78 # packaging
  79 GROUP_packaging[doc] = "The keys in this group influence the package building process. They influence \
  80 which packages will be generated and which files will be present in the generated packages."
  81 PACKAGES[doc] = "Names of packages to be generated. @group packaging"
  82 FILES[doc]    = "Files/Directories belonging to the package. @group packaging"
  83
  84
  85
  86 TMPDIR[doc] = "The temporary directory of openembedded holding work-, deploy, staging- and other directories."
  87 CACHE[doc]  = "The directory holding the cache of the metadata."
  88
  89 GROUP_fetcher[doc] = "The key highly influence the fetcher implementations."
  90 DL_DIR[doc] = "The directory where tarballs will be stored. @group fetcher"
  91 CVSDIR[doc] = "The directory where cvs checkouts will be stored in. @group fetcher"
  92 GITDIR[doc] = "The directory where git clones will be stored. @group fetcher"
  93 SVNDIR[doc] = "The directory where subversion checkouts will be stored. @group fetcher"
  94
  95 STAMP[doc]   = "The directory that holds files to keep track of what was built."
  96 WORKDIR[doc] = "The directory where a concrete package will be unpacked and built."
  97 T[doc]       = "Temporary directory within the WORKDIR."
  98
  99 GROUP_locale[doc] = "Locale generation of the GNU libc implementation"
 100 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"
 101
 102 PCMCIA_MANAGER[doc] = "Specify which package(s) to install to handle PCMCIA slots (usually pcmcia-cs or pcmciautils)."
 103
 104 SYSVINIT_ENABLED_GETTYS[doc] = "Specify which VTs should be running a getty, the default is 1"
 105
 106 # insane bbclass
 107 QA_LOG[doc] = "Enable logging of QA errors to log.qa_package. Default is not to log."
 108
 109 # palmtop build class
 110 PALMTOP_USE_MULTITHREADED_QT[doc] = "Set to yes, if you want to build qt apps with CONFIG+=thread"
 111
 112 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."
 113 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."
 114
 115 SOURCE_MIRROR_FETCH[doc] = "Switch marking build as source fetcher. Used to skip COMPATIBLE_* checking."
 116 SOURCE_MIRROR_URL[doc] = "URL to source mirror which will be used before fetching from original SRC_URI."
 117
 118 BBINCLUDELOGS[doc] = "Boolean switch to get log printed on failure."
 119 BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure."
 120
 121
 122 # seppuku bbclass
 123 SEPPUKU_AUTOBUILD[doc] = "This is an autobuild, broken packages are cleaned automatically. Don't define this at all if this is not an autobuild"
 124 SEPPUKU_USER[doc]     = "The login-name for the bugzilla account"
 125 SEPPUKU_PASS[doc]     = "The password for this account"
 126 #SEPPUKU_LOGIN         = "http://bugs.openembedded.org/query.cgi?"
 127 SEPPUKU_LOGIN[doc]    = "path to the login script of the bugzilla, note the ? at the end"
 128 #SEPPUKU_QUERY         = "http://bugs.openembedded.org/buglist.cgi"
 129 SEPPUKU_QUERY[doc]    = "The query script of the bugzilla"
 130 #SEPPUKU_NEWREPORT     = "http://bugs.openembedded.org/post_bug.cgi?bug_file_loc=http%3A%2F%2F&version=unspecified&priority=P2&bug_severity=normal&op_sys=Linux&rep_platform=Other&"
 131 SEPPUKU_NEWREPORT[doc]= "This is the url used to create a new bug report, note the defaults for version and priority and more, and the trailing &"
 132 #SEPPUKU_ADDCOMMENT     = "http://bugs.openembedded.org/process_bug.cgi?bug_file_loc=http%3A%2F%2F&version=unspecified&longdesclength=2&priority=P2&bug_severity=normal&op_sys=Linux&rep_platform=Other&"
 133 SEPPUKU_ADDCOMMENT[doc]= "The url used to reopen bug reports and to add another new comment"
 134 #SEPPUKU_ATTACHMENT = "http://bugs.openembedded.org/attachment.cgi"
 135 SEPPUKU_ATTACHMENT[doc] = "The url used to create attachments."
 136
 137
 138 #SEPPUKU_PRODUCT       = "Openembedded"
 139 SEPPUKU_PRODUCT[doc]  = "The product inside the bugtracker"
 140 #SEPPUKU_COMPONENT     = "build"
 141 SEPPUKU_COMPONENT[doc]= "The component inside the bugtracker"