[arvados] updated: 2.7.0-6640-g21beff7a67
git repository hosting
git at public.arvados.org
Fri May 24 21:23:22 UTC 2024
Summary of changes:
doc/sdk/cli/subcommands.html.textile.liquid | 65 ++++++++++++++++++-----------
doc/sdk/fuse/options.html.textile.liquid | 2 +-
sdk/python/arvados/commands/arv_copy.py | 16 ++++++-
3 files changed, 55 insertions(+), 28 deletions(-)
via 21beff7a6713d5a2ea0fc7d9b88bd4c51119d737 (commit)
via 3cd78b814c47f05651e1e607bed7a15f8f29f504 (commit)
from f015f4ce8ac8d3f7334952e3b76713e9400c8536 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 21beff7a6713d5a2ea0fc7d9b88bd4c51119d737
Author: Brett Smith <brett.smith at curii.com>
Date: Fri May 24 17:22:41 2024 -0400
21020: Update web documentation for CLI tools
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/doc/sdk/cli/subcommands.html.textile.liquid b/doc/sdk/cli/subcommands.html.textile.liquid
index dadb1d56c7..22a47b2515 100644
--- a/doc/sdk/cli/subcommands.html.textile.liquid
+++ b/doc/sdk/cli/subcommands.html.textile.liquid
@@ -64,48 +64,63 @@ h3(#arv-copy). arv copy
<notextile>
<pre>
$ <code class="userinput">arv copy --help</code>
-usage: arv_copy.py [-h] [-v] [--progress] [--no-progress] [-f] --src
- SOURCE_ARVADOS --dst DESTINATION_ARVADOS [--recursive]
- [--no-recursive] [--dst-git-repo DST_GIT_REPO]
- [--project-uuid PROJECT_UUID] [--retries RETRIES]
- object_uuid
+usage: arv-copy [-h] [--version] [-v] [--progress] [--no-progress] [-f]
+ [--src SOURCE_ARVADOS] [--dst DESTINATION_ARVADOS]
+ [--recursive] [--no-recursive] [--project-uuid PROJECT_UUID]
+ [--storage-classes STORAGE_CLASSES]
+ [--varying-url-params VARYING_URL_PARAMS]
+ [--prefer-cached-downloads] [--retries RETRIES]
+ object_uuid
-Copy a pipeline instance, template or collection from one Arvados instance to
-another.
+Copy a workflow, collection or project from one Arvados instance to another.
+On success, the uuid of the copied object is printed to stdout.
positional arguments:
object_uuid The UUID of the object to be copied.
optional arguments:
-h, --help show this help message and exit
+ --version Print version and exit.
-v, --verbose Verbose output.
--progress Report progress on copying collections. (default)
--no-progress Do not report progress on copying collections.
-f, --force Perform copy even if the object appears to exist at
the remote destination.
- --src SOURCE_ARVADOS The name of the source Arvados instance (required) -
- points at an Arvados config file. May be either a
- pathname to a config file, or (for example) "foo" as
- shorthand for $HOME/.config/arvados/foo.conf.
+ --src SOURCE_ARVADOS Client configuration location for the source Arvados
+ cluster. May be either a configuration file path, or a
+ plain identifier like `foo` to search for a
+ configuration file `foo.conf` under a systemd or XDG
+ configuration directory. If not provided, will search
+ for a configuration file named after the cluster ID of
+ the source object UUID.
--dst DESTINATION_ARVADOS
- The name of the destination Arvados instance
- (required) - points at an Arvados config file. May be
- either a pathname to a config file, or (for example)
- "foo" as shorthand for $HOME/.config/arvados/foo.conf.
- --recursive Recursively copy any dependencies for this object.
- (default)
- --no-recursive Do not copy any dependencies. NOTE: if this option is
- given, the copied object will need to be updated
- manually in order to be functional.
- --dst-git-repo DST_GIT_REPO
- The name of the destination git repository. Required
- when copying a pipeline recursively.
+ Client configuration location for the destination
+ Arvados cluster. May be either a configuration file
+ path, or a plain identifier like `foo` to search for a
+ configuration file `foo.conf` under a systemd or XDG
+ configuration directory. If not provided, will use the
+ default client configuration from the environment or
+ `settings.conf`.
+ --recursive Recursively copy any dependencies for this object, and
+ subprojects. (default)
+ --no-recursive Do not copy any dependencies or subprojects.
--project-uuid PROJECT_UUID
The UUID of the project at the destination to which
- the pipeline should be copied.
+ the collection or workflow should be copied.
+ --storage-classes STORAGE_CLASSES
+ Comma separated list of storage classes to be used
+ when saving data to the destinaton Arvados instance.
+ --varying-url-params VARYING_URL_PARAMS
+ A comma separated list of URL query parameters that
+ should be ignored when storing HTTP URLs in Keep.
+ --prefer-cached-downloads
+ If a HTTP URL is found in Keep, skip upstream URL
+ freshness check (will not notice if the upstream has
+ changed, but also not error if upstream is
+ unavailable).
--retries RETRIES Maximum number of times to retry server requests that
encounter temporary failures (e.g., server down).
- Default 3.
+ Default 10.
</pre>
</notextile>
diff --git a/doc/sdk/fuse/options.html.textile.liquid b/doc/sdk/fuse/options.html.textile.liquid
index 1ebfa242a5..3b02d058ce 100644
--- a/doc/sdk/fuse/options.html.textile.liquid
+++ b/doc/sdk/fuse/options.html.textile.liquid
@@ -122,7 +122,7 @@ table(table table-bordered table-condensed).
|_. Option(s)|_. Description|
|@--disk-cache@|Cache data on the local filesystem (default)|
|@--ram-cache@|Cache data in memory|
-|@--disk-cache-dir DIRECTORY@|Filesystem cache location (default @~/.cache/arvados/keep@)|
+|@--disk-cache-dir DIRECTORY@|Set custom filesystem cache location|
|@--directory-cache BYTES@|Size of directory data cache in bytes (default 128 MiB)|
|@--file-cache BYTES@|Size of file data cache in bytes (default 8 GiB for filesystem cache, 256 MiB for memory cache)|
commit 3cd78b814c47f05651e1e607bed7a15f8f29f504
Author: Brett Smith <brett.smith at curii.com>
Date: Fri May 24 17:19:05 2024 -0400
21020: Refine arv-copy --src and --dst help
Try to be more explicit about possible values and defaults.
Use Markdown-inspired backticks for literal quotes.
Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith at curii.com>
diff --git a/sdk/python/arvados/commands/arv_copy.py b/sdk/python/arvados/commands/arv_copy.py
index d8efa22556..c03db3c980 100755
--- a/sdk/python/arvados/commands/arv_copy.py
+++ b/sdk/python/arvados/commands/arv_copy.py
@@ -86,10 +86,22 @@ def main():
help='Perform copy even if the object appears to exist at the remote destination.')
copy_opts.add_argument(
'--src', dest='source_arvados',
- help='The cluster id of the source Arvados instance. May be either a pathname to a config file, or (for example) "foo" as shorthand for finding "foo.conf" under a systemd or XDG configuration directory. If not provided, will be inferred from the UUID of the object being copied.')
+ help="""
+Client configuration location for the source Arvados cluster.
+May be either a configuration file path, or a plain identifier like `foo`
+to search for a configuration file `foo.conf` under a systemd or XDG configuration directory.
+If not provided, will search for a configuration file named after the cluster ID of the source object UUID.
+""",
+ )
copy_opts.add_argument(
'--dst', dest='destination_arvados',
- help='The name of the destination Arvados instance. May be either a pathname to a config file, or (for example) "foo" as shorthand for finding "foo.conf" under a systemd or XDG configuration directory. If not provided, will use ARVADOS_API_HOST from environment.')
+ help="""
+Client configuration location for the destination Arvados cluster.
+May be either a configuration file path, or a plain identifier like `foo`
+to search for a configuration file `foo.conf` under a systemd or XDG configuration directory.
+If not provided, will use the default client configuration from the environment or `settings.conf`.
+""",
+ )
copy_opts.add_argument(
'--recursive', dest='recursive', action='store_true',
help='Recursively copy any dependencies for this object, and subprojects. (default)')
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list