diff options
author | Karthik Nayak <karthik.188@gmail.com> | 2017-01-10 11:49:46 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-01-10 23:44:31 +0300 |
commit | 17938f171f703c28696c7839a910565f0fb32121 (patch) | |
tree | 874b5647769e7109ce0277b2dd6314cfee5ba76a /Documentation/git-for-each-ref.txt | |
parent | 3ba308cb4b4ad0d06fa834a42a9380c877b0c16a (diff) |
ref-filter: rename the 'strip' option to 'lstrip'
In preparation for the upcoming patch, where we introduce the 'rstrip'
option. Rename the 'strip' option to 'lstrip' to remove ambiguity.
Signed-off-by: Karthik Nayak <Karthik.188@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-for-each-ref.txt')
-rw-r--r-- | Documentation/git-for-each-ref.txt | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index b18eabd699..b0d94deea6 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -95,9 +95,9 @@ refname:: The name of the ref (the part after $GIT_DIR/). For a non-ambiguous short name of the ref append `:short`. The option core.warnAmbiguousRefs is used to select the strict - abbreviation mode. If `strip=<N>` is appended, strips `<N>` + abbreviation mode. If `lstrip=<N>` is appended, strips `<N>` slash-separated path components from the front of the refname - (e.g., `%(refname:strip=2)` turns `refs/tags/foo` into `foo`. + (e.g., `%(refname:lstrip=2)` turns `refs/tags/foo` into `foo`. `<N>` must be a positive integer. If a displayed ref has fewer components than `<N>`, the command aborts with an error. @@ -116,7 +116,7 @@ objectname:: upstream:: The name of a local ref which can be considered ``upstream'' - from the displayed ref. Respects `:short` and `:strip` in the + from the displayed ref. Respects `:short` and `:lstrip` in the same way as `refname` above. Additionally respects `:track` to show "[ahead N, behind M]" and `:trackshort` to show the terse version: ">" (ahead), "<" (behind), "<>" (ahead and @@ -130,7 +130,7 @@ upstream:: push:: The name of a local ref which represents the `@{push}` - location for the displayed ref. Respects `:short`, `:strip`, + location for the displayed ref. Respects `:short`, `:lstrip`, `:track`, and `:trackshort` options as `upstream` does. Produces an empty string if no `@{push}` ref is configured. @@ -174,7 +174,7 @@ if:: symref:: The ref which the given symbolic ref refers to. If not a symbolic ref, nothing is printed. Respects the `:short` and - `:strip` options in the same way as `refname` above. + `:lstrip` options in the same way as `refname` above. In addition to the above, for commit and tag objects, the header field names (`tree`, `parent`, `object`, `type`, and `tag`) can |