diff --git a/content/docs/command-reference/get.md b/content/docs/command-reference/get.md index 711b74833a..e177115f6b 100644 --- a/content/docs/command-reference/get.md +++ b/content/docs/command-reference/get.md @@ -9,7 +9,9 @@ directory. ```usage usage: dvc get [-h] [-q | -v] [-o ] [--rev ] - [--show-url] [-j ] [-f] url path + [--show-url] [-j ] [-f] + [--config ] + url path positional arguments: url Location of DVC or Git repository to download from @@ -82,6 +84,9 @@ name. storage location (URL) of the target data. If `path` is a Git-tracked file, this option is ignored. +- `--config ` - path to a [config file](/doc/command-reference/config) that + will be merged with the config in the target repository. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/command-reference/import.md b/content/docs/command-reference/import.md index c28e999990..2f771ad9ba 100644 --- a/content/docs/command-reference/import.md +++ b/content/docs/command-reference/import.md @@ -12,6 +12,7 @@ usage: dvc import [-h] [-q | -v] [-o ] [--rev ] [--no-exec | --no-download] [-j ] + [--config ] url path positional arguments: @@ -118,6 +119,9 @@ file. speed up the operation. Note that the default value can be set in the source repo using the `jobs` config option of `dvc remote modify`. +- `--config ` - path to a [config file](/doc/command-reference/config) that + will be merged with the config in the target repository. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/command-reference/list.md b/content/docs/command-reference/list.md index 7f73d933b3..3a12984a9e 100644 --- a/content/docs/command-reference/list.md +++ b/content/docs/command-reference/list.md @@ -12,6 +12,7 @@ and by Git. ```usage usage: dvc list [-h] [-q | -v] [-R] [--dvc-only] [--json] [--rev []] + [--config ] url [path] positional arguments: @@ -71,6 +72,9 @@ accessed with `dvc get`, `dvc import`, or `dvc.api`. - `--json` - prints the command's output in easily parsable JSON format, instead of a human-readable table. +- `--config ` - path to a [config file](/doc/command-reference/config) that + will be merged with the config in the target repository. + - `-h`, `--help` - prints the usage/help message, and exit. - `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no diff --git a/content/docs/user-guide/project-structure/dvc-files.md b/content/docs/user-guide/project-structure/dvc-files.md index ebddf1c6ab..b408f37115 100644 --- a/content/docs/user-guide/project-structure/dvc-files.md +++ b/content/docs/user-guide/project-structure/dvc-files.md @@ -71,14 +71,15 @@ The following subfields may be present under `deps` entries: | `md5`
`etag`
`checksum` | Only in external dependencies created with `dvc import-url`: Hash value of the imported file or directory. MD5 is used for local paths and SSH; [ETag] for HTTP, S3, GCS, and Azure; and a special _checksum_ for HDFS and WebHDFS. | | `size` | Size of the file or directory (sum of all files). | | `nfiles` | If this dependency is a directory, the number of files inside (recursive). | -| `repo` | Only in external dependencies created with `dvc import`: It can contain `url`, `rev`, and `rev_lock` (detailed below). | +| `repo` | Only in external dependencies created with `dvc import`: It can contain `url`, `rev`, `rev_lock` and `config` (detailed below). | ### Dependency `repo` subfields: -| Field | Description | -| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | URL of Git repository with source DVC project | -| `rev` | Only when `dvc import --rev` is used: Specific commit hash, branch or tag name, etc. (a [Git revision]) used to import the dependency from. | -| `rev_lock` | Git commit hash of the external DVC repository at the time of importing or updating the dependency (with `dvc update`) | +| Field | Description | +| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `url` | URL of Git repository with source DVC project | +| `rev` | Only when `dvc import --rev` is used: Specific commit hash, branch or tag name, etc. (a [Git revision]) used to import the dependency from. | +| `rev_lock` | Git commit hash of the external DVC repository at the time of importing or updating the dependency (with `dvc update`) | +| `config` | Only when `dvc import --config` is used: Path to a [config file](/doc/command-reference/config) that will be merged with the config in the target repository. | [git revision]: https://git-scm.com/docs/revisions