summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
diff options
context:
space:
mode:
Diffstat (limited to 'bitbake/doc/bitbake-user-manual')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst85
1 files changed, 59 insertions, 26 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index e955beb130..78fb2826a5 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -1333,67 +1333,100 @@ overview of their function and contents.
1333 The list of source files - local or remote. This variable tells 1333 The list of source files - local or remote. This variable tells
1334 BitBake which bits to pull for the build and how to pull them. For 1334 BitBake which bits to pull for the build and how to pull them. For
1335 example, if the recipe or append file needs to fetch a single tarball 1335 example, if the recipe or append file needs to fetch a single tarball
1336 from the Internet, the recipe or append file uses a :term:`SRC_URI` entry 1336 from the Internet, the recipe or append file uses a :term:`SRC_URI`
1337 that specifies that tarball. On the other hand, if the recipe or 1337 entry that specifies that tarball. On the other hand, if the recipe or
1338 append file needs to fetch a tarball and include a custom file, the 1338 append file needs to fetch a tarball, apply two patches, and include
1339 recipe or append file needs an :term:`SRC_URI` variable that specifies 1339 a custom file, the recipe or append file needs an :term:`SRC_URI`
1340 all those sources. 1340 variable that specifies all those sources.
1341 1341
1342 The following list explains the available URI protocols: 1342 The following list explains the available URI protocols. URI
1343 protocols are highly dependent on particular BitBake Fetcher
1344 submodules. Depending on the fetcher BitBake uses, various URL
1345 parameters are employed. For specifics on the supported Fetchers, see
1346 the :ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers`
1347 section.
1343 1348
1344 - ``file://`` : Fetches files, which are usually files shipped 1349 - ``az://`` : Fetches files from an Azure Storage account using HTTPS.
1345 with the metadata, from the local machine. The path is relative to
1346 the :term:`FILESPATH` variable.
1347 1350
1348 - ``bzr://`` : Fetches files from a Bazaar revision control 1351 - ``bzr://`` : Fetches files from a Bazaar revision control
1349 repository. 1352 repository.
1350 1353
1351 - ``git://`` : Fetches files from a Git revision control 1354 - ``ccrc://`` - Fetches files from a ClearCase repository.
1355
1356 - ``cvs://`` : Fetches files from a CVS revision control
1352 repository. 1357 repository.
1353 1358
1354 - ``osc://`` : Fetches files from an OSC (OpenSUSE Build service) 1359 - ``file://`` - Fetches files, which are usually files shipped
1355 revision control repository. 1360 with the Metadata, from the local machine.
1361 The path is relative to the :term:`FILESPATH`
1362 variable. Thus, the build system searches, in order, from the
1363 following directories, which are assumed to be a subdirectories of
1364 the directory in which the recipe file (``.bb``) or append file
1365 (``.bbappend``) resides:
1356 1366
1357 - ``repo://`` : Fetches files from a repo (Git) repository. 1367 - ``${BPN}`` - The base recipe name without any special suffix
1368 or version numbers.
1358 1369
1359 - ``http://`` : Fetches files from the Internet using HTTP. 1370 - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and
1371 version but without any special package name suffix.
1360 1372
1361 - ``https://`` : Fetches files from the Internet using HTTPS. 1373 - *files -* Files within a directory, which is named ``files``
1374 and is also alongside the recipe or append file.
1362 1375
1363 - ``ftp://`` : Fetches files from the Internet using FTP. 1376 - ``ftp://`` : Fetches files from the Internet using FTP.
1364 1377
1365 - ``cvs://`` : Fetches files from a CVS revision control 1378 - ``git://`` : Fetches files from a Git revision control
1366 repository. 1379 repository.
1367 1380
1368 - ``hg://`` : Fetches files from a Mercurial (``hg``) revision 1381 - ``hg://`` : Fetches files from a Mercurial (``hg``) revision
1369 control repository. 1382 control repository.
1370 1383
1384 - ``http://`` : Fetches files from the Internet using HTTP.
1385
1386 - ``https://`` : Fetches files from the Internet using HTTPS.
1387
1388 - ``npm://`` - Fetches JavaScript modules from a registry.
1389
1390 - ``osc://`` : Fetches files from an OSC (OpenSUSE Build service)
1391 revision control repository.
1392
1371 - ``p4://`` : Fetches files from a Perforce (``p4``) revision 1393 - ``p4://`` : Fetches files from a Perforce (``p4``) revision
1372 control repository. 1394 control repository.
1373 1395
1396 - ``repo://`` : Fetches files from a repo (Git) repository.
1397
1374 - ``ssh://`` : Fetches files from a secure shell. 1398 - ``ssh://`` : Fetches files from a secure shell.
1375 1399
1376 - ``svn://`` : Fetches files from a Subversion (``svn``) revision 1400 - ``svn://`` : Fetches files from a Subversion (``svn``) revision
1377 control repository. 1401 control repository.
1378 1402
1379 - ``az://`` : Fetches files from an Azure Storage account using HTTPS.
1380
1381 Here are some additional options worth mentioning: 1403 Here are some additional options worth mentioning:
1382 1404
1383 - ``unpack`` : Controls whether or not to unpack the file if it is 1405 - ``downloadfilename`` : Specifies the filename used when storing
1384 an archive. The default action is to unpack the file. 1406 the downloaded file.
1407
1408 - ``name`` - Specifies a name to be used for association with
1409 :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one
1410 file or git repository specified in :term:`SRC_URI`. For example::
1411
1412 SRC_URI = "git://example.com/foo.git;name=first \
1413 git://example.com/bar.git;name=second \
1414 http://example.com/file.tar.gz;name=third"
1415
1416 SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15"
1417 SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f"
1418 SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de"
1385 1419
1386 - ``subdir`` : Places the file (or extracts its contents) into the 1420 - ``subdir`` : Places the file (or extracts its contents) into the
1387 specified subdirectory. This option is useful for unusual tarballs 1421 specified subdirectory. This option is useful for unusual tarballs
1388 or other archives that do not have their files already in a 1422 or other archives that do not have their files already in a
1389 subdirectory within the archive. 1423 subdirectory within the archive.
1390 1424
1391 - ``name`` : Specifies a name to be used for association with 1425 - ``subpath`` - Limits the checkout to a specific subpath of the
1392 :term:`SRC_URI` checksums when you have more than one file specified 1426 tree when using the Git fetcher is used.
1393 in :term:`SRC_URI`.
1394 1427
1395 - ``downloadfilename`` : Specifies the filename used when storing 1428 - ``unpack`` : Controls whether or not to unpack the file if it is
1396 the downloaded file. 1429 an archive. The default action is to unpack the file.
1397 1430
1398 :term:`SRCDATE` 1431 :term:`SRCDATE`
1399 The date of the source code used to build the package. This variable 1432 The date of the source code used to build the package. This variable