Skip to content

Commit 4f15722

Browse files
committed
doc: reference urlScmSeparateDownload from url scm
1 parent 570d544 commit 4f15722

File tree

2 files changed

+20
-13
lines changed

2 files changed

+20
-13
lines changed

doc/manual/configuration.rst

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1152,17 +1152,22 @@ url
11521152
is performed. This replaces the initial ``~`` or ``~user`` by the *user*’s
11531153
home directory.
11541154

1155-
If a SHA digest is
1156-
given with ``digestSHA1``, ``digestSHA256`` and/or ``digestSHA512``, the
1157-
downloaded file will be checked for a matching hash sum. This also makes the
1158-
URL deterministic for Bob. Otherwise the URL will be checked in each build
1159-
for updates. Based on the file name ending, Bob will try to extract the
1160-
downloaded file. You may prevent this by setting the ``extract`` attribute
1161-
to ``no`` or ``False``. If the heuristic fails, the extraction tool may be
1162-
specified as ``tar``, ``gzip``, ``xz``, ``7z`` or ``zip`` directly. For
1163-
``tar`` files it is possible to strip a configurable number of leading
1164-
components from file names on extraction by the ``stripComponents``
1165-
attribute.
1155+
If a SHA digest is given with ``digestSHA1``, ``digestSHA256`` and/or
1156+
``digestSHA512``, the downloaded file will be checked for a matching hash
1157+
sum. This also makes the URL deterministic for Bob. Otherwise, the URL will
1158+
be checked in each build for updates.
1159+
1160+
Based on the file name ending, Bob will try to extract the downloaded file.
1161+
You may prevent this by setting the ``extract`` attribute to ``no`` or
1162+
``False``. If the heuristic fails, the extraction tool may be specified as
1163+
``tar``, ``gzip``, ``xz``, ``7z`` or ``zip`` directly. For ``tar`` files it
1164+
is possible to strip a configurable number of leading components from file
1165+
names on extraction by the ``stripComponents`` attribute.
1166+
1167+
If the file is extracted, the original file will be kept next to the
1168+
``workspace`` to keep the directory clean. If the
1169+
:ref:`policies-urlScmSeparateDownload` policy is on the old behavour, the
1170+
downloaded file will still be in put the workspace, though.
11661171

11671172
.. note::
11681173
Starting with Bob 0.14 (see :ref:`policies-tidyUrlScm` policy) the whole

doc/manual/policies.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -344,13 +344,15 @@ New behavior
344344

345345
Unmanaged layers are expected in the same directory.
346346

347+
.. _policies-urlScmSeparateDownload:
348+
347349
urlScmSeparateDownload
348350
~~~~~~~~~~~~~~~~~~~~~~
349351

350352
Introduced in: 1.0
351353

352-
This policy controls where bob places downloaded files of UrlScms if extraction is
353-
used.
354+
This policy controls where Bob places downloaded files of ``url`` SCMs if
355+
extraction is used.
354356

355357
Old behavior
356358
The downloaded file could be found in the workspace next to the extracted files.

0 commit comments

Comments
 (0)