From 11bc3aca3d4c8c662af226e1360727e9b01df4a1 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 19 Sep 2012 13:26:54 -0700 Subject: documentation/poky-ref-manual/ref-variables.xml: SRC_URI glossary updated Fixes [YOCTO_#1939] Expanded the definition for the SRC_URI variable in the glossary. The new information includes protocol types and SRC_URI options. (From yocto-docs rev: 033d58cd2ec2a579fa085bcca1e5d0ad4dd65708) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-variables.xml | 126 +++++++++++++++++++++++- 1 file changed, 125 insertions(+), 1 deletion(-) diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 720980f733..d71d25023c 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -1826,7 +1826,131 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" SRC_URI - The list of source files - local or remote. + The list of source files - local or remote. + This variable tells the OpenEmbedded build system which bits to pull + in for the build and how to pull them in. + For example, if the recipe only needs to fetch a tarball from the + internet, the recipe uses a single SRC_URI entry. + On the other hand, if the recipe needs to fetch a tarball, apply + two patches, and include a custom file, the recipe would include four + instances of the variable. + The following list explains the available URI protocols: + + file:// - Fetches files, which is usually + a file shipped with the metadata, from the local machine. + The path is relative to the + FILESPATH + variable. + Thus, the build system searches, in order, from the following directories, + which are assumed to be a subdirectories of the directory in which the + recipe file resides: + + ${PN} - The package name + with any special suffix (i.e. bash-native, + bash). + The package name (PN) includes the special suffix + -native for native recipes, + -cross for cross recipes, a Multilib suffix + for Multilib recipes, and so forth). + ${PF} - + ${PN}-${EXTENDPE}${PV}-${PR}. + The package name including all version and revision numbers + (i.e. eglibc-2.13-r20+svnr15508/ and + bash-4.2-r1/). + ${P} - + ${PN}-${PV}. + The package name and version (i.e. bash-4.2). + + ${BPN} - The + base package name without any special suffix or version numbers. + + ${BP} - + ${BPN}-${PV}. + The base package name and version but without any special + package name suffix. + Files - Files beneath the directory in which the recipe + resides. + Directory - The directory itself in which the recipe + resides. + + bzr:// - Fetches files from a + Bazaar revision control repository. + git:// - Fetches files from a + Git revision control repository. + osc:// - Fetches files from + an OSC (OpenSuse Build service) revision control repository. + repo:// - Fetches files from + a repo (Git) repository. + svk:// - Fetches files from + an SVK revision control repository. + http:// - Fetches files from + the Internet using http. + https:// - Fetches files + from the Internet using https. + ftp:// - Fetches files + from the Internet using ftp. + cvs:// - Fetches files from + a CVS revision control repository. + hg:// - Fetches files from + a Mercurial (hg) revision control repository. + p4:// - Fetches files from + a Perforce (p4) revision control repository. + ssh:// - Fetches files from + a secure shell. + svn:// - Fetches files from + a Subversion (svn) revision control repository. + + + Standard and recipe-specific options for SRC_URI exist. + Here are standard options: + + apply - Whether to apply + the patch or not. + The default action is to apply the patch. + striplevel - Which + striplevel to use when applying the patch. + The default level is 1. + + + Here are options specific to recipes building code from a revision control system: + + mindate - Only applies + the patch if SRCDATE + is equal to or greater than mindate. + maxdate - Only applies + the patch if SRCDATE + is not later than mindate. + minrev - Only applies + the patch if SRCREV + is equal to or greater than minrev. + maxrev - Only applies + the patch if SRCREV + is not later than maxrev. + rev - Only applies the + patch if SRCREV + is equal to rev. + notrev - Only applies + the patch if SRCREV + is not equal to rev. + + + Here are some additional options worth mentioning: + + unpack - Controls + whether or not to unpack the file if it is an archive. + The default action is to upack the file. + subdir - Places the file + (or extracts its contents) into the specified + subdirectory of WORKDIR. + This option is useful for unusual tarballs or other archives that + don't have their files already in a subdirectory within the archive. + + name - Specifies a + name to be used for association with SRC_URI checksums + when you have more than one file specified in SRC_URI. + + + -- cgit v1.2.3-54-g00ecf