From 917a0f4bcffcd4a16ae2a31d1bc875a8a457f824 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Fri, 7 Jun 2019 00:28:53 +0530 Subject: [PATCH 01/26] updated: synopsis for dvc status --- static/docs/commands-reference/status.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index ce6c581e9d..20bd89ec82 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -6,12 +6,15 @@ cache and local files, or between the local cache and remote cache. ## Synopsis ```usage -usage: dvc status [-h] [-q | -v] [-j JOBS] [--show-checksums] - [-c] [-r REMOTE] [-a] [-T] [-d] +usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [-q] [-c] [-r REMOTE] + [-a] [-T] [-d] [targets [targets ...]] +Show changed states, compare local cache and remote storage. +documentation: https://man.dvc.org/status + positional arguments: - targets Limit the scope to these stage files. + targets DVC files. ``` ## Description From ed5778adcd374e996b56e7fb1bba0f6858cabac6 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Fri, 7 Jun 2019 00:43:00 +0530 Subject: [PATCH 02/26] updated: simple ussage and deps example for new status outputs --- static/docs/commands-reference/status.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 20bd89ec82..6bccc428f8 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -120,14 +120,14 @@ cache. For the typical process to update workspaces, see ```dvc $ dvc status - bar.dvc - outs - changed: bar - deps - changed: foo - foo.dvc - outs - changed: foo +bar.dvc: + changed deps: + changed: bar + changed outs: + changed: foo +foo.dvc + changed outs: + changed: foo ``` This shows that for `bar.dvc` the dependency, `foo`, has changed, and the @@ -145,8 +145,8 @@ Pipeline is up to date. Nothing to reproduce. $ dvc status model.p.dvc --with-deps matrix-train.p.dvc - deps - changed: code/featurization.py + changed deps: + changed: code/featurization.py ``` If the `dvc status` command is limited to a target that had no changes, result From 1da8a7e18dab8ae4087ec768367d8587d5a573da Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Mon, 10 Jun 2019 01:21:17 +0530 Subject: [PATCH 03/26] updated: synopsis for status command --- static/docs/commands-reference/status.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 6bccc428f8..c8f43bfc3f 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -10,11 +10,8 @@ usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [-q] [-c] [-r REMOTE] [-a] [-T] [-d] [targets [targets ...]] -Show changed states, compare local cache and remote storage. -documentation: https://man.dvc.org/status - positional arguments: - targets DVC files. + targets Limit the scope to these stage files. ``` ## Description From e327a6eb51679f559c185f554c150d75c4c885dc Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Tue, 11 Jun 2019 23:23:21 +0530 Subject: [PATCH 04/26] updated: fixed spaces in synopsis section --- static/docs/commands-reference/status.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index c8f43bfc3f..9c90b434cf 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -6,8 +6,8 @@ cache and local files, or between the local cache and remote cache. ## Synopsis ```usage -usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [-q] [-c] [-r REMOTE] - [-a] [-T] [-d] +usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] + [-q] [-c] [-r REMOTE] [-a] [-T] [-d] [targets [targets ...]] positional arguments: @@ -38,8 +38,8 @@ stages that affect the target stage. In the `local` mode, changes are detected through the checksum of every file listed in every stage file in the pipeline against the corresponding file in the -file system. The output indicates the detected changes, if any. If no -differences are detected, `dvc status` prints this message: +file system, there are two modes . The output indicates the detected changes, if +any. If no differences are detected, `dvc status` prints this message: ```dvc $ dvc status From 59c22ec91df85f9b1d2beb0bff3ef446d4a7aa19 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Tue, 11 Jun 2019 23:31:18 +0530 Subject: [PATCH 05/26] added: changed checksum and always changed in description of status --- static/docs/commands-reference/status.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 9c90b434cf..d6a590bb78 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -38,8 +38,11 @@ stages that affect the target stage. In the `local` mode, changes are detected through the checksum of every file listed in every stage file in the pipeline against the corresponding file in the -file system, there are two modes . The output indicates the detected changes, if -any. If no differences are detected, `dvc status` prints this message: +file system, using two modes `changed checksum` when actual checksum of data +dosen't match specified in dvc files and `always changed` a special dvc file +with no dependencies, always considered changed and will be reproduced with +`dvc repro`. The output indicates the detected changes, if any. If no +differences are detected, `dvc status` prints this message: ```dvc $ dvc status From 0af6ff75e824d9904b8ee52c2d74d5443e33d802 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Wed, 12 Jun 2019 22:48:39 +0530 Subject: [PATCH 06/26] updated: local outputs in the status command --- static/docs/commands-reference/status.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index d6a590bb78..4b1f69c036 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -38,10 +38,7 @@ stages that affect the target stage. In the `local` mode, changes are detected through the checksum of every file listed in every stage file in the pipeline against the corresponding file in the -file system, using two modes `changed checksum` when actual checksum of data -dosen't match specified in dvc files and `always changed` a special dvc file -with no dependencies, always considered changed and will be reproduced with -`dvc repro`. The output indicates the detected changes, if any. If no +file system. The output indicates the detected changes, if any. If no differences are detected, `dvc status` prints this message: ```dvc @@ -58,7 +55,12 @@ listed. For each item listed, either the file name or the checksum is shown, and additionally a status word is shown describing the change: - For the local workspace: - - _changed_ means the named file has changed + - _changed deps_ means the named file has changed dependencies + - _changed outs_ means the named file has changed outputs + - _changed checksum_ means actual check sum of data dosen't match specified in + dvc files + - _always checksum_ means special dvc file with no dependencies, considered + always changed - For comparison against a remote cache: - _new_ means the file exists in the local cache but not the remote cache - _deleted_ means the file does not exist in the local cache, and exists in From b6e63153c01e3a2bc61057b8cd6abb30885f3572 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Wed, 12 Jun 2019 23:16:38 +0530 Subject: [PATCH 07/26] updated: some typos --- static/docs/commands-reference/status.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 9467e261a8..59806b0a5a 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -12,7 +12,7 @@ usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [targets [targets ...]] positional arguments: - targets DVC files. + targets Limit the scope to these stage files. ``` ## Description @@ -58,8 +58,8 @@ shown, and additionally a status word is shown describing the change: - For the local workspace: - _changed deps_ means the named file has changed dependencies - _changed outs_ means the named file has changed outputs - - _changed checksum_ means actual check sum of data dosen't match specified in - dvc files + - _changed checksum_ means actual checksum of the file doesn't match specified + in DVC-files - _always checksum_ means special dvc file with no dependencies, considered always changed - For comparison against a remote cache: From 2ab46f7d31f099ce85b7bb18aa22eb8f807eba5f Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 13 Jun 2019 23:31:35 +0530 Subject: [PATCH 08/26] Update static/docs/commands-reference/status.md Co-Authored-By: Ruslan Kuprieiev --- static/docs/commands-reference/status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 59806b0a5a..2e258eced2 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -58,7 +58,7 @@ shown, and additionally a status word is shown describing the change: - For the local workspace: - _changed deps_ means the named file has changed dependencies - _changed outs_ means the named file has changed outputs - - _changed checksum_ means actual checksum of the file doesn't match specified + - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it in DVC-files - _always checksum_ means special dvc file with no dependencies, considered always changed From e15308ac57736e26854261a0c30370c4f0293e8d Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 13 Jun 2019 23:32:06 +0530 Subject: [PATCH 09/26] Update static/docs/commands-reference/status.md Co-Authored-By: Ruslan Kuprieiev --- static/docs/commands-reference/status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 2e258eced2..081d2a951b 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -56,7 +56,7 @@ differ are listed. For each item listed, either the file name or the checksum is shown, and additionally a status word is shown describing the change: - For the local workspace: - - _changed deps_ means the named file has changed dependencies + - _changed deps_ means the DVC-file has changed dependencies - _changed outs_ means the named file has changed outputs - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it in DVC-files From ba9406a1084ca02a687cc620653021624c12e196 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 13 Jun 2019 23:32:19 +0530 Subject: [PATCH 10/26] Update static/docs/commands-reference/status.md Co-Authored-By: Ruslan Kuprieiev --- static/docs/commands-reference/status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 081d2a951b..d3afbd0556 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -57,7 +57,7 @@ shown, and additionally a status word is shown describing the change: - For the local workspace: - _changed deps_ means the DVC-file has changed dependencies - - _changed outs_ means the named file has changed outputs + - _changed outs_ means the DVC-file has changed outputs - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it in DVC-files - _always checksum_ means special dvc file with no dependencies, considered From df8dfed8ee2c231f1052d880e23dc74397036a2d Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 13 Jun 2019 23:32:33 +0530 Subject: [PATCH 11/26] Update static/docs/commands-reference/status.md Co-Authored-By: Ruslan Kuprieiev --- static/docs/commands-reference/status.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index d3afbd0556..e606cfaf85 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -60,7 +60,7 @@ shown, and additionally a status word is shown describing the change: - _changed outs_ means the DVC-file has changed outputs - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it in DVC-files - - _always checksum_ means special dvc file with no dependencies, considered + - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed - For comparison against a remote cache: - _new_ means the file exists in the local cache but not the remote cache From 89d230325b65494d6e52639917e9a6d9f75b70dc Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 13 Jun 2019 23:51:51 +0530 Subject: [PATCH 12/26] updated: example dependencies in status --- static/docs/commands-reference/status.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index e606cfaf85..d034f3a4c8 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -58,10 +58,10 @@ shown, and additionally a status word is shown describing the change: - For the local workspace: - _changed deps_ means the DVC-file has changed dependencies - _changed outs_ means the DVC-file has changed outputs - - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it - in DVC-files - - _always changed_ means that this is a special DVC-file with no dependencies, which is considered - always changed + - _changed checksum_ means actual checksum of the DVC-file doesn't match the + one specified in it in DVC-files + - _always changed_ means that this is a special DVC-file with no dependencies, + which is considered always changed - For comparison against a remote cache: - _new_ means the file exists in the local cache but not the remote cache - _deleted_ means the file does not exist in the local cache, and exists in @@ -125,12 +125,15 @@ $ dvc status bar.dvc: changed deps: - changed: bar + modified: bar changed outs: - changed: foo + not in cache: foo foo.dvc changed outs: - changed: foo + deleted: foo +prepare.dvc + changed outs: + new: bar ``` This shows that for `bar.dvc` the dependency, `foo`, has changed, and the @@ -149,7 +152,7 @@ Pipeline is up to date. Nothing to reproduce. $ dvc status model.p.dvc --with-deps matrix-train.p.dvc changed deps: - changed: code/featurization.py + modified: code/featurization.py ``` If the `dvc status` command is limited to a target that had no changes, result From bab634cfb4e354218bbd91789bee9e9a3703a381 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Fri, 14 Jun 2019 00:18:39 +0530 Subject: [PATCH 13/26] added: new status for local description --- static/docs/commands-reference/status.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index d034f3a4c8..193349d48f 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -62,6 +62,10 @@ shown, and additionally a status word is shown describing the change: one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed + - _new_ means the DVC-file has been created but not added into local cache + - _modified_ means the dependecies and output is changed in the DVC-file + - _deleted_ means the DVC-file has been deleted from local cache + - _not in cache_ means the DVC-file no longer exist in local cache - For comparison against a remote cache: - _new_ means the file exists in the local cache but not the remote cache - _deleted_ means the file does not exist in the local cache, and exists in From 4c05eb459269aa997f33dc0bb366f4ef9191c1f3 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Fri, 14 Jun 2019 11:44:18 +0530 Subject: [PATCH 14/26] updated: positional args in status synopsis --- static/docs/commands-reference/status.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 193349d48f..df134e4a79 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -12,7 +12,8 @@ usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [targets [targets ...]] positional arguments: - targets Limit the scope to these stage files. + targets Limit the scope to these stage files. + With -R a directory to search DVC-files in can be specified. ``` ## Description From f74c743a185cc3a867b5a6e257a8aaef2c8d69e3 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Sun, 16 Jun 2019 12:45:50 +0530 Subject: [PATCH 15/26] updated: representation of messages in local description of status --- static/docs/commands-reference/status.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index df134e4a79..5c5aa036b6 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -54,26 +54,31 @@ be rerun if `dvc repro` were executed. If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is -shown, and additionally a status word is shown describing the change: +shown, and additionally a status word is shown describing the changes and and +output displayed: - For the local workspace: + - _changed deps_ means the DVC-file has changed dependencies - _changed outs_ means the DVC-file has changed outputs - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed - - _new_ means the DVC-file has been created but not added into local cache - - _modified_ means the dependecies and output is changed in the DVC-file - - _deleted_ means the DVC-file has been deleted from local cache - - _not in cache_ means the DVC-file no longer exist in local cache + - _new_ output is displayed when a new dependeny or output state is added to + DVC-file + - _modified_ outputs is displayed when any dependencies or output states is + modified in DVC-file + - _deleted_ output is displayed when any exsisting dependencies or output + states are deleted from DVC-file + - _not in cache_ output is displayed when dependencies or output are mentioned + in DVC-file no longer exsist in local cache + - For comparison against a remote cache: - _new_ means the file exists in the local cache but not the remote cache - _deleted_ means the file does not exist in the local cache, and exists in the remote cache -For the _changed_ case, the `dvc repro` command is indicated. - For either the _new_ and _deleted_ cases, the local cache (subset of it, that is determined by the active workspace) is different from the remote cache. Bringing the two into sync requires `dvc pull` or `dvc push` to synchronize the DVC From a7189738171967fdc2f5296ed7dc83e30a72f8b0 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Sun, 16 Jun 2019 13:02:06 +0530 Subject: [PATCH 16/26] updated: content in status --- static/docs/commands-reference/status.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 5c5aa036b6..a7bc8f5ada 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -54,10 +54,9 @@ be rerun if `dvc repro` were executed. If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is -shown, and additionally a status word is shown describing the changes and and -output displayed: +shown, and additionally a status word is shown describing the change: -- For the local workspace: +- For the changes detected in local workspace: - _changed deps_ means the DVC-file has changed dependencies - _changed outs_ means the DVC-file has changed outputs @@ -65,6 +64,9 @@ output displayed: one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed + +- For the output displayed in local workspace: + - _new_ output is displayed when a new dependeny or output state is added to DVC-file - _modified_ outputs is displayed when any dependencies or output states is From 1753c75f67385b6262a716e3872be1d1b7990197 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Sun, 16 Jun 2019 13:03:46 +0530 Subject: [PATCH 17/26] fixed: styling in status description --- static/docs/commands-reference/status.md | 1 + 1 file changed, 1 insertion(+) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 9dfffbad8c..7363999729 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -77,6 +77,7 @@ shown, and additionally a status word is shown describing the change: in DVC-file no longer exsist in local cache - For comparison against a remote cache: + - _new_ means the file exists in the local cache but not the remote cache - _deleted_ means the file doesn't exist in the local cache, but exists in the remote cache From 884d91ce3f6d36de7419db8715ab8661259ce803 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Tue, 18 Jun 2019 00:24:42 +0530 Subject: [PATCH 18/26] updated: list of local description in status --- static/docs/commands-reference/status.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 7363999729..0208a72d65 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -54,9 +54,9 @@ be rerun if `dvc repro` were executed. If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is -shown, and additionally a status word is shown describing the change: +shown, and additionally a status word is shown describing the changes: -- For the changes detected in local workspace: +- For the local workspace: - _changed deps_ means the DVC-file has changed dependencies - _changed outs_ means the DVC-file has changed outputs @@ -64,9 +64,6 @@ shown, and additionally a status word is shown describing the change: one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed - -- For the output displayed in local workspace: - - _new_ output is displayed when a new dependeny or output state is added to DVC-file - _modified_ outputs is displayed when any dependencies or output states is From 73dfbb63b8aa24e4a744dae00162a1a7a7637af9 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 20 Jun 2019 18:35:06 +0530 Subject: [PATCH 19/26] updated: rephrased list of local workspace status commands along with a para --- static/docs/commands-reference/status.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 0208a72d65..31795a7df9 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -54,19 +54,18 @@ be rerun if `dvc repro` were executed. If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is -shown, and additionally a status word is shown describing the changes: +shown, and additionally a status word is shown describing the changes in +checksum or status for both local and cloud workspace: - For the local workspace: - - _changed deps_ means the DVC-file has changed dependencies - - _changed outs_ means the DVC-file has changed outputs - _changed checksum_ means actual checksum of the DVC-file doesn't match the one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed - _new_ output is displayed when a new dependeny or output state is added to DVC-file - - _modified_ outputs is displayed when any dependencies or output states is + - _modified_ output is displayed when any dependencies or output states is modified in DVC-file - _deleted_ output is displayed when any exsisting dependencies or output states are deleted from DVC-file From 363c553b8d76ac26d60d894842dbb6f2af4ab9d0 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Wed, 26 Jun 2019 01:16:19 +0530 Subject: [PATCH 20/26] updated: description for status --- static/docs/commands-reference/status.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 31795a7df9..f775980ab5 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -55,7 +55,8 @@ If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is shown, and additionally a status word is shown describing the changes in -checksum or status for both local and cloud workspace: +checksum or status for both local and cloud workspace. Given list describes +both, status of the DVC-file and differences in the DVC-files: - For the local workspace: @@ -63,14 +64,13 @@ checksum or status for both local and cloud workspace: one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed - - _new_ output is displayed when a new dependeny or output state is added to - DVC-file - - _modified_ output is displayed when any dependencies or output states is - modified in DVC-file - - _deleted_ output is displayed when any exsisting dependencies or output - states are deleted from DVC-file - - _not in cache_ output is displayed when dependencies or output are mentioned - in DVC-file no longer exsist in local cache + - _new_ is displayed when a new dependeny or output state is added to DVC-file + - _modified_ is displayed when any dependencies or output states is modified + in DVC-file + - _deleted_ is displayed when any exsisting dependencies or output states are + deleted from DVC-file + - _not in cache_ is displayed when dependencies or output are mentioned in + DVC-file no longer exsist in local cache - For comparison against a remote cache: From a455852e084cbf7e95e788a97c03956c85973cde Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Wed, 26 Jun 2019 01:18:57 +0530 Subject: [PATCH 21/26] fixed: some gramatical errors in the descriptions --- static/docs/commands-reference/status.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index f775980ab5..bfba457dbc 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -54,9 +54,9 @@ be rerun if `dvc repro` were executed. If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is -shown, and additionally a status word is shown describing the changes in +shown, and additionally, a status word is shown describing the changes in checksum or status for both local and cloud workspace. Given list describes -both, status of the DVC-file and differences in the DVC-files: +both, the status of the DVC-file and differences in the DVC-files: - For the local workspace: From 8c3f4679dc13a4e1db3ed111c3568f99776eb1d4 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Wed, 26 Jun 2019 23:38:48 +0530 Subject: [PATCH 22/26] added: examples of changed checksum and always changed in example of status --- static/docs/commands-reference/status.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index bfba457dbc..07d8b07cdc 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -140,9 +140,11 @@ bar.dvc: foo.dvc changed outs: deleted: foo + changed checksum prepare.dvc changed outs: new: bar + always changed ``` This shows that for `bar.dvc` the dependency, `foo`, has changed, and the From 2ed37495f0cc254a184a16b73ff5976760506390 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Thu, 4 Jul 2019 01:23:45 +0530 Subject: [PATCH 23/26] updated: a hierarchical splitting of list in status description --- static/docs/commands-reference/status.md | 32 +++++++++++++++--------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 60f147f356..5c5c57fa0d 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -52,11 +52,12 @@ This says that no differences were detected, and therefore that no stages would be run again if `dvc repro` were executed. If instead, differences are detected, `dvc status` lists those changes. For each -DVC-file (stage) with differences, the _dependencies_ and/or _outputs_ that -differ are listed. For each item listed, either the file name or the checksum is -shown, and additionally, a status word is shown describing the changes in -checksum or status for both local and cloud workspace. Given list describes -both, the status of the DVC-file and differences in the DVC-files: +DVC-file (stage) with differences, the changes in both _dependencies_ and/or +_outputs_ that differ are listed. For each item listed, either the file name or +the checksum is shown, and additionally, a status word is shown describing the +changes in checksum or status for both local and cloud workspace. Given list +provides a reference to both, the status of the DVC-file and differences in the +DVC-files: - For the local workspace: @@ -64,13 +65,20 @@ both, the status of the DVC-file and differences in the DVC-files: one specified in it in DVC-files - _always changed_ means that this is a special DVC-file with no dependencies, which is considered always changed - - _new_ is displayed when a new dependeny or output state is added to DVC-file - - _modified_ is displayed when any dependencies or output states is modified - in DVC-file - - _deleted_ is displayed when any exsisting dependencies or output states are - deleted from DVC-file - - _not in cache_ is displayed when dependencies or output are mentioned in - DVC-file no longer exsist in local cache + - _changed deps_ means that there are some changes in dependencies that are + incorporated in the DVC-file, some of the prominent states are: + - _new_ : when new dependencies are added into DVC-file + - _modified_ : when an exsisting dependencies are modified in DVC-file + - _deleted_ : when an exsisting dependencies are removed from DVC-file + - _not in cache_ : when dependencies mentioned in DVC-file no longer exsists + in local cache + - _changed outs_ means that there are some changes in output states that are + incorporated in the DVC-file, some of the prominent states are: + - _new_ : when new outputs are added into DVC-file + - _modified_ : when an exsisting outputs are modified in DVC-file + - _deleted_ : when an exsisting outputs are removed from DVC-file + - _not in cache_ : when outputs mentioned in DVC-file no longer exsists in + local cache - For comparison against a remote cache: From 62b575d7779c98869eb6e5453f4a89908959a073 Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Sun, 14 Jul 2019 23:21:48 +0530 Subject: [PATCH 24/26] updated: description of status command lists --- static/docs/commands-reference/status.md | 47 +++++++++++++----------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 1eadefc2a5..c6c2289a67 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -50,42 +50,45 @@ detected, `dvc status` prints this message: ``` This says that no differences were detected, and therefore that no stages would -be run again if `dvc repro` were executed. +be run again by `dvc repro`. If instead, differences are detected, `dvc status` lists those changes. For each -DVC-file (stage) with differences, the changes in both _dependencies_ and/or +DVC-file (stage) with differences, the changes in _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or -the checksum is shown, and additionally, a status word is shown describing the -changes in checksum or status for both local and cloud workspace. Given list -provides a reference to both, the status of the DVC-file and differences in the -DVC-files: +the checksum is shown, and additionally a status word is shown describing the +changes in checksum or status. Given list provides a reference to both, the +status of the DVC-file and differences in the DVC-files: - For the local workspace: - - _changed checksum_ means actual checksum of the DVC-file doesn't match the - one specified in it in DVC-files - - _always changed_ means that this is a special DVC-file with no dependencies, - which is considered always changed + - _changed checksum_ means actual checksum of the files present in workspace + doesn't match the one saved in DVC-files; + - _always changed_ means that this is a special DVC-file with no dependencies + (orphans), which is considered always changed; - _changed deps_ means that there are some changes in dependencies that are - incorporated in the DVC-file, some of the prominent states are: - - _new_ : when new dependencies are added into DVC-file - - _modified_ : when an exsisting dependencies are modified in DVC-file - - _deleted_ : when an exsisting dependencies are removed from DVC-file + incorporated in the DVC-file, some of the states are: + - _new_ : when reference of new dependency files are added into DVC-file; + - _modified_ : when md5 of an exsisting dependencies are changed in + workspace but not reflected in the DVC-file; + - _deleted_ : when an exsisting dependencies are removed from the workspace + but still referred in the DVC-file; - _not in cache_ : when dependencies mentioned in DVC-file no longer exsists - in local cache + in local cache; - _changed outs_ means that there are some changes in output states that are - incorporated in the DVC-file, some of the prominent states are: - - _new_ : when new outputs are added into DVC-file - - _modified_ : when an exsisting outputs are modified in DVC-file - - _deleted_ : when an exsisting outputs are removed from DVC-file + incorporated in the DVC-file, some of the states are: + - _new_ : when reference of new output files are are added into DVC-file; + - _modified_ : when md5 of an exsisting outputs are changed in workspace but + not reflected in the DVC-file; + - _deleted_ : when an exsisting outputs are removed from the workspace but + still referred in the DVC-file; - _not in cache_ : when outputs mentioned in DVC-file no longer exsists in - local cache + local cache; - For comparison against a remote cache: - - _new_ means the file exists in the local cache but not the remote cache + - _new_ means the file exists in the local cache but not the remote cache; - _deleted_ means the file doesn't exist in the local cache, but exists in the - remote cache + remote cache; For either the _new_ and _deleted_ cases, the local cache (subset of it, that is determined by the active workspace) is different from the remote cache. Bringing From 750c29e7e2d93f610041aeed2f2dada705d4abcb Mon Sep 17 00:00:00 2001 From: Sanidhya Mangal Date: Tue, 23 Jul 2019 23:18:23 +0530 Subject: [PATCH 25/26] updated: list of status and description para --- static/docs/commands-reference/status.md | 34 ++++++++++++------------ 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index c6c2289a67..47607bab17 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -7,9 +7,8 @@ cache and remote cache. ## Synopsis ```usage -usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] - [-q] [-c] [-r REMOTE] [-a] [-T] [-d] - [targets [targets ...]] +usage: dvc status [-h] [-v] [-j JOBS] [--show-checksums] [-q] [-c] + [-r REMOTE] [-a] [-T] [-d] [targets [targets ...]] positional arguments: targets Limit command scope to these DVC-files. Using -R, @@ -49,39 +48,40 @@ detected, `dvc status` prints this message: Pipeline is up to date. Nothing to reproduce. ``` -This says that no differences were detected, and therefore that no stages would +This indicates that no differences were detected, and therefore no stages would be run again by `dvc repro`. If instead, differences are detected, `dvc status` lists those changes. For each DVC-file (stage) with differences, the changes in _dependencies_ and/or _outputs_ that differ are listed. For each item listed, either the file name or the checksum is shown, and additionally a status word is shown describing the -changes in checksum or status. Given list provides a reference to both, the -status of the DVC-file and differences in the DVC-files: +changes. This changes list provides a reference to both the status of a +DVC-file, as well as the changes to individual dependencies and outputs +described in it: - For the local workspace: - - _changed checksum_ means actual checksum of the files present in workspace - doesn't match the one saved in DVC-files; + - _changed checksum_ means that the update checksum of the data doesn't match + the one saved in the DVC-files; - _always changed_ means that this is a special DVC-file with no dependencies (orphans), which is considered always changed; - - _changed deps_ means that there are some changes in dependencies that are - incorporated in the DVC-file, some of the states are: + - _changed deps_ means that some changes in dependencies are incorporated in + the DVC-file, all these states are: - _new_ : when reference of new dependency files are added into DVC-file; - - _modified_ : when md5 of an exsisting dependencies are changed in + - _modified_ : when checksum of an exsisting dependencies are changed in workspace but not reflected in the DVC-file; - _deleted_ : when an exsisting dependencies are removed from the workspace but still referred in the DVC-file; - - _not in cache_ : when dependencies mentioned in DVC-file no longer exsists + - _not in cache_ : when dependencies mentioned in DVC-file no longer exsist in local cache; - - _changed outs_ means that there are some changes in output states that are - incorporated in the DVC-file, some of the states are: + - _changed outs_ means that some changes in output states are incorporated in + the DVC-file, all these states are: - _new_ : when reference of new output files are are added into DVC-file; - - _modified_ : when md5 of an exsisting outputs are changed in workspace but - not reflected in the DVC-file; + - _modified_ : when checksum of an exsisting outputs are changed in + workspace but not reflected in the DVC-file; - _deleted_ : when an exsisting outputs are removed from the workspace but still referred in the DVC-file; - - _not in cache_ : when outputs mentioned in DVC-file no longer exsists in + - _not in cache_ : when outputs mentioned in DVC-file no longer exsist in local cache; - For comparison against a remote cache: From f1b7d1bb687826cd2979b7fdc96cdc6008060e44 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sat, 27 Jul 2019 09:13:23 -0700 Subject: [PATCH 26/26] Update status.md --- static/docs/commands-reference/status.md | 62 ++++++++++++------------ 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/static/docs/commands-reference/status.md b/static/docs/commands-reference/status.md index 0b9d331579..3c1210c99d 100644 --- a/static/docs/commands-reference/status.md +++ b/static/docs/commands-reference/status.md @@ -45,7 +45,7 @@ detected, `dvc status` prints this message: ```dvc $ dvc status - Pipeline is up to date. Nothing to reproduce. + Pipelines are up to date. Nothing to reproduce. ``` This indicates that no differences were detected, and therefore no stages would @@ -59,36 +59,36 @@ changes. This changes list provides a reference to both the status of a DVC-file, as well as the changes to individual dependencies and outputs described in it: -- For the local workspace: - - - _changed checksum_ means that the update checksum of the data doesn't match - the one saved in the DVC-files; - - _always changed_ means that this is a special DVC-file with no dependencies - (orphans), which is considered always changed; - - _changed deps_ means that some changes in dependencies are incorporated in - the DVC-file, all these states are: - - _new_ : when reference of new dependency files are added into DVC-file; - - _modified_ : when checksum of an exsisting dependencies are changed in - workspace but not reflected in the DVC-file; - - _deleted_ : when an exsisting dependencies are removed from the workspace - but still referred in the DVC-file; - - _not in cache_ : when dependencies mentioned in DVC-file no longer exsist - in local cache; - - _changed outs_ means that some changes in output states are incorporated in - the DVC-file, all these states are: - - _new_ : when reference of new output files are are added into DVC-file; - - _modified_ : when checksum of an exsisting outputs are changed in - workspace but not reflected in the DVC-file; - - _deleted_ : when an exsisting outputs are removed from the workspace but - still referred in the DVC-file; - - _not in cache_ : when outputs mentioned in DVC-file no longer exsist in - local cache; - -- For comparison against a remote cache: - - - _new_ means the file exists in the local cache but not the remote cache; - - _deleted_ means the file doesn't exist in the local cache, but exists in the - remote cache; +- _changed checksum_ means that the DVC-file checksum has changed + (e.g. someone manually edited the file) + +- _always changed_ means that this is a special DVC-file with no dependencies + (orphans), which is considered always changed and is always executed by `dvc + repro` + +- _changed deps_ or _changed outs_ means that there are changes in dependencies + or outputs defined by the DVC-file. Depending on the use case, + commands like `dvc commit` or `dvc repro`, `dvc run` should be run to update + the file. Possible states are: + + - _new_: output exists in workspace, but there is no corresponding checksum + calculated and saved in the DVC-file for this output yet + + - _modified_: output or dependency exists in workspace, but the + corresponding checksum in the DVC-file is not up to date + + - _deleted_: output or dependency does not exist in workspace, but still + referred in the DVC-file + + - _not in cache_: output exists in workspace and the corresponding checksum + in the DVC-file is up to date, but there is no corresponding + cache entry + +**For comparison against a remote cache:** + +- _new_ means the file exists in the local cache but not the remote cache +- _deleted_ means the file doesn't exist in the local cache, but exists in the + remote cache For either the _new_ and _deleted_ cases, the local cache (subset of it, that is determined by the active workspace) is different from the remote cache. Bringing