From 50dea4bd83892769f1bce7c909367ff1a4892683 Mon Sep 17 00:00:00 2001 From: karajan1001 Date: Tue, 19 May 2020 22:10:36 +0800 Subject: [PATCH 1/2] Some decription of the rename command fix #1301 --- .../docs/command-reference/remote/rename.md | 61 +++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 content/docs/command-reference/remote/rename.md diff --git a/content/docs/command-reference/remote/rename.md b/content/docs/command-reference/remote/rename.md new file mode 100644 index 0000000000..c0ce27b9d9 --- /dev/null +++ b/content/docs/command-reference/remote/rename.md @@ -0,0 +1,61 @@ +# remote rename + +Rename a data remote. This command affects DVC configuration files only, it does +not physically remove data files stored remotely. + +See also [add](/doc/command-reference/remote/add), +[default](/doc/command-reference/remote/default), +[list](/doc/command-reference/remote/list), and +[modify](/doc/command-reference/remote/modify) commands to manage data remotes. + +## Synopsis + +```usage +usage: dvc remote rename [-h] [--global] [--system] [--local] + [-q | -v] name new + +positional arguments: + name Remote to be renamed + new New name of the remote +``` + +## Description + +Both Remote `name` and `new` are required. + +This command modify a section in the DVC +[config file](/doc/command-reference/config). Alternatively, it is possible to +edit config files manually. + +## Options + +- `--global` - modify remote configuration to the global config (e.g. + `~/.config/dvc/config`) instead of `.dvc/config`. + +- `--system` - modify remote configuration to the system config (e.g. + `/etc/dvc.config`) instead of `.dvc/config`. + +- `--local` - modify a local [config file](/doc/command-reference/config) + instead of `.dvc/config`. It is located in `.dvc/config.local` and is + Git-ignored. + +- `-h`, `--help` - prints the usage/help message, and exit. + +- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no + problems arise, otherwise 1. + +- `-v`, `--verbose` - displays detailed tracing information. + +## Examples + +Add Amazon S3 remote: + +```dvc +$ dvc remote add myremote s3://mybucket/myproject +``` + +Rename it: + +```dvc +$ dvc remote rename myremote mys3remote +``` From 4d261199ea1d2baae08007d35aa4e3d31c951a42 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 19 May 2020 13:44:04 -0500 Subject: [PATCH 2/2] Update content/docs/command-reference/remote/rename.md --- content/docs/command-reference/remote/rename.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/rename.md b/content/docs/command-reference/remote/rename.md index c0ce27b9d9..988dcb5ae6 100644 --- a/content/docs/command-reference/remote/rename.md +++ b/content/docs/command-reference/remote/rename.md @@ -1,6 +1,6 @@ # remote rename -Rename a data remote. This command affects DVC configuration files only, it does +Rename a DVC remote. This command affects DVC configuration files only, it does not physically remove data files stored remotely. See also [add](/doc/command-reference/remote/add),