ref-filter: rename the 'strip' option to 'lstrip'
[gitweb.git] / Documentation / git-for-each-ref.txt
index 5de22cf64996687e44f385752d4ce8438ef0f211..b0d94deea6c7361e30d8a1d3ed86f7b8d14a6e00 100644 (file)
@@ -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,23 +116,24 @@ objectname::
 
 upstream::
        The name of a local ref which can be considered ``upstream''
-       from the displayed ref. Respects `:short` 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 behind),
-       or "=" (in sync). `:track` also prints "[gone]" whenever
-       unknown upstream ref is encountered. Append `:track,nobracket`
-       to show tracking information without brackets (i.e "ahead N,
-       behind M").  Has no effect if the ref does not have tracking
-       information associated with it.  All the options apart from
-       `nobracket` are mutually exclusive, but if used together the
-       last option is selected.
+       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
+       behind), or "=" (in sync). `:track` also prints "[gone]"
+       whenever unknown upstream ref is encountered. Append
+       `:track,nobracket` to show tracking information without
+       brackets (i.e "ahead N, behind M").  Has no effect if the ref
+       does not have tracking information associated with it.  All
+       the options apart from `nobracket` are mutually exclusive, but
+       if used together the last option is selected.
 
 push::
-       The name of a local ref which represents the `@{push}` location
-       for the displayed ref. Respects `:short`, `:track`, and
-       `:trackshort` options as `upstream` does. Produces an empty
-       string if no `@{push}` ref is configured.
+       The name of a local ref which represents the `@{push}`
+       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.
 
 HEAD::
        '*' if HEAD matches current ref (the checked out branch), ' '
@@ -173,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