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>

diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index b18eabd699e55c740b8bc767daa4f9e11294f326..b0d94deea6c7361e30d8a1d3ed86f7b8d14a6e00 100644 (file)
--- 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

diff --git a/builtin/tag.c b/builtin/tag.c
index 73df728114e81ac87dd1b84604947d739d948fb6..b4789cec4569a07a9497e5b39f0646763ec89122 100644 (file)
--- a/builtin/tag.c
+++ b/builtin/tag.c
@@ -45,11 +45,11 @@ static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting, con
        if (!format) {
                if (filter->lines) {
                        to_free = xstrfmt("%s %%(contents:lines=%d)",
-                                         "%(align:15)%(refname:strip=2)%(end)",
+                                         "%(align:15)%(refname:lstrip=2)%(end)",
                                          filter->lines);
                        format = to_free;
                } else
-                       format = "%(refname:strip=2)";
+                       format = "%(refname:lstrip=2)";
        }
 
        verify_ref_format(format);

diff --git a/ref-filter.c b/ref-filter.c
index ffa29446cfb92cda6087196313a232972fe87f8c..cccd86f574dad26c663ecb5eb722c77d8c55b792 100644 (file)
--- a/ref-filter.c
+++ b/ref-filter.c
@@ -33,8 +33,8 @@ struct if_then_else {
 };
 
 struct refname_atom {
-       enum { R_NORMAL, R_SHORT, R_STRIP } option;
-       unsigned int strip;
+       enum { R_NORMAL, R_SHORT, R_LSTRIP } option;
+       unsigned int lstrip;
 };
 
 /*
@@ -91,10 +91,10 @@ static void refname_atom_parser_internal(struct refname_atom *atom,
                atom->option = R_NORMAL;
        else if (!strcmp(arg, "short"))
                atom->option = R_SHORT;
-       else if (skip_prefix(arg, "strip=", &arg)) {
-               atom->option = R_STRIP;
-               if (strtoul_ui(arg, 10, &atom->strip) || atom->strip <= 0)
-                       die(_("positive value expected refname:strip=%s"), arg);
+       else if (skip_prefix(arg, "lstrip=", &arg)) {
+               atom->option = R_LSTRIP;
+               if (strtoul_ui(arg, 10, &atom->lstrip) || atom->lstrip <= 0)
+                       die(_("positive value expected refname:lstrip=%s"), arg);
        } else
                die(_("unrecognized %%(%s) argument: %s"), name, arg);
 }
@@ -1091,7 +1091,7 @@ static inline char *copy_advance(char *dst, const char *src)
        return dst;
 }
 
-static const char *strip_ref_components(const char *refname, unsigned int len)
+static const char *lstrip_ref_components(const char *refname, unsigned int len)
 {
        long remaining = len;
        const char *start = refname;
@@ -1099,7 +1099,7 @@ static const char *strip_ref_components(const char *refname, unsigned int len)
        while (remaining) {
                switch (*start++) {
                case '\0':
-                       die(_("ref '%s' does not have %ud components to :strip"),
+                       die(_("ref '%s' does not have %ud components to :lstrip"),
                            refname, len);
                case '/':
                        remaining--;
@@ -1113,8 +1113,8 @@ static const char *show_ref(struct refname_atom *atom, const char *refname)
 {
        if (atom->option == R_SHORT)
                return shorten_unambiguous_ref(refname, warn_ambiguous_refs);
-       else if (atom->option == R_STRIP)
-               return strip_ref_components(refname, atom->strip);
+       else if (atom->option == R_LSTRIP)
+               return lstrip_ref_components(refname, atom->lstrip);
        else
                return refname;
 }

diff --git a/t/t6300-for-each-ref.sh b/t/t6300-for-each-ref.sh
index c538084245a7bd7208514ce591b95e361f9e1923..5eb013ca2146d152be86362a921a2183396c0aaf 100755 (executable)
--- a/t/t6300-for-each-ref.sh
+++ b/t/t6300-for-each-ref.sh
@@ -51,14 +51,14 @@ test_atom() {
 
 test_atom head refname refs/heads/master
 test_atom head refname:short master
-test_atom head refname:strip=1 heads/master
-test_atom head refname:strip=2 master
+test_atom head refname:lstrip=1 heads/master
+test_atom head refname:lstrip=2 master
 test_atom head upstream refs/remotes/origin/master
 test_atom head upstream:short origin/master
-test_atom head upstream:strip=2 origin/master
+test_atom head upstream:lstrip=2 origin/master
 test_atom head push refs/remotes/myfork/master
 test_atom head push:short myfork/master
-test_atom head push:strip=1 remotes/myfork/master
+test_atom head push:lstrip=1 remotes/myfork/master
 test_atom head objecttype commit
 test_atom head objectsize 171
 test_atom head objectname $(git rev-parse refs/heads/master)
@@ -141,14 +141,14 @@ test_expect_success 'Check invalid atoms names are errors' '
        test_must_fail git for-each-ref --format="%(INVALID)" refs/heads
 '
 
-test_expect_success 'arguments to :strip must be positive integers' '
-       test_must_fail git for-each-ref --format="%(refname:strip=0)" &&
-       test_must_fail git for-each-ref --format="%(refname:strip=-1)" &&
-       test_must_fail git for-each-ref --format="%(refname:strip=foo)"
+test_expect_success 'arguments to :lstrip must be positive integers' '
+       test_must_fail git for-each-ref --format="%(refname:lstrip=0)" &&
+       test_must_fail git for-each-ref --format="%(refname:lstrip=-1)" &&
+       test_must_fail git for-each-ref --format="%(refname:lstrip=foo)"
 '
 
 test_expect_success 'stripping refnames too far gives an error' '
-       test_must_fail git for-each-ref --format="%(refname:strip=3)"
+       test_must_fail git for-each-ref --format="%(refname:lstrip=3)"
 '
 
 test_expect_success 'Check format specifiers are ignored in naming date atoms' '
@@ -630,8 +630,8 @@ cat >expected <<EOF
 master
 EOF
 
-test_expect_success 'Verify usage of %(symref:strip) atom' '
-       git for-each-ref --format="%(symref:strip=2)" refs/heads/sym > actual &&
+test_expect_success 'Verify usage of %(symref:lstrip) atom' '
+       git for-each-ref --format="%(symref:lstrip=2)" refs/heads/sym > actual &&
        test_cmp expected actual
 '