Skip to content

Commit 09520cb

Browse files
committed
docs: fix patch locator descriptions
- Identify that patchname is optional in [<patchname>]~[<n>], like it is for [<patchname>]+[<n>]. - Fix reference to git <rev>~[<n>]. - Describe ^ in terms of last visible patch instead of last unapplied patch. The former is more accurate.
1 parent adfe454 commit 09520cb

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Documentation/stg.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,13 @@ The complete syntax for locating patches follows:
118118
Refers to the topmost applied patch, or the base of the stack if no
119119
patches are applied.
120120

121-
'<patchname>{tilde}[<n>]', e.g. 'patch{tilde}', 'patch{tilde}3'::
122-
The <n>th previous patch from the named patch. A single '{tilde}'
123-
represents the first previous patch. Multiple '{tilde}' may be
124-
specified, e.g. 'patch{tilde}{tilde}{tilde}' is the same as
125-
'patch{tilde}3'. This is similar to git's revision syntax where
126-
'<rev>^[<n>]' means the <n>th ancestor commit from <rev> following
127-
first parents.
121+
'[<patchname>]{tilde}[<n>]', e.g. '{tilde}2', 'patch{tilde}', 'patch{tilde}3'::
122+
The <n>th previous patch from the named patch. If <patchname> is not
123+
supplied, '@' is implied. A single '{tilde}' represents the first
124+
previous patch. Multiple '{tilde}' may be specified, e.g.
125+
'patch{tilde}{tilde}{tilde}' is the same as 'patch{tilde}3'. This is
126+
similar to git's revision syntax where '<rev>~[<n>]' means the <n>th
127+
ancestor commit from <rev> following first parents.
128128

129129
'[<patchname>]{plus}[<n>]', e.g. '{plus}', '{plus}3', 'patch{plus}', 'patch{plus}3'::
130130
The <n>th next patch from the named patch. If <patchname> is not
@@ -143,9 +143,9 @@ The complete syntax for locating patches follows:
143143
index, so '0' refers to the bottommost patch in the stack.
144144

145145
'{caret}[<n>]', e.g. '{caret}', '{caret}3'::
146-
The patch at offset <n> from the last unapplied patch in the stack.
146+
The patch at offset <n> from the last visible patch in the stack.
147147
This is a zero-based offset, so '{caret}0' refers to the last
148-
unapplied patch in the stack, which is equivalent to just
148+
visible patch in the stack, which is equivalent to just
149149
'{caret}'. Negative values of <n> are allowed and refer to hidden
150150
patches which are after the last visible patch in the stack.
151151

0 commit comments

Comments
 (0)