Commit 0db75f06169f5af911de5666bbdcb7a7e65a7285
2019-07-07T13:50:58
document the 'abbreviated SHA1 argument' feature
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
diff --git a/got/got.1 b/got/got.1
index 46a9908..624c27f 100644
--- a/got/got.1
+++ b/got/got.1
@@ -139,6 +139,8 @@ This option requires that all paths in the work tree are updated.
Update the work tree to the specified
.Ar commit .
The expected argument is a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
If this option is not specified, the most recent commit on the work tree's
branch will be used.
.El
@@ -179,6 +181,8 @@ will be omitted.
Start traversing history at the specified
.Ar commit .
The expected argument is the name of a branch or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
If this option is not specified, default to the work tree's current branch
if invoked in a work tree, or to the repository's HEAD reference.
.It Fl C Ar number
@@ -207,6 +211,8 @@ is specified, only show changes within this path.
If two arguments are provided, treat each argument as a reference,
or an object ID SHA1 hash, and display differences between these objects.
Both objects must be of the same type (blobs, trees, or commits).
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.Pp
The options for
.Cm got diff
@@ -234,6 +240,8 @@ are as follows:
Start traversing history at the specified
.Ar commit .
The expected argument is the name of a branch or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.It Fl r Ar repository-path
Use the repository at the specified path.
If not specified, assume the repository is located at or above the current
@@ -266,6 +274,8 @@ are as follows:
List files and directories as they appear in the specified
.Ar commit .
The expected argument is the name of a branch or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.It Fl r Ar repository-path
Use the repository at the specified path.
If not specified, assume the repository is located at or above the current
@@ -288,6 +298,8 @@ and make it point at the given
.Ar target .
The target may be an object ID SHA1 hash or an existing reference which
will be resolved to an object ID.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.Pp
The options for
.Cm got ref
@@ -415,6 +427,8 @@ The specified
.Ar commit
must be on a different branch than the work tree's base commit.
The expected argument is a reference or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.Pp
Show the status of each affected file, using the following status codes:
.Bl -column YXZ description
@@ -453,6 +467,8 @@ The specified
.Ar commit
must be on the same branch as the work tree's base commit.
The expected argument is a reference or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.Pp
Show the status of each affected file, using the following status codes:
.Bl -column YXZ description
diff --git a/tog/tog.1 b/tog/tog.1
index aae147e..98b6346 100644
--- a/tog/tog.1
+++ b/tog/tog.1
@@ -127,6 +127,8 @@ are as follows:
Start traversing history at the specified
.Ar commit .
The expected argument is the name of a branch or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
If this option is not specified, default to the work tree's current branch
if invoked in a work tree, or to the repository's HEAD reference.
.It Fl r Ar repository-path
@@ -139,6 +141,8 @@ Display the differences between two objects in the repository.
Each
.Ar object
argument is an object ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
Both objects must be of the same type (blobs, trees, or commits).
If the
.Ar repository path
@@ -214,6 +218,8 @@ are as follows:
Start traversing history at the specified
.Ar commit .
The expected argument is the name of a branch or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.It Fl r Ar repository-path
Use the repository at the specified path.
If not specified, assume the repository is located at or above the current
@@ -267,6 +273,8 @@ are as follows:
Start traversing history at the specified
.Ar commit .
The expected argument is the name of a branch or a commit ID SHA1 hash.
+An abbreviated hash argument will be expanded to a full SHA1 hash
+automatically, provided the abbreviation is unique.
.El
.El
.Sh EXIT STATUS