Skip to content

Commit

Permalink
Merge pull request #1818 from iterative/jorge
Browse files Browse the repository at this point in the history
guide: top `md5` field of import `.dvc` files (Metafiles)
  • Loading branch information
jorgeorpinel authored Sep 28, 2020
2 parents 7acceb4 + 6796b4d commit 59487d2
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion content/docs/user-guide/basic-concepts/import-stage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 'Import Stage'
match: ['import stage', 'import stages']
match: ['import stage', 'import stages', 'imports']
---

`.dvc` file created with the `dvc import` or `dvc import-url` commands. They
Expand Down
14 changes: 8 additions & 6 deletions content/docs/user-guide/dvc-files-and-directories.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ Git-enabled <abbr>repositories</abbr>).

## `.dvc` files

When you add a file or directory to a <abbr>DVC project</abbr> with `dvc add` or
`dvc import`, a `.dvc` file is created based on the data file name (e.g.
`data.xml.dvc`). These files contain the information needed to track the data
with DVC.
When you add a file or directory to a <abbr>DVC project</abbr> with `dvc add`,
`dvc import`, or `dvc import-url`, a `.dvc` file is created based on the data
file name (e.g. `data.xml.dvc`). These files contain the information needed to
track the data with DVC.

They use a simple [YAML](https://yaml.org/) format, meant to be easy to read,
edit, or even created manually by users. Here is a full sample:
edit, or even created manually. Here is a sample:

```yaml
outs:
Expand All @@ -50,11 +50,13 @@ meta:
that represent the files or directories tracked with DVC. Typically there is
only one (but several can be added or combined manually).
- `deps`: List of <abbr>dependency</abbr> entries (details below). Only present
when `dvc import` and `dvc import-url` are used to generate this `.dvc` file.
when `dvc import` or `dvc import-url` are used to generate this `.dvc` file.
Typically there is only one (but several can be added manually).
- `wdir`: Working directory for the `outs` and `deps` paths (relative to the
`.dvc` file's location). If this field is not present explicitly, it defaults
to `.` (the `.dvc` file's location).
- `md5`: (only for <abbr>imports</abbr>) MD5 hash of the import `.dvc` file
itself.
- `meta` (optional): Arbitrary metadata can be added manually with this field.
Any YAML contents is supported. `meta` contents are ignored by DVC, but they
can be meaningful for user processes that read `.dvc` files.
Expand Down
7 changes: 6 additions & 1 deletion content/docs/user-guide/merge-conflicts.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ To resolve conflicted `.dvc` files generated by `dvc import` or
`dvc import-url`, remove the conflicted hashes altogether:

```yaml
< < < < < < < HEAD
md5: 263395583f35403c8e0b1b94b30bea32
=======
md5: 520d2602f440d13372435d91d3bfa176
> > > > > > > branch
frozen: true
deps:
- path: get-started/data.xml
Expand Down Expand Up @@ -137,5 +142,5 @@ outs:
And then `dvc update` the `.dvc` file to download the latest data from its
original source.

> Note that updating will bring in the latest version of the data found in its
> Note that updating will bring in the latest version of the data from its
> source, which may not correspond with any of the hashes that was removed.

0 comments on commit 59487d2

Please sign in to comment.