From 39bbc8f82894ca521d35645cd618dd131fde38ef Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Wed, 18 Jun 2014 14:25:40 +0300 Subject: bitbake-user-manual-fetching.xml: Grammar, typo, and tweaks. Various grammatical and typo tweaks all in fetching chapter, including moving CVS section after wget section for more logical content flow. Signed-off-by: Scott Rifenbark --- .../bitbake-user-manual-fetching.xml | 94 +++++++++++----------- 1 file changed, 48 insertions(+), 46 deletions(-) (limited to 'doc') diff --git a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index 42a1db090..09207b9fd 100644 --- a/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -8,14 +8,14 @@ BitBake's fetch module is a standalone piece of library code that deals with the intricacies of downloading source code and files from remote systems. - Fetching source code is one of the corner stones of building software. + Fetching source code is one of the cornerstones of building software. As such, this module forms an important part of BitBake. The current fetch module is called "fetch2" and refers to the fact that it is the second major version of the API. - The original version is obsolete and removed from the codebase. + The original version is obsolete and has been removed from the codebase. Thus, in all cases, "fetch" refers to "fetch2" in this manual. @@ -60,17 +60,19 @@ For convenience, the naming in these examples matches the variables used by OpenEmbedded. + If you want to see the above code in action, examine + the OpenEmbedded class file base.bbclass. The SRC_URI and WORKDIR - variables are not coded into the fetcher. - They variables can (and are) called with different variable names. + variables are not hardcoded into the fetcher, since those fetcher + methods can be (and are) called with different variable names. In OpenEmbedded for example, the shared state (sstate) code uses the fetch module to fetch the sstate files. When the download() method is called, - BitBake tries to fulfill the URLs by looking for source files + BitBake tries to resolve the URLs by looking for source files in a specific search order: Pre-mirror Sites: @@ -84,7 +86,7 @@ SRC_URI). Mirror Sites: - If fetch failures occur, BitBake next uses mirror location as + If fetch failures occur, BitBake next uses mirror locations as defined by the MIRRORS variable. @@ -149,7 +151,7 @@ File integrity is of key importance for reproducing builds. For non-local archive downloads, the fetcher code can verify - sha256 and md5 checksums to ensure the archives have been + SHA-256 and MD5 checksums to ensure the archives have been downloaded correctly. You can specify these checksums by using the SRC_URI variable with the appropriate @@ -260,8 +262,8 @@ This submodule handles URLs that begin with file://. - The filename you specify with in the URL can - either be an absolute or relative path to a file. + The filename you specify within the URL can be + either an absolute or relative path to a file. If the filename is relative, the contents of the FILESPATH variable is used in the same way @@ -286,15 +288,45 @@ - Here are some example URLs: + Here are a couple example URLs, the first relative and + the second absolute: SRC_URI = "file://relativefile.patch" - SRC_URI = "file://relativefile.patch;this=ignored" SRC_URI = "file:///Users/ich/very_important_software" +
+ HTTP/FTP wget fetcher (<filename>http://</filename>, <filename>ftp://</filename>, <filename>https://</filename>) + + + This fetcher obtains files from web and FTP servers. + Internally, the fetcher uses the wget utility. + + + + The executable and parameters used are specified by the + FETCHCMD_wget variable, which defaults + to sensible values. + The fetcher supports a parameter "downloadfilename" that + allows the name of the downloaded file to be specified. + Specifying the name of the downloaded file is useful + for avoiding collisions in + DL_DIR + when dealing with multiple files that have the same name. + + + + Some example URLs are as follows: + + SRC_URI = "http://oe.handhelds.org/not_there.aac" + SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac" + SRC_URI = "ftp://you@oe.handhelds.org/home/you/secret.plan" + + +
+
CVS fetcher (<filename>(cvs://</filename>) @@ -334,7 +366,7 @@ The supported parameters are as follows: "method": - The protocol over which to communicate with the cvs server. + The protocol over which to communicate with the CVS server. By default, this protocol is "pserver". If "method" is set to "ext", BitBake examines the "rsh" parameter and sets CVS_RSH. @@ -394,36 +426,6 @@
-
- HTTP/FTP wget fetcher (<filename>http://</filename>, <filename>ftp://</filename>, <filename>https://</filename>) - - - This fetcher obtains files from web and FTP servers. - Internally, the fetcher uses the wget utility. - - - - The executable and parameters used are specified by the - FETCHCMD_wget variable, which defaults - to a sensible values. - The fetcher supports a parameter "downloadfilename" that - allows the name of the downloaded file to be specified. - Specifying the name of the downloaded file is useful - for avoiding collisions in - DL_DIR - when dealing with multiple files that have the same name. - - - - Some example URLs are as follows: - - SRC_URI = "http://oe.handhelds.org/not_there.aac" - SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac" - SRC_URI = "ftp://you@oe.handheld.sorg/home/you/secret.plan" - - -
-
Subversion (SVN) Fetcher (<filename>svn://</filename>) @@ -476,14 +478,14 @@
- GIT Fetcher (<filename>git://</filename>) + Git Fetcher (<filename>git://</filename>) This fetcher submodule fetches code from the Git source control system. The fetcher works by creating a bare clone of the remote into GITDIR, which is - usually DL_DIR/git. + usually DL_DIR/git2. This bare clone is then cloned into the work directory during the unpack stage when a specific tree is checked out. This is done using alternates and by reference to @@ -571,7 +573,7 @@
- GIT Submodule Fetcher (<filename>gitsm://</filename>) + Git Submodule Fetcher (<filename>gitsm://</filename>) This fetcher submodule inherits from the @@ -579,7 +581,7 @@ that fetcher's behavior by fetching a repository's submodules. SRC_URI is passed to the Git fetcher as described in the - "GIT Fetcher (git://)" + "Git Fetcher (git://)" section. Notes and Warnings -- cgit 1.2.3-korg