status: update cmd ref by sanidhyamangal · Pull Request #416 · treeverse/dvc.org

sanidhyamangal · 2019-06-06T19:19:47Z

This pull request updates \static\docs\commands-reference\status.md for new options, usage examples and synopsis to fix #185.

~~@shcheklein kindly check the changes, I missed optional arguments in the synopsis section so shall I add it in docs?~~

shcheklein

It looks great, thanks @sanidhyamangal ! A put a few comments to address. Among other things:

There are a few new values for the dvc status in the local mode (w/o --cloud or --remote):

        if self.changed_md5():
            ret.append("changed checksum")

        if self.is_callback:
            ret.append("always changed")

description should be updated to include those. Please ask guys on dvc.org/chat #dev-general to explain those values.

In the description changed should be split now into changed outs and changed deps.
Would be great to update the dvc status help message in the dvc repo to make it something like:
An optional list of .dvc files to limit the scope. With -R accepts directories to search .dvc files in.

sanidhyamangal · 2019-06-09T19:47:10Z

It looks great, thanks @sanidhyamangal ! A put a few comments to address. Among other things:

There are a few new values for the dvc status in the local mode (w/o --cloud or --remote):
        if self.changed_md5():
            ret.append("changed checksum")

        if self.is_callback:
            ret.append("always changed")
description should be updated to include those. Please ask guys on dvc.org/chat #dev-general to explain those values.

In the description changed should be split now into changed outs and changed deps.

Would be great to update the dvc status help message in the dvc repo to make it something like:
An optional list of .dvc files to limit the scope. With -R accepts directories to search .dvc files in.

@shcheklein I couldn't get last part, so can you please throw some light on it.

shcheklein

@sanidhyamangal please, read carefully my previous "request for changes" and the comments in this PR. They are not addressed still. If you have any questions, please, ask me here or on Discord.

sanidhyamangal · 2019-06-11T17:49:38Z

@shcheklein I am processing these changes still, need some to figure out exact functionality and reference that can be added into the description. If still, I have some problems I will address them to you on discord

sanidhyamangal · 2019-06-11T18:16:02Z

@shcheklein, I have changed the description for the local mode as per your request so kindly review them.

I have some questions regarding implementation -R flag, posted a query regarding same on discord kindly check that also.

shcheklein · 2019-06-11T23:50:23Z

 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
+file system, using two modes `changed checksum` when actual checksum of data


these are not modes. These are different outputs/statuses. The paragraph that starts with "If instead differences ..." should be updated. Check the list of different outputs that starts line 57-60.

shcheklein · 2019-06-12T00:10:32Z

@sanidhyamangal re the 3 - I meant more or less the change you made here treeverse/dvc#2111 .

shcheklein

please, check the latest comments

sanidhyamangal · 2019-06-12T17:28:46Z

@shcheklein, I have successfully updated the requested changes please go through them. I have also updated the changes from iterative/dvc#2111 and created a pr for the same, so kindly go through it as well iterative/dvc#2121

shcheklein · 2019-06-12T17:39:20Z

+  - _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


is it always checksum or something else? cc @efiop

It should be always changed.

shcheklein · 2019-06-12T17:40:50Z

+  - _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


in the DVC-file

shcheklein

@sanidhyamangal please, see the comments.

sanidhyamangal · 2019-06-12T17:48:07Z

@shcheklein, I have successfully updated all the typo's in the description section. Kindly review them now.

shcheklein · 2019-07-14T21:00:54Z

+      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


exists -> exist

shcheklein · 2019-07-14T21:05:55Z

+    (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:
+    - _new_ : when reference of new dependency files are added into DVC-file;


@efiop just to double check. is it a correct description of this status? can you take a brief look at other statuses as well please.

shcheklein · 2019-07-14T21:10:58Z

+  - _changed outs_ means that there are some changes in output states that are
+    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


if you mention checksum everywhere above, let's use checksum here as well, instead of md5

shcheklein · 2019-07-14T21:13:09Z

+  - _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:


some - it's not some, it should be a complete list

Paraphrased the given line, please review them.

shcheklein · 2019-07-14T21:13:30Z

+    - _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 states are:


some - not some, it should be a complete list

Paraphrased for this line as well kindly review the changes.

shcheklein

it's getting better and better :) please, see the comments

sanidhyamangal · 2019-07-23T17:57:46Z

@shcheklein I have addressed all the issues and reformed the file based on requested changes. Kindly review the updated version.

jorgeorpinel · 2019-07-27T08:55:57Z

+the checksum is shown, and additionally a status word is shown describing the
+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:


Please end this paragraph in period . not column :

Fixed in d0bbaba

sanidhyamangal added 2 commits June 7, 2019 00:28

updated: synopsis for dvc status

917a0f4

updated: simple ussage and deps example for new status outputs

ed5778a

shcheklein reviewed Jun 6, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jun 6, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jun 6, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein suggested changes Jun 6, 2019

View reviewed changes

sanidhyamangal commented Jun 9, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md

sanidhyamangal added 2 commits June 10, 2019 01:21

updated: synopsis for status command

1da8a7e

Merge remote-tracking branch 'upstream/master'

3c92f4e

sanidhyamangal mentioned this pull request Jun 10, 2019

Patch: shared parser target content. treeverse/dvc#2111

Merged

2 tasks

shcheklein suggested changes Jun 11, 2019

View reviewed changes

sanidhyamangal added 3 commits June 11, 2019 23:23

updated: fixed spaces in synopsis section

e327a6e

added: changed checksum and always changed in description of status

59c22ec

Merge remote-tracking branch 'upstream/master'

b219169

shcheklein reviewed Jun 11, 2019

View reviewed changes

shcheklein suggested changes Jun 12, 2019

View reviewed changes

sanidhyamangal added 2 commits June 12, 2019 22:48

updated: local outputs in the status command

0af6ff7

fixed: merge conflict

6c4376d

shcheklein reviewed Jun 12, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jun 12, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jun 12, 2019

View reviewed changes

shcheklein suggested changes Jun 12, 2019

View reviewed changes

updated: some typos

b6e6315

jorgeorpinel reviewed Jul 8, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

sanidhyamangal added 2 commits July 14, 2019 23:21

updated: description of status command lists

62b575d

Merge remote-tracking branch 'upstream/master'

3e41e7d

shcheklein temporarily deployed to dvc-org-pr-416 July 14, 2019 17:53 Inactive

This comment has been minimized.

Sign in to view

shcheklein reviewed Jul 14, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jul 14, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jul 14, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

shcheklein reviewed Jul 14, 2019

View reviewed changes

shcheklein suggested changes Jul 14, 2019

View reviewed changes

jorgeorpinel reviewed Jul 16, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

jorgeorpinel reviewed Jul 16, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md

shcheklein mentioned this pull request Jul 22, 2019

cmd ref: describe update available output (for import stages) in status #477

Closed

sanidhyamangal added 2 commits July 23, 2019 23:18

updated: list of status and description para

750c29e

Merge remote-tracking branch 'upstream/master'

12830f7

shcheklein temporarily deployed to dvc-org-pr-416 July 23, 2019 17:50 Inactive

jorgeorpinel changed the title ~~updated: status docs for new outputs~~ status: update cmd ref Jul 24, 2019

jorgeorpinel reviewed Jul 27, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

jorgeorpinel reviewed Jul 27, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

jorgeorpinel reviewed Jul 27, 2019

View reviewed changes

Comment thread static/docs/commands-reference/status.md Outdated

Update status.md

f1b7d1b

shcheklein deployed to dvc-org-pr-416 July 27, 2019 16:13 View deployment

shcheklein approved these changes Jul 27, 2019

View reviewed changes

shcheklein merged commit 1502b45 into treeverse:master Jul 27, 2019

Conversation

sanidhyamangal commented Jun 6, 2019 • edited by jorgeorpinel Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sanidhyamangal commented Jun 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

sanidhyamangal commented Jun 11, 2019

Uh oh!

sanidhyamangal commented Jun 11, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shcheklein commented Jun 12, 2019

Uh oh!

shcheklein left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanidhyamangal commented Jun 12, 2019

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

efiop Jun 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

sanidhyamangal commented Jun 12, 2019

Uh oh!

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sanidhyamangal commented Jul 23, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanidhyamangal commented Jun 6, 2019 •

edited by jorgeorpinel

Loading

sanidhyamangal commented Jun 9, 2019 •

edited

Loading

shcheklein left a comment •

edited

Loading

efiop Jun 13, 2019 •

edited

Loading