Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd: revert changes to note about nested --subdir repos in init #1661

Merged
merged 60 commits into from
Aug 5, 2020
Merged
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
d04f082
cmd: review repro examples
jorgeorpinel Jul 22, 2020
a201abf
cmd: fic tyupo in get-url
jorgeorpinel Jul 22, 2020
f7d1a7e
Merge branch 'master' into jorge
jorgeorpinel Jul 23, 2020
fe8687e
cmd: updates to repro
jorgeorpinel Jul 23, 2020
f3df9d5
cmd: rewrite repro -P desc
jorgeorpinel Jul 23, 2020
ebc1560
cmd: simplified and generalize repro targets desc and DVC file mention
jorgeorpinel Jul 23, 2020
9a8c977
cmd: minor update for repro desc wording
jorgeorpinel Jul 23, 2020
c38ce31
term: don't use "synchronize" in the context of checkout
jorgeorpinel Jul 24, 2020
34217b8
cmd: rewrite Downstream example and added info for sequential executi…
sarthakforwet Jul 24, 2020
a071b7d
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 24, 2020
edff33e
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 24, 2020
71a5088
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 24, 2020
163ed19
cmd: Updated Downstream example
sarthakforwet Jul 25, 2020
cf873a4
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 27, 2020
ca04fb0
repro: Updated Downstream example
sarthakforwet Jul 28, 2020
dded2d7
Merge branch 'repro_misc' of github.com:sarthakforwet/dvc.org into re…
sarthakforwet Jul 28, 2020
30ce7bb
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 29, 2020
66e0603
cmd: updated last para for the description of --downstream and improv…
sarthakforwet Jul 29, 2020
05f0157
Merge branch 'master' into jorge
jorgeorpinel Jul 30, 2020
e532010
cmd: review language of init --subdir
jorgeorpinel Jul 30, 2020
b0fe9c1
term: revuew usage of "granular", esp. around init --subdir
jorgeorpinel Jul 30, 2020
8597f53
repro.md: updated Downstream example
sarthakforwet Jul 30, 2020
8ca9134
cmd: improve init --subdir explanation
jorgeorpinel Jul 30, 2020
8134010
cmd: add info about nested subrepos to init
jorgeorpinel Jul 30, 2020
a5db93f
cmd: fix -P option desc.
jorgeorpinel Jul 31, 2020
40512a1
cmd: improve explanation on how --subdir affects commands
jorgeorpinel Jul 31, 2020
1f77e8f
cmd: simplify nested structures explanation in init
jorgeorpinel Jul 31, 2020
d4bd8f8
Merge branch 'master' into jorge
jorgeorpinel Jul 31, 2020
42b670f
guide: add note aboud `cp` not being a download in external deps
jorgeorpinel Jul 31, 2020
d30bc63
cmd: add note about what --cwd means to repro
jorgeorpinel Jul 31, 2020
0ea4bd3
guide: nvmd! removing that note in external deps
jorgeorpinel Jul 31, 2020
70b7d2a
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
73499f2
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
e40402c
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
1696951
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
bfe6800
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
3a20f21
cmd: more small updates to init
jorgeorpinel Jul 31, 2020
e83bc5d
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
012b72f
Update content/docs/command-reference/repro.md
jorgeorpinel Jul 31, 2020
80d2575
Restyled by prettier
restyled-commits Jul 31, 2020
2d06b22
Merge pull request #1648 from iterative/restyled/pull-1624
jorgeorpinel Jul 31, 2020
a85d8a0
cmd: rewrap metrics diff usage paragraph
jorgeorpinel Aug 3, 2020
38dfee7
Merge branch 'jorge' of github.com:iterative/dvc.org into jorge
jorgeorpinel Aug 3, 2020
fd2a9bb
term: remove "just" from -j desc in 3 refs
jorgeorpinel Aug 3, 2020
8d5adf7
Merge branch 'master' into jorge
jorgeorpinel Aug 5, 2020
221ed75
cmd: add command examples to init --subdir use cases
jorgeorpinel Aug 5, 2020
d14e960
cmd: explain nested repo and projects of all kinds outside of --subdir
jorgeorpinel Aug 5, 2020
5b47bd4
cmd: remove bold names to nested and not-nested structure examples in…
jorgeorpinel Aug 5, 2020
80a0f09
cmd: standardize --jobs option in all refs
jorgeorpinel Aug 5, 2020
5078044
cmd: add speed note to --jobs desc in all refs.
jorgeorpinel Aug 5, 2020
f176872
cmd: change versioning command example in init
jorgeorpinel Aug 5, 2020
cac92e5
cd: change repo comments in init --subdir examples
jorgeorpinel Aug 5, 2020
d1f9d24
cmd: improve note on DVC submodules a little
jorgeorpinel Aug 5, 2020
8d854a1
cmd: better explain why isolation is important in --subdir bullet
jorgeorpinel Aug 5, 2020
be5bc6d
cmd: split last --subdir cases explicitly as 2 bullets
jorgeorpinel Aug 5, 2020
9c3ba77
cmd: remove most notes and code block examples about nesting projects…
jorgeorpinel Aug 5, 2020
33ec1fa
cmd: add basic text about nesting to init
jorgeorpinel Aug 5, 2020
bb52195
Merge branch 'master' into cmd/init/nesting
jorgeorpinel Aug 5, 2020
d834923
cmd: revert nested block examples back into --subdir
jorgeorpinel Aug 5, 2020
6c5903b
cmd: remove new section about nesting to revert more
jorgeorpinel Aug 5, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions content/docs/command-reference/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,43 @@ With `--subdir`, the project root will be found before the Git root, making sure
the scope of DVC commands run here is constrained to this project alone, even if
there are more DVC-related files elsewhere in the repo.

Similarly, DVC commands run outside this project root (if nested inside another
DVC project, for example) will ignore this project's contents completely.
If there are multiple `--subdir` projects, but not nested, e.g.:

```dvc
. # git init
├── .git
├── project-A
│   ├── .dvc # dvc init --subdir
│ ...
├── project-B
│ ├── .dvc # dvc init --subdir
│ ...
```

DVC considers A and B separate projects. Any DVC command run in `project-A` is
not aware of `project-B`. However, commands that involve versioning (like
`dvc diff`, among others) access the commit history from the Git root (`.`).

> `.` is not a DVC project in this case, so most DVC commands can't be run
> there.

If there are nested `--subdir` projects e.g.:

```dvc
project-A
├── .dvc # git init && dvc init
├── .git
├── dvc.yaml
├── ...
├── project-B
│   ├── .dvc # dvc init --subdir
│   ├── data-B.dvc
│ ...
```

Nothing changes for the inner projects. And any DVC command run in the outer one
actively ignores the nested project directories. For example, using `dvc pull`
in `project-A` wouldn't download data for the `data-B.dvc` file.

### Initializing DVC without Git

Expand Down