lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: explain shell metacharacters better

Browse Source 
It's a surprise to many users that bracket characters are treated
specially in the shell, especially Windows users or other users who are
not intimately familiar with the various peculiarities of shell.  As a
consequence, users are also surprised when putting brackets into a `git
lfs track` pattern doesn't work as expected.

Let's help these users out by explaining exactly what characters are
special and what are ignored, since folks don't always dive into the Git
attribute documentation.  Let's also provide an example of tracking a
file with brackets in the name to reinforce the use of the `--filename`
option as well.
This commit is contained in:
brian m. carlson 2019-11-15 19:03:28 +00:00
parent 5fcef1bff1
commit 24ba71af7e
No known key found for this signature in database
GPG Key ID: 2D0C9BC12F82B3A1
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/man/git-lfs-track.1.ronn
View File

@ -13,7 +13,10 @@ currently-tracked paths.
The [gitattributes documentation](https://git-scm.com/docs/gitattributes) states
that patterns use the [gitignore pattern rules](https://git-scm.com/docs/gitignore)
to match paths.
to match paths. This means that patterns which contain asterisk (`*`), question
mark (`?`), and the bracket characters (`[` and `]`) are treated specially; to
disable this behavior and treat them literally instead, use `--filename` or
escape the character with a backslash.
## OPTIONS
@ -66,6 +69,10 @@ to match paths.
`git lfs track --lockable "*.psd"`
* Configure Git LFS to track the file named `project [1].psd`:
`git lfs track --filename "project [1].psd"`
## SEE ALSO
git-lfs-untrack(1), git-lfs-install(1), gitattributes(5), gitignore(5).