commit 6b483b319568902f913006779dad34b89cb4c979 from: Stefan Sperling date: Tue Jul 18 13:08:13 2023 UTC reword commit keyword argument descriptions in got.1 for brevity commit - 10d732845e8ec391220bf0cf0b082cf021782965 commit + 6b483b319568902f913006779dad34b89cb4c979 blob - d52a563d452f3ee2fe440e9ab63d1a2b3ddb551f blob + 086e9968300ec8161ed6529d40471881657f0b98 --- got/got.1 +++ got/got.1 @@ -571,19 +571,15 @@ branch will be used. .Pp The expected .Ar commit -argument is a commit ID SHA1 hash or an existing reference -or tag name which will be resolved to a commit ID. +argument is a commit ID SHA1 hash, or a reference name or a keyword +which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used, with both resolving to the -repository's HEAD reference, or, if the +resolve to the repository's HEAD reference, or, if the .Fl b option is used, the head of the checked-out .Ar branch . @@ -740,19 +736,15 @@ branch will be used. .Pp The expected .Ar commit -argument is a commit ID SHA1 hash or an existing reference -or tag name which will be resolved to a commit ID. +argument is a commit ID SHA1 hash, or a reference name or a keyword +which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. Keywords and reference names may be appended with .Qq :+ or @@ -939,19 +931,15 @@ if invoked in a work tree, or to the repository's HEAD .Pp The expected .Ar commit -argument is a commit ID SHA1 hash or an existing reference -or tag name which will be resolved to a commit ID. +argument is a commit ID SHA1 hash, or a reference name or a keyword +which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. @@ -1110,19 +1098,15 @@ arguments are provided, only show differences for the .Pp The expected .Ar commit -argument is a commit ID SHA1 hash or an existing reference -or tag name which will be resolved to a commit ID. +argument is a commit ID SHA1 hash, or a reference name or a keyword +which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. @@ -1408,17 +1392,15 @@ are as follows: .It Fl c Ar commit Make a newly created branch reference point at the specified .Ar commit . -The expected argument is a commit ID SHA1 hash or an existing reference -or tag name which will be resolved to a commit ID. -.Pp -The special -.Ar commit -keywords +The expected argument is a commit ID SHA1 hash, or a reference name or keyword +which will be resolved to a commit ID. +An abbreviated hash argument will be expanded to a full SHA1 hash +automatically, provided the abbreviation is unique. +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. The former is only valid if invoked in a work tree, while the latter will resolve to the tip of the work tree's current branch if invoked in a work tree, otherwise it will resolve to the repository's HEAD reference. @@ -1806,19 +1788,15 @@ than producing merge conflicts in the patched target f .Pp The expected .Ar commit -argument is a commit ID SHA1 hash or an existing reference -or tag name which will be resolved to a commit ID. +argument is a commit ID SHA1 hash, or a reference name or a keyword +which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. Keywords and references may be appended with .Qq :+ or @@ -2293,18 +2271,16 @@ into the work tree. The specified .Ar commit should be on a different branch than the work tree's base commit. -The expected argument is a reference or a commit ID SHA1 hash. +.Pp +The expected argument is a commit ID SHA1 hash, or a reference name or +keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. Keywords and references may be appended with .Qq :+ or @@ -2438,18 +2414,16 @@ into the work tree. The specified .Ar commit should be on the same branch as the work tree's base commit. -The expected argument is a reference or a commit ID SHA1 hash. +.Pp +The expected argument is a commit ID SHA1 hash, or a reference name +or keyword which will be resolved to a commit ID. An abbreviated hash argument will be expanded to a full SHA1 hash automatically, provided the abbreviation is unique. -.Pp -The special -.Ar commit -keywords +The keywords .Qq :base and .Qq :head -can also be used to represent the work tree's base commit -and branch head, respectively. +resolve to the work tree's base commit and branch head, respectively. Keywords and references may be appended with .Qq :+ or