status: update cmd ref #416
Conversation
There was a problem hiding this comment.
It looks great, thanks @sanidhyamangal ! A put a few comments to address. Among other things:
- There are a few new values for the
dvc statusin 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. |
There was a problem hiding this comment.
@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.
|
@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 |
|
@shcheklein, I have changed the description for the local mode as per your request so kindly review them. I have some questions regarding implementation |
| @@ -38,7 +38,10 @@ 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 | |||
| file system, using two modes `changed checksum` when actual checksum of data | |||
There was a problem hiding this comment.
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.
|
@sanidhyamangal re the 3 - I meant more or less the change you made here iterative/dvc#2111 . |
|
@shcheklein, I have successfully updated the requested changes please go through them. I have also updated the changes from |
| - _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 |
There was a problem hiding this comment.
is it always checksum or something else? cc @efiop
There was a problem hiding this comment.
It should be always 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 |
|
@shcheklein, I have successfully updated all the typo's in the description section. Kindly review them now. |
This comment has been minimized.
This comment has been minimized.
| 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 |
| (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; |
There was a problem hiding this comment.
@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.
| - _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 |
There was a problem hiding this comment.
if you mention checksum everywhere above, let's use checksum here as well, instead of md5
| - _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: |
There was a problem hiding this comment.
some - it's not some, it should be a complete list
There was a problem hiding this comment.
Paraphrased the given line, please review them.
| - _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: |
There was a problem hiding this comment.
some - not some, it should be a complete list
There was a problem hiding this comment.
Paraphrased for this line as well kindly review the changes.
|
@shcheklein I have addressed all the issues and reformed the file based on requested changes. Kindly review the updated version. |
jorgeorpinel
changed the title
| 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: |
There was a problem hiding this comment.
Please end this paragraph in period . not column :
This pull request updates
\static\docs\commands-reference\status.mdfor 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?