lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
542a6f00de
git-lfs/docs/man/git-lfs-pointer.1.ronn

45 lines
1.4 KiB
Plaintext
Raw Normal View History

commands/command_pointer.go: introduce `--check` option We have used the 'git-lfs-pointer(1)' command historically to compare varying implementation of the Git LFS protocol. This has been done by passing both `--file` and `--stdin` to the command, which will in turn compare the contents of both handles and return appropriately whether they are the same or different. One use case that Git LFS pointer does not yet support directly is _checking_ to see whether a given file is a valid Git LFS pointer. This is a different use-case than before, since we aren't doing any comparison, we're simply checking whether the official implementation of Git LFS can parse a given stream as a pointer. As an aside, one way to do this today is the following: $ git lfs clean < a.txt | git lfs pointer --stdin --file my.ptr Where we first generate a pointer of the file 'a.txt' (via `git-lfs-clean(1)`), and then redirect that to `git-lfs-pointer(1)` against our own file. Let's make this above incantation easier to execute by providing a functionally equivalent `--check` option. Running `git lfs pointer --check` (and passing either `--file`, or `--stdin`) will return either 1 or 0 depending on whether or not the given pointer file was invalid or not.
2019-01-29 22:39:09 +00:00
git-lfs-pointer(1) -- Build, compare, and check pointers
========================================================
add man page for the pointer command
2015-04-22 19:46:06 +00:00
## SYNOPSIS
`git lfs pointer --file=path/to/file`<br>
`git lfs pointer --file=path/to/file --pointer=path/to/pointer`<br>
`git lfs pointer --file=path/to/file --stdin`
commands/command_pointer.go: introduce `--check` option We have used the 'git-lfs-pointer(1)' command historically to compare varying implementation of the Git LFS protocol. This has been done by passing both `--file` and `--stdin` to the command, which will in turn compare the contents of both handles and return appropriately whether they are the same or different. One use case that Git LFS pointer does not yet support directly is _checking_ to see whether a given file is a valid Git LFS pointer. This is a different use-case than before, since we aren't doing any comparison, we're simply checking whether the official implementation of Git LFS can parse a given stream as a pointer. As an aside, one way to do this today is the following: $ git lfs clean < a.txt | git lfs pointer --stdin --file my.ptr Where we first generate a pointer of the file 'a.txt' (via `git-lfs-clean(1)`), and then redirect that to `git-lfs-pointer(1)` against our own file. Let's make this above incantation easier to execute by providing a functionally equivalent `--check` option. Running `git lfs pointer --check` (and passing either `--file`, or `--stdin`) will return either 1 or 0 depending on whether or not the given pointer file was invalid or not.
2019-01-29 22:39:09 +00:00
`git lfs pointer --check --file=path/to/file`
add man page for the pointer command
2015-04-22 19:46:06 +00:00
## Description
Builds and optionally compares generated pointer files to ensure consistency
between different Git LFS implementations.
## OPTIONS
* `--file`:
A local file to build the pointer from.
* `--pointer`:
A local file including the contents of a pointer generated from another
implementation. This is compared to the pointer generated from `--file`.
* `--stdin`:
Reads the pointer from STDIN to compare with the pointer generated from
`--file`.
commands/command_pointer.go: introduce `--check` option We have used the 'git-lfs-pointer(1)' command historically to compare varying implementation of the Git LFS protocol. This has been done by passing both `--file` and `--stdin` to the command, which will in turn compare the contents of both handles and return appropriately whether they are the same or different. One use case that Git LFS pointer does not yet support directly is _checking_ to see whether a given file is a valid Git LFS pointer. This is a different use-case than before, since we aren't doing any comparison, we're simply checking whether the official implementation of Git LFS can parse a given stream as a pointer. As an aside, one way to do this today is the following: $ git lfs clean < a.txt | git lfs pointer --stdin --file my.ptr Where we first generate a pointer of the file 'a.txt' (via `git-lfs-clean(1)`), and then redirect that to `git-lfs-pointer(1)` against our own file. Let's make this above incantation easier to execute by providing a functionally equivalent `--check` option. Running `git lfs pointer --check` (and passing either `--file`, or `--stdin`) will return either 1 or 0 depending on whether or not the given pointer file was invalid or not.
2019-01-29 22:39:09 +00:00
* `--check`:
Reads the pointer from STDIN (if `--stdin` is given) or the filepath (if
`--file`) is given. If neither or both of `--stdin` and `--file` are given,
the invocation is invalid. Exits 0 if the data read is a valid Git LFS
pointer. Exits 1 otherwise.
commands/pointer: add an option for strict checking Currently we process pointers in a rather lax way and accept a variety of non-canonical pointers, such as those with CRLF line endings or a size value of 0 (which should be an empty file instead). However, we have a flag to indicate whether the pointer is canonical when parsing it, so let's add a --strict flag so that we can allow people to reject non-canonical pointers. Note that while strictness is not the default, we add a --no-strict flag as well so we can allow people to use it now and change the default at a later time (probably 4.0).
2021-06-02 21:10:40 +00:00
* `--strict`:
* `--no-strict`:
In conjunction with `--check`, `--strict` verifies that the pointer is
canonical; that is, it would be the one created by Git LFS. If it is not,
exits 2. The default, for backwards compatibility, is `--no-strict`, but
this may change in a future version.
add man page for the pointer command
2015-04-22 19:46:06 +00:00
## SEE ALSO
Part of the git-lfs(1) suite.
Reference in New Issue Copy Permalink