Skip to content

Commit

Permalink
docs/man/git-lfs-migrate: make examples less confusing
Browse files Browse the repository at this point in the history
When invoking git lfs migrate --no-rewrite, we take a list of files, not
a list of patterns. This differs from other situations, and the examples
in the man page don't make this clear, resulting in confusion on the
part of users. Improve the example by making the example commit message
explain the situation a bit better.
  • Loading branch information
bk2204 committed Jan 8, 2019
1 parent ff93312 commit 84f8a14
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/man/git-lfs-migrate.1.ronn
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,8 @@ Note: This will require a force push to any existing Git remotes.
### Migrate without rewriting local history

You can also migrate files without modifying the existing history of your
repository:
repository. Note that in the examples below, files in subdirectories are not
included because they are not explicitly specified.

Without a specified commit message:

Expand All @@ -271,8 +272,9 @@ $ git lfs migrate import --no-rewrite test.zip *.mp3 *.psd
With a specified commit message:

```
$ git lfs migrate import --no-rewrite -m "Import .zip, .mp3, .psd files" \
test.zip *.mpd *.psd
$ git lfs migrate import --no-rewrite \
-m "Import test.zip, .mp3, .psd files in root of repo" \
test.zip *.mp3 *.psd
```

## SEE ALSO
Expand Down

0 comments on commit 84f8a14

Please sign in to comment.