config: Add --null/-z option for null-delimted output

Use \n as delimiter between key and value and \0 as
delimiter after each key/value pair. This should be
easily parsable output.

Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index bb6dbb0ec430de41a9964b88bbf5b44b394023b4..a44578166487d57ef8a17f687e27e5939c4bdc7a 100644 (file)
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -9,17 +9,17 @@ git-config - Get and set repository or global options
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git-config' [--system | --global] name [value [value_regex]]
+'git-config' [--system | --global] [-z|--null] name [value [value_regex]]

 'git-config' [--system | --global] --add name value
 'git-config' [--system | --global] --replace-all name [value [value_regex]]
 'git-config' [--system | --global] --add name value
 'git-config' [--system | --global] --replace-all name [value [value_regex]]

-'git-config' [--system | --global] [type] --get name [value_regex]
-'git-config' [--system | --global] [type] --get-all name [value_regex]
-'git-config' [--system | --global] [type] --get-regexp name_regex [value_regex]
+'git-config' [--system | --global] [type] [-z|--null] --get name [value_regex]
+'git-config' [--system | --global] [type] [-z|--null] --get-all name [value_regex]
+'git-config' [--system | --global] [type] [-z|--null] --get-regexp name_regex [value_regex]

 'git-config' [--system | --global] --unset name [value_regex]
 'git-config' [--system | --global] --unset-all name [value_regex]
 'git-config' [--system | --global] --rename-section old_name new_name
 'git-config' [--system | --global] --remove-section name
 'git-config' [--system | --global] --unset name [value_regex]
 'git-config' [--system | --global] --unset-all name [value_regex]
 'git-config' [--system | --global] --rename-section old_name new_name
 'git-config' [--system | --global] --remove-section name

-'git-config' [--system | --global] -l | --list
+'git-config' [--system | --global] [-z|--null] -l | --list

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -118,6 +118,14 @@ See also <<FILES>>.
        in the config file will cause the value to be multiplied
        by 1024, 1048576, or 1073741824 prior to output.
 
        in the config file will cause the value to be multiplied
        by 1024, 1048576, or 1073741824 prior to output.
 

+-z, --null::
+       For all options that output values and/or keys, always
+       end values with with the null character (instead of a
+       newline). Use newline instead as a delimiter between
+       key and value. This allows for secure parsing of the
+       output without getting confused e.g. by values that
+       contain line breaks.
+

 
 [[FILES]]
 FILES
 
 [[FILES]]
 FILES

diff --git a/builtin-config.c b/builtin-config.c
index dbc2339d0f98d561e0263354321a5f2566f9918a..b96c9aa74284a0c3435554312f65d880fce9e70f 100644 (file)
--- a/builtin-config.c
+++ b/builtin-config.c
@@ -2,7 +2,7 @@
 #include "cache.h"
 
 static const char git_config_set_usage[] =
 #include "cache.h"
 
 static const char git_config_set_usage[] =

-"git-config [ --global | --system ] [ --bool | --int ] [--get | --get-all | --get-regexp | --replace-all | --add | --unset | --unset-all] name [value [value_regex]] | --rename-section old_name new_name | --remove-section name | --list";
+"git-config [ --global | --system ] [ --bool | --int ] [ -z | --null ] [--get | --get-all | --get-regexp | --replace-all | --add | --unset | --unset-all] name [value [value_regex]] | --rename-section old_name new_name | --remove-section name | --list";

 
 static char *key;
 static regex_t *key_regexp;
 
 static char *key;
 static regex_t *key_regexp;


@@ -12,14 +12,17 @@ static int use_key_regexp;
 static int do_all;
 static int do_not_match;
 static int seen;
 static int do_all;
 static int do_not_match;
 static int seen;

+static char delim = '=';
+static char key_delim = ' ';
+static char term = '\n';

 static enum { T_RAW, T_INT, T_BOOL } type = T_RAW;
 
 static int show_all_config(const char *key_, const char *value_)
 {
        if (value_)
 static enum { T_RAW, T_INT, T_BOOL } type = T_RAW;
 
 static int show_all_config(const char *key_, const char *value_)
 {
        if (value_)

-               printf("%s=%s\n", key_, value_);
+               printf("%s%c%s%c", key_, delim, value_, term);

        else
        else

-               printf("%s\n", key_);
+               printf("%s%c", key_, term);

        return 0;
 }
 
        return 0;
 }
 


@@ -40,7 +43,7 @@ static int show_config(const char* key_, const char* value_)
 
        if (show_keys) {
                if (value_)
 
        if (show_keys) {
                if (value_)

-                       printf("%s ", key_);
+                       printf("%s%c", key_, key_delim);

                else
                        printf("%s", key_);
        }
                else
                        printf("%s", key_);
        }


@@ -58,7 +61,7 @@ static int show_config(const char* key_, const char* value_)
                                key_, vptr);
        }
        else
                                key_, vptr);
        }
        else

-               printf("%s\n", vptr);
+               printf("%s%c", vptr, term);

 
        return 0;
 }
 
        return 0;
 }


@@ -159,6 +162,11 @@ int cmd_config(int argc, const char **argv, const char *prefix)
                }
                else if (!strcmp(argv[1], "--system"))
                        setenv("GIT_CONFIG", ETC_GITCONFIG, 1);
                }
                else if (!strcmp(argv[1], "--system"))
                        setenv("GIT_CONFIG", ETC_GITCONFIG, 1);

+               else if (!strcmp(argv[1], "--null") || !strcmp(argv[1], "-z")) {
+                       term = '\0';
+                       delim = '\n';
+                       key_delim = '\n';
+               }

                else if (!strcmp(argv[1], "--rename-section")) {
                        int ret;
                        if (argc != 4)
                else if (!strcmp(argv[1], "--rename-section")) {
                        int ret;
                        if (argc != 4)

diff --git a/t/t1300-repo-config.sh b/t/t1300-repo-config.sh
index 84977355a3a1e7812964c3bcbc37f1aa9c67e846..7a77bef4c0e7c24d263c87d59327bff1b8443aef 100755 (executable)
--- a/t/t1300-repo-config.sh
+++ b/t/t1300-repo-config.sh
@@ -519,4 +519,36 @@ git config --list > result
 
 test_expect_success 'value continued on next line' 'cmp result expect'
 
 
 test_expect_success 'value continued on next line' 'cmp result expect'
 

+cat > .git/config <<\EOF
+[section "sub=section"]
+       val1 = foo=bar
+       val2 = foo\nbar
+       val3 = \n\n
+       val4 =
+       val5
+EOF
+
+cat > expect <<\EOF
+Key: section.sub=section.val1
+Value: foo=bar
+Key: section.sub=section.val2
+Value: foo
+bar
+Key: section.sub=section.val3
+Value: 
+
+
+Key: section.sub=section.val4
+Value: 
+Key: section.sub=section.val5
+EOF
+
+git config --null --list | perl -0ne 'chop;($key,$value)=split(/\n/,$_,2);print "Key: $key\n";print "Value: $value\n" if defined($value)' > result
+
+test_expect_success '--null --list' 'cmp result expect'
+
+git config --null --get-regexp 'val[0-9]' | perl -0ne 'chop;($key,$value)=split(/\n/,$_,2);print "Key: $key\n";print "Value: $value\n" if defined($value)' > result
+
+test_expect_success '--null --get-regexp' 'cmp result expect'
+

 test_done
 test_done