summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-04-23 18:06:47 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-26 15:26:14 +0100
commit91aacf4ed312a6bbb07a3ccabf76618575b0e637 (patch)
tree6a0ef8345df063fe4d45761bd9d8b452c42d0120 /bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
parenta836bd6fc042f144e02be33cc69378dbaabd345c (diff)
downloadpoky-91aacf4ed312a6bbb07a3ccabf76618575b0e637.tar.gz
bitbake: doc: bitbake-user-manual: simplify colon usage
- This replaces instances of ": ::" by "::", which generates identical HTML output (Bitbake rev: fd8ce4dcaff3aae395f9945fb0a3be54905e1727) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst42
1 files changed, 21 insertions, 21 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 626278e444..3167ab1380 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -27,7 +27,7 @@ and unpacking the files is often optionally followed by patching.
27Patching, however, is not covered by this module. 27Patching, however, is not covered by this module.
28 28
29The code to execute the first part of this process, a fetch, looks 29The code to execute the first part of this process, a fetch, looks
30something like the following: :: 30something like the following::
31 31
32 src_uri = (d.getVar('SRC_URI') or "").split() 32 src_uri = (d.getVar('SRC_URI') or "").split()
33 fetcher = bb.fetch2.Fetch(src_uri, d) 33 fetcher = bb.fetch2.Fetch(src_uri, d)
@@ -37,7 +37,7 @@ This code sets up an instance of the fetch class. The instance uses a
37space-separated list of URLs from the :term:`SRC_URI` 37space-separated list of URLs from the :term:`SRC_URI`
38variable and then calls the ``download`` method to download the files. 38variable and then calls the ``download`` method to download the files.
39 39
40The instantiation of the fetch class is usually followed by: :: 40The instantiation of the fetch class is usually followed by::
41 41
42 rootdir = l.getVar('WORKDIR') 42 rootdir = l.getVar('WORKDIR')
43 fetcher.unpack(rootdir) 43 fetcher.unpack(rootdir)
@@ -72,7 +72,7 @@ URLs by looking for source files in a specific search order:
72For each URL passed to the fetcher, the fetcher calls the submodule that 72For each URL passed to the fetcher, the fetcher calls the submodule that
73handles that particular URL type. This behavior can be the source of 73handles that particular URL type. This behavior can be the source of
74some confusion when you are providing URLs for the ``SRC_URI`` variable. 74some confusion when you are providing URLs for the ``SRC_URI`` variable.
75Consider the following two URLs: :: 75Consider the following two URLs::
76 76
77 http://git.yoctoproject.org/git/poky;protocol=git 77 http://git.yoctoproject.org/git/poky;protocol=git
78 git://git.yoctoproject.org/git/poky;protocol=http 78 git://git.yoctoproject.org/git/poky;protocol=http
@@ -81,7 +81,7 @@ In the former case, the URL is passed to the ``wget`` fetcher, which does not
81understand "git". Therefore, the latter case is the correct form since the Git 81understand "git". Therefore, the latter case is the correct form since the Git
82fetcher does know how to use HTTP as a transport. 82fetcher does know how to use HTTP as a transport.
83 83
84Here are some examples that show commonly used mirror definitions: :: 84Here are some examples that show commonly used mirror definitions::
85 85
86 PREMIRRORS ?= "\ 86 PREMIRRORS ?= "\
87 bzr://.*/.\* http://somemirror.org/sources/ \\n \ 87 bzr://.*/.\* http://somemirror.org/sources/ \\n \
@@ -111,19 +111,19 @@ File integrity is of key importance for reproducing builds. For
111non-local archive downloads, the fetcher code can verify SHA-256 and MD5 111non-local archive downloads, the fetcher code can verify SHA-256 and MD5
112checksums to ensure the archives have been downloaded correctly. You can 112checksums to ensure the archives have been downloaded correctly. You can
113specify these checksums by using the ``SRC_URI`` variable with the 113specify these checksums by using the ``SRC_URI`` variable with the
114appropriate varflags as follows: :: 114appropriate varflags as follows::
115 115
116 SRC_URI[md5sum] = "value" 116 SRC_URI[md5sum] = "value"
117 SRC_URI[sha256sum] = "value" 117 SRC_URI[sha256sum] = "value"
118 118
119You can also specify the checksums as 119You can also specify the checksums as
120parameters on the ``SRC_URI`` as shown below: :: 120parameters on the ``SRC_URI`` as shown below::
121 121
122 SRC_URI = "http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d" 122 SRC_URI = "http://example.com/foobar.tar.bz2;md5sum=4a8e0f237e961fd7785d19d07fdb994d"
123 123
124If multiple URIs exist, you can specify the checksums either directly as 124If multiple URIs exist, you can specify the checksums either directly as
125in the previous example, or you can name the URLs. The following syntax 125in the previous example, or you can name the URLs. The following syntax
126shows how you name the URIs: :: 126shows how you name the URIs::
127 127
128 SRC_URI = "http://example.com/foobar.tar.bz2;name=foo" 128 SRC_URI = "http://example.com/foobar.tar.bz2;name=foo"
129 SRC_URI[foo.md5sum] = 4a8e0f237e961fd7785d19d07fdb994d 129 SRC_URI[foo.md5sum] = 4a8e0f237e961fd7785d19d07fdb994d
@@ -201,7 +201,7 @@ time the ``download()`` method is called.
201If you specify a directory, the entire directory is unpacked. 201If you specify a directory, the entire directory is unpacked.
202 202
203Here are a couple of example URLs, the first relative and the second 203Here are a couple of example URLs, the first relative and the second
204absolute: :: 204absolute::
205 205
206 SRC_URI = "file://relativefile.patch" 206 SRC_URI = "file://relativefile.patch"
207 SRC_URI = "file:///Users/ich/very_important_software" 207 SRC_URI = "file:///Users/ich/very_important_software"
@@ -222,7 +222,7 @@ downloaded file is useful for avoiding collisions in
222:term:`DL_DIR` when dealing with multiple files that 222:term:`DL_DIR` when dealing with multiple files that
223have the same name. 223have the same name.
224 224
225Some example URLs are as follows: :: 225Some example URLs are as follows::
226 226
227 SRC_URI = "http://oe.handhelds.org/not_there.aac" 227 SRC_URI = "http://oe.handhelds.org/not_there.aac"
228 SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac" 228 SRC_URI = "ftp://oe.handhelds.org/not_there_as_well.aac"
@@ -318,7 +318,7 @@ The supported parameters are as follows:
318 318
319- *"port":* The port to which the CVS server connects. 319- *"port":* The port to which the CVS server connects.
320 320
321Some example URLs are as follows: :: 321Some example URLs are as follows::
322 322
323 SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext" 323 SRC_URI = "cvs://CVSROOT;module=mymodule;tag=some-version;method=ext"
324 SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat" 324 SRC_URI = "cvs://CVSROOT;module=mymodule;date=20060126;localdir=usethat"
@@ -360,7 +360,7 @@ The supported parameters are as follows:
360 username is different than the username used in the main URL, which 360 username is different than the username used in the main URL, which
361 is passed to the subversion command. 361 is passed to the subversion command.
362 362
363Following are three examples using svn: :: 363Following are three examples using svn::
364 364
365 SRC_URI = "svn://myrepos/proj1;module=vip;protocol=http;rev=667" 365 SRC_URI = "svn://myrepos/proj1;module=vip;protocol=http;rev=667"
366 SRC_URI = "svn://myrepos/proj1;module=opie;protocol=svn+ssh" 366 SRC_URI = "svn://myrepos/proj1;module=opie;protocol=svn+ssh"
@@ -433,7 +433,7 @@ This fetcher supports the following parameters:
433 parameter implies no branch and only works when the transfer protocol 433 parameter implies no branch and only works when the transfer protocol
434 is ``file://``. 434 is ``file://``.
435 435
436Here are some example URLs: :: 436Here are some example URLs::
437 437
438 SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1" 438 SRC_URI = "git://git.oe.handhelds.org/git/vip.git;tag=version-1"
439 SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http" 439 SRC_URI = "git://git.oe.handhelds.org/git/vip.git;protocol=http"
@@ -481,7 +481,7 @@ repository.
481 481
482To use this fetcher, make sure your recipe has proper 482To use this fetcher, make sure your recipe has proper
483:term:`SRC_URI`, :term:`SRCREV`, and 483:term:`SRC_URI`, :term:`SRCREV`, and
484:term:`PV` settings. Here is an example: :: 484:term:`PV` settings. Here is an example::
485 485
486 SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module" 486 SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module"
487 SRCREV = "EXAMPLE_CLEARCASE_TAG" 487 SRCREV = "EXAMPLE_CLEARCASE_TAG"
@@ -503,7 +503,7 @@ Following are options for the ``SRC_URI`` statement:
503 The module and vob options are combined to create the load rule in the 503 The module and vob options are combined to create the load rule in the
504 view config spec. As an example, consider the vob and module values from 504 view config spec. As an example, consider the vob and module values from
505 the SRC_URI statement at the start of this section. Combining those values 505 the SRC_URI statement at the start of this section. Combining those values
506 results in the following: :: 506 results in the following::
507 507
508 load /example_vob/example_module 508 load /example_vob/example_module
509 509
@@ -555,7 +555,7 @@ the server's URL and port number, and you can specify a username and
555password directly in your recipe within ``SRC_URI``. 555password directly in your recipe within ``SRC_URI``.
556 556
557Here is an example that relies on ``P4CONFIG`` to specify the server URL 557Here is an example that relies on ``P4CONFIG`` to specify the server URL
558and port, username, and password, and fetches the Head Revision: :: 558and port, username, and password, and fetches the Head Revision::
559 559
560 SRC_URI = "p4://example-depot/main/source/..." 560 SRC_URI = "p4://example-depot/main/source/..."
561 SRCREV = "${AUTOREV}" 561 SRCREV = "${AUTOREV}"
@@ -563,7 +563,7 @@ and port, username, and password, and fetches the Head Revision: ::
563 S = "${WORKDIR}/p4" 563 S = "${WORKDIR}/p4"
564 564
565Here is an example that specifies the server URL and port, username, and 565Here is an example that specifies the server URL and port, username, and
566password, and fetches a Revision based on a Label: :: 566password, and fetches a Revision based on a Label::
567 567
568 P4PORT = "tcp:p4server.example.net:1666" 568 P4PORT = "tcp:p4server.example.net:1666"
569 SRC_URI = "p4://user:passwd@example-depot/main/source/..." 569 SRC_URI = "p4://user:passwd@example-depot/main/source/..."
@@ -589,7 +589,7 @@ paths locally is desirable, the fetcher supports two parameters:
589 paths locally for the specified location, even in combination with the 589 paths locally for the specified location, even in combination with the
590 ``module`` parameter. 590 ``module`` parameter.
591 591
592Here is an example use of the the ``module`` parameter: :: 592Here is an example use of the the ``module`` parameter::
593 593
594 SRC_URI = "p4://user:passwd@example-depot/main;module=source/..." 594 SRC_URI = "p4://user:passwd@example-depot/main;module=source/..."
595 595
@@ -597,7 +597,7 @@ In this case, the content of the top-level directory ``source/`` will be fetched
597to ``${P4DIR}``, including the directory itself. The top-level directory will 597to ``${P4DIR}``, including the directory itself. The top-level directory will
598be accesible at ``${P4DIR}/source/``. 598be accesible at ``${P4DIR}/source/``.
599 599
600Here is an example use of the the ``remotepath`` parameter: :: 600Here is an example use of the the ``remotepath`` parameter::
601 601
602 SRC_URI = "p4://user:passwd@example-depot/main;module=source/...;remotepath=keep" 602 SRC_URI = "p4://user:passwd@example-depot/main;module=source/...;remotepath=keep"
603 603
@@ -625,7 +625,7 @@ This fetcher supports the following parameters:
625 625
626- *"manifest":* Name of the manifest file (default: ``default.xml``). 626- *"manifest":* Name of the manifest file (default: ``default.xml``).
627 627
628Here are some example URLs: :: 628Here are some example URLs::
629 629
630 SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml" 630 SRC_URI = "repo://REPOROOT;protocol=git;branch=some_branch;manifest=my_manifest.xml"
631 SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml" 631 SRC_URI = "repo://REPOROOT;protocol=file;branch=some_branch;manifest=my_manifest.xml"
@@ -648,11 +648,11 @@ Such functionality is set by the variable:
648 delegate access to resources, if this variable is set, the Az Fetcher will 648 delegate access to resources, if this variable is set, the Az Fetcher will
649 use it when fetching artifacts from the cloud. 649 use it when fetching artifacts from the cloud.
650 650
651You can specify the AZ_SAS variable as shown below: :: 651You can specify the AZ_SAS variable as shown below::
652 652
653 AZ_SAS = "se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>" 653 AZ_SAS = "se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"
654 654
655Here is an example URL: :: 655Here is an example URL::
656 656
657 SRC_URI = "az://<azure-storage-account>.blob.core.windows.net/<foo_container>/<bar_file>" 657 SRC_URI = "az://<azure-storage-account>.blob.core.windows.net/<foo_container>/<bar_file>"
658 658