git config --unset: remove empty sections (in the common case)

The original reasoning for not removing section headers upon removal of
the last entry went like this: the user could have added comments about
the section, or about the entries therein, and if there were other
comments there, we would not know whether we should remove them.

In particular, a concocted example was presented that looked like this
(and was added to t1300):

# some generic comment on the configuration file itself
# a comment specific to this "section" section.
[section]
# some intervening lines
# that should also be dropped

key = value
# please be careful when you update the above variable

The ideal thing for `git config --unset section.key` in this case would
be to leave only the first line behind, because all the other comments
are now obsolete.

However, this is unfeasible, short of adding a complete Natural Language
Processing module to Git, which seems not only a lot of work, but a
totally unreasonable feature (for little benefit to most users).

Now, the real kicker about this problem is: most users do not edit their
config files at all! In their use case, the config looks like this
instead:

[section]
key = value

... and it is totally obvious what should happen if the entry is
removed: the entire section should vanish.

Let's generalize this observation to this conservative strategy: if we
are removing the last entry from a section, and there are no comments
inside that section nor surrounding it, then remove the entire section.
Otherwise behave as before: leave the now-empty section (including those
comments, even ones about the now-deleted entry).

We have to be extra careful to handle the case where more than one entry
is removed: any subset of them might be the last entries of their
respective sections (and if there are no comments in or around that
section, the section should be removed, too).

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/config.c b/config.c
index cf94a690ad55130e42f1a56f79bae40917c2d8ce..69c4188ce882b98f3d5b8ad8a4bdb6eba60d3241 100644 (file)
--- a/config.c
+++ b/config.c
@@ -2297,6 +2297,7 @@ struct config_store_data {
        struct {
                size_t begin, end;
                enum config_event_t type;
        struct {
                size_t begin, end;
                enum config_event_t type;

+               int is_keys_section;

        } *parsed;
        unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
        unsigned int key_seen:1, section_seen:1, is_keys_section:1;
        } *parsed;
        unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
        unsigned int key_seen:1, section_seen:1, is_keys_section:1;


@@ -2325,17 +2326,20 @@ static int store_aux_event(enum config_event_t type,
        store->parsed[store->parsed_nr].begin = begin;
        store->parsed[store->parsed_nr].end = end;
        store->parsed[store->parsed_nr].type = type;
        store->parsed[store->parsed_nr].begin = begin;
        store->parsed[store->parsed_nr].end = end;
        store->parsed[store->parsed_nr].type = type;

-       store->parsed_nr++;

 
        if (type == CONFIG_EVENT_SECTION) {
                if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
                        BUG("Invalid section name '%s'", cf->var.buf);
 
                /* Is this the section we were looking for? */
 
        if (type == CONFIG_EVENT_SECTION) {
                if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
                        BUG("Invalid section name '%s'", cf->var.buf);
 
                /* Is this the section we were looking for? */

-               store->is_keys_section = cf->var.len - 1 == store->baselen &&
+               store->is_keys_section =
+                       store->parsed[store->parsed_nr].is_keys_section =
+                       cf->var.len - 1 == store->baselen &&

                        !strncasecmp(cf->var.buf, store->key, store->baselen);
        }
 
                        !strncasecmp(cf->var.buf, store->key, store->baselen);
        }
 

+       store->parsed_nr++;
+

        return 0;
 }
 
        return 0;
 }
 


@@ -2467,6 +2471,87 @@ static ssize_t write_pair(int fd, const char *key, const char *value,
        return ret;
 }
 
        return ret;
 }
 

+/*
+ * If we are about to unset the last key(s) in a section, and if there are
+ * no comments surrounding (or included in) the section, we will want to
+ * extend begin/end to remove the entire section.
+ *
+ * Note: the parameter `seen_ptr` points to the index into the store.seen
+ * array.  * This index may be incremented if a section has more than one
+ * entry (which all are to be removed).
+ */
+static void maybe_remove_section(struct config_store_data *store,
+                                const char *contents,
+                                size_t *begin_offset, size_t *end_offset,
+                                int *seen_ptr)
+{
+       size_t begin;
+       int i, seen, section_seen = 0;
+
+       /*
+        * First, ensure that this is the first key, and that there are no
+        * comments before the entry nor before the section header.
+        */
+       seen = *seen_ptr;
+       for (i = store->seen[seen]; i > 0; i--) {
+               enum config_event_t type = store->parsed[i - 1].type;
+
+               if (type == CONFIG_EVENT_COMMENT)
+                       /* There is a comment before this entry or section */
+                       return;
+               if (type == CONFIG_EVENT_ENTRY) {
+                       if (!section_seen)
+                               /* This is not the section's first entry. */
+                               return;
+                       /* We encountered no comment before the section. */
+                       break;
+               }
+               if (type == CONFIG_EVENT_SECTION) {
+                       if (!store->parsed[i - 1].is_keys_section)
+                               break;
+                       section_seen = 1;
+               }
+       }
+       begin = store->parsed[i].begin;
+
+       /*
+        * Next, make sure that we are removing he last key(s) in the section,
+        * and that there are no comments that are possibly about the current
+        * section.
+        */
+       for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
+               enum config_event_t type = store->parsed[i].type;
+
+               if (type == CONFIG_EVENT_COMMENT)
+                       return;
+               if (type == CONFIG_EVENT_SECTION) {
+                       if (store->parsed[i].is_keys_section)
+                               continue;
+                       break;
+               }
+               if (type == CONFIG_EVENT_ENTRY) {
+                       if (++seen < store->seen_nr &&
+                           i == store->seen[seen])
+                               /* We want to remove this entry, too */
+                               continue;
+                       /* There is another entry in this section. */
+                       return;
+               }
+       }
+
+       /*
+        * We are really removing the last entry/entries from this section, and
+        * there are no enclosed or surrounding comments. Remove the entire,
+        * now-empty section.
+        */
+       *seen_ptr = seen;
+       *begin_offset = begin;
+       if (i < store->parsed_nr)
+               *end_offset = store->parsed[i].begin;
+       else
+               *end_offset = store->parsed[store->parsed_nr - 1].end;
+}
+

 int git_config_set_in_file_gently(const char *config_filename,
                                  const char *key, const char *value)
 {
 int git_config_set_in_file_gently(const char *config_filename,
                                  const char *key, const char *value)
 {


@@ -2689,6 +2774,10 @@ int git_config_set_multivar_in_file_gently(const char *config_filename,
                        } else {
                                replace_end = store.parsed[j].end;
                                copy_end = store.parsed[j].begin;
                        } else {
                                replace_end = store.parsed[j].end;
                                copy_end = store.parsed[j].begin;

+                               if (!value)
+                                       maybe_remove_section(&store, contents,
+                                                            &copy_end,
+                                                            &replace_end, &i);

                                /*
                                 * Swallow preceding white-space on the same
                                 * line.
                                /*
                                 * Swallow preceding white-space on the same
                                 * line.

diff --git a/t/t1300-config.sh b/t/t1300-config.sh
index 8a3cd2c11416643af32c184bfee7bd53c6213005..92aaa53794d20f971d42f109079347c1cbc3da42 100755 (executable)
--- a/t/t1300-config.sh
+++ b/t/t1300-config.sh
@@ -1390,7 +1390,7 @@ test_expect_success 'urlmatch with wildcard' '
 '
 
 # good section hygiene
 '
 
 # good section hygiene

-test_expect_failure '--unset last key removes section (except if commented)' '
+test_expect_success '--unset last key removes section (except if commented)' '

        cat >.git/config <<-\EOF &&
        # some generic comment on the configuration file itself
        # a comment specific to this "section" section.
        cat >.git/config <<-\EOF &&
        # some generic comment on the configuration file itself
        # a comment specific to this "section" section.


@@ -1472,7 +1472,7 @@ test_expect_failure '--unset last key removes section (except if commented)' '
        test_line_count = 3 .git/config
 '
 
        test_line_count = 3 .git/config
 '
 

-test_expect_failure '--unset-all removes section if empty & uncommented' '
+test_expect_success '--unset-all removes section if empty & uncommented' '

        cat >.git/config <<-\EOF &&
        [section]
        key = value1
        cat >.git/config <<-\EOF &&
        [section]
        key = value1