add repro --recursive in Repro command reference #396

kurianbenoy · 2019-06-02T01:36:47Z

Fix #367

static/docs/commands-reference/repro.md

shcheklein

looks great, a few things to fix. Thanks! 🎉

kurianbenoy · 2019-06-02T03:07:13Z

@shcheklein why is the build getting failed?

shcheklein · 2019-06-02T03:11:21Z

@kurianbenoy disregard it. We've just enabled it and we need to tune CirlcCI configs to do something meaningful.

shcheklein · 2019-06-05T21:35:32Z

static/docs/commands-reference/pull.md

-  subdirectories for DVC-files to download data for. Along with providing a
-  `target`, or `target` along with `--with-deps` it is yet another way to cut
-  the scope of DVC-files to download.
+- `-R`, `--recursive` - `targets` values is expected to be a directory path


very hard to understand what's going on here. The primary intention of -R is to accept directories and search for the DVC-files inside them. It accepts files along with directories for simplicity. For directories it goes down recursively, for files it behaves in a regular way.

Is the message now ok @shcheklein?

I will make the subsequent changes tomorrow

No, not really :( Can you try to explain me in this thread what this option is about? In a few simple sentences. Like 1, 2, 3 ?

For dvc repro -R

Targets can be a file or directory

What it does is reproduce all stages for specified target

--with-deps cuts scopes of DVC-ffiles being reproduced or staged

When I tried locally, there was no difference in dvc repro and dvc repro -R for a specific target. I don't correctly understand the use case of -R flag. Can you please explain @shcheklein

shcheklein

Hard to understand the explanation
git grep '-R' shows that fetch at least should be changed. Ask on Discord about commit, checkout, and metrics show.

jorgeorpinel · 2019-06-07T06:07:15Z

static/docs/commands-reference/gc.md

@@ -6,7 +6,7 @@ Remove unused objects from cache or remote storage.

 ```usage
 usage: dvc gc [-h] [-q | -v] [-a] [-T] [-c]
-              [-r REMOTE] [-f] [-j JOBS]
+              [-r REMOTE] [-f] [-j JOBS] [- R]


There's a space between - and R.
But anyway, the usage shown with dvc gc -h (latest DVC version: 0.41.3+1e7e2a) is

usage: dvc gc [-h] [-q | -v] [-a] [-T] [-c] [-r REMOTE] [-f] [-j JOBS] [-p [REPOS [REPOS ...]]]

Which doesn't include -R (and doesn't match the current docs 😓 )

Ok and it dvc -R is not mentioned in docs for a no of other commands as well like fetch, status, metrics,gc and somemore.

Thanks. So did you update this usage and remove the -R option from this doc?

Could you please open an issue for the docs that are missing the -R option and need update in their usage blocks?

Opened issue iterative/dvc#2154_

there still a space in this file between - and R

@kurianbenoy Where did you get gc -R from anyways?

static/docs/commands-reference/pull.md

static/docs/commands-reference/push.md

static/docs/commands-reference/repro.md

shcheklein · 2019-06-08T20:15:39Z

static/docs/commands-reference/pull.md

+  or directory, relative to current location(eg.`data/models`). Determines 
+  DVC-files to download data for the target directory. Along with providing a 
+  `target`, and/or `--with-deps` it is yet another way to cut the scope of 
+  DVC-files to download.


@kurianbenoy it's better. can you explain me what does this option mean in your own words, please? :) It's still hard to read, I still don't understand from this description what's going on.

For dvc pull -R

Targets can be a file or directory

What it does is pulls cache for new DVC-files from the subdirectories inside DVC remote storage

--with-deps cuts scopes of files being pulled

All true, but emphasizing it properly is important.

It was made specifically for a case when target is a directory (to search inside them for the DVC-files). It accepts files just for simplicity. So, that you don't have to run a separate command if you have a mix of both. The way we describe it should match to the primary case - when people are looking for a recursive search inside a dir.

It pulls data from the cache to the workspace (and downloads them from remote first if needed, in a way it is described in this document) for data files and directories that are referenced in those DVC-files. I'm not sure I understand the new part in your sentence.

Along with providing a target, and/or --with-deps it is yet another way to cut the scope of DVC-files to download. - let's just remove it completely, I don't see any value in it to be honest.

shcheklein · 2019-06-19T01:35:54Z

static/docs/commands-reference/commit.md

-  named directory, and its subdirectories, for DVC-files for which to commit
-  data. Along with providing a `target`, or `target` along with `--with-deps`,
-  it is yet another way to limit the scope of DVC-files to upload.
+- `-R`, `--recursive` - determines the files to commit cache- by searching the


commit cache-?

Wait... Me again, SORRY.

Actually I DID update this option already. (I had forgotten to push the commit to my PR until now). See for example https://github.com/iterative/dvc.org/pull/441/files#diff-cf1201ba4e234c56d863d0adad07fc7aR82

@jorgeorpinel have you also added -R to repro? That was the original scope of this issue.

seems like you have not added -R option in dvc commit

I had not until now. Added the change o my newest PR now (See #[email protected])

static/docs/commands-reference/commit.md

static/docs/commands-reference/repro.md

static/docs/commands-reference/push.md

shcheklein

Needs more work still. I've sent a comment in private and left a few comments here.

shcheklein · 2019-06-24T18:10:06Z

@kurianbenoy closing it due to inactivity. Let me know if you decide to give it another try, and check @jorgeorpinel latest changes. You might want to just take them as a base for repro -R

shcheklein reviewed Jun 2, 2019

View reviewed changes

static/docs/commands-reference/repro.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 2, 2019

View reviewed changes

static/docs/commands-reference/repro.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 2, 2019

View reviewed changes

static/docs/commands-reference/repro.md Outdated Show resolved Hide resolved

shcheklein requested changes Jun 2, 2019

View reviewed changes

shcheklein reviewed Jun 5, 2019

View reviewed changes

shcheklein requested changes Jun 5, 2019

View reviewed changes

jorgeorpinel reviewed Jun 7, 2019

View reviewed changes

static/docs/commands-reference/pull.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jun 7, 2019

View reviewed changes

static/docs/commands-reference/push.md Outdated Show resolved Hide resolved

jorgeorpinel reviewed Jun 7, 2019

View reviewed changes

static/docs/commands-reference/repro.md Show resolved Hide resolved

jorgeorpinel reviewed Jun 7, 2019

View reviewed changes

static/docs/commands-reference/repro.md Outdated Show resolved Hide resolved

kurianbenoy mentioned this pull request Jun 8, 2019

create glossary #424

Closed

2 tasks

shcheklein reviewed Jun 8, 2019

View reviewed changes

kurianbenoy added 10 commits June 18, 2019 22:38

add repro --recursive in Repro command reference

13779e3

Mention target usage for files

0d71a0e

fix intentation

bbc2858

Mention about new target values for -R in dvc push

fecfa43

Mention about new target values for -R in dvc pull

30e1a12

Modified value of targets

f4b9d40

-R for gc command

5ce14e5

update about targets message in pull command

ba267ed

rephrased -R description of dvc pull

d248f79

rephrased -R description of dvc push

8b568df

kurianbenoy mentioned this pull request Jun 18, 2019

Fix dvc -h usage for dvc gc iterative/dvc#2154

Closed

kurianbenoy added 2 commits June 18, 2019 23:36

Made changes regarding context of usage of dvc -R for some commands

1ee43e9

fix repro -h command list

3f7120b

shcheklein reviewed Jun 19, 2019

View reviewed changes

static/docs/commands-reference/commit.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 19, 2019

View reviewed changes

static/docs/commands-reference/repro.md Outdated Show resolved Hide resolved

shcheklein reviewed Jun 19, 2019

View reviewed changes

static/docs/commands-reference/push.md Outdated Show resolved Hide resolved

shcheklein requested changes Jun 19, 2019

View reviewed changes

update files

3457ad8

shcheklein closed this Jun 24, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add repro --recursive in Repro command reference #396

add repro --recursive in Repro command reference #396

kurianbenoy commented Jun 2, 2019 •

edited

Loading

shcheklein left a comment

kurianbenoy commented Jun 2, 2019

shcheklein commented Jun 2, 2019

shcheklein Jun 5, 2019

kurianbenoy Jun 6, 2019

shcheklein Jun 6, 2019

kurianbenoy Jun 10, 2019

shcheklein left a comment

jorgeorpinel Jun 7, 2019 •

edited

Loading

kurianbenoy Jun 7, 2019

jorgeorpinel Jun 11, 2019

kurianbenoy Jun 18, 2019

shcheklein Jun 19, 2019

efiop Jul 27, 2019

shcheklein Jun 8, 2019

kurianbenoy Jun 10, 2019

shcheklein Jun 10, 2019

shcheklein Jun 19, 2019

This comment was marked as off-topic.

jorgeorpinel Jun 20, 2019

shcheklein Jun 20, 2019

kurianbenoy Jun 21, 2019

jorgeorpinel Jun 25, 2019 •

edited

Loading

shcheklein left a comment

shcheklein commented Jun 24, 2019

add repro --recursive in Repro command reference #396

add repro --recursive in Repro command reference #396

Conversation

kurianbenoy commented Jun 2, 2019 • edited Loading

shcheklein left a comment

Choose a reason for hiding this comment

kurianbenoy commented Jun 2, 2019

shcheklein commented Jun 2, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shcheklein left a comment

Choose a reason for hiding this comment

jorgeorpinel Jun 7, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as off-topic.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Jun 25, 2019 • edited Loading

Choose a reason for hiding this comment

shcheklein left a comment

Choose a reason for hiding this comment

shcheklein commented Jun 24, 2019

kurianbenoy commented Jun 2, 2019 •

edited

Loading

jorgeorpinel Jun 7, 2019 •

edited

Loading

jorgeorpinel Jun 25, 2019 •

edited

Loading