X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=git-repo-config.txt;h=d5142e0dcd6799b8a94c9cd5a3f2bd17c3cb7289;hb=4220baa7b77d7e965a9cdd61e21d114f6ba66c21;hp=5eefe02437c296229b9d9e964cd457e7a0734f2a;hpb=1a4e841b439ba014b365999c3a6b9e2be3740bd8;p=git.git diff --git a/git-repo-config.txt b/git-repo-config.txt index 5eefe024..d5142e0d 100644 --- a/git-repo-config.txt +++ b/git-repo-config.txt @@ -3,17 +3,19 @@ git-repo-config(1) NAME ---- -git-repo-config - Get and set options in .git/config. +git-repo-config - Get and set options in .git/config SYNOPSIS -------- -'git-repo-config' name [value [value_regex]] -'git-repo-config' --replace-all name [value [value_regex]] -'git-repo-config' --get name [value_regex] -'git-repo-config' --get-all name [value_regex] -'git-repo-config' --unset name [value_regex] -'git-repo-config' --unset-all name [value_regex] +[verse] +'git-repo-config' [type] name [value [value_regex]] +'git-repo-config' [type] --replace-all name [value [value_regex]] +'git-repo-config' [type] --get name [value_regex] +'git-repo-config' [type] --get-all name [value_regex] +'git-repo-config' [type] --unset name [value_regex] +'git-repo-config' [type] --unset-all name [value_regex] +'git-repo-config' -l | --list DESCRIPTION ----------- @@ -21,15 +23,22 @@ You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped. -If you want to set/unset an option which can occor on multiple lines, you -should provide a POSIX regex for the value. If you want to handle the lines -*not* matching the regex, just prepend a single exlamation mark in front -(see EXAMPLES). +If you want to set/unset an option which can occur on multiple +lines, a POSIX regexp `value_regex` needs to be given. Only the +existing values that match the regexp are updated or unset. If +you want to handle the lines that do *not* match the regex, just +prepend a single exclamation mark in front (see EXAMPLES). -This command will fail if +The type specifier can be either '--int' or '--bool', which will make +'git-repo-config' ensure that the variable(s) are of the given type and +convert the value to the canonical form (simple decimal number for int, +a "true" or "false" string for bool). If no type specifier is passed, +no checks or transformations are performed on the value. -. .git/config is invalid, -. .git/config can not be written to, +This command will fail if: + +. The .git/config file is invalid, +. Can not write to .git/config, . no section was provided, . the section or key is invalid, . you try to unset an option which does not exist, or @@ -40,8 +49,8 @@ OPTIONS ------- --replace-all:: - Default behaviour is to replace at most one line. This replaces - all lines matching the key (and optionally the value_regex) + Default behavior is to replace at most one line. This replaces + all lines matching the key (and optionally the value_regex). --get:: Get the value for a given key (optionally filtered by a regex @@ -51,12 +60,18 @@ OPTIONS Like get, but does not fail if the number of values for the key is not exactly one. +--get-regexp:: + Like --get-all, but interprets the name as a regular expression. + --unset:: Remove the line matching the key from .git/config. --unset-all:: Remove all matching lines from .git/config. +-l, --list:: + List all variables set in .git/config. + EXAMPLE ------- @@ -80,11 +95,11 @@ Given a .git/config like this: renames = true ; Proxy settings - [proxy] - command="ssh" for "ssh://kernel.org/" - command="proxy-command" for kernel.org - command="myprotocol-command" for "my://" - command=default-proxy ; for all the rest + [core] + gitproxy="ssh" for "ssh://kernel.org/" + gitproxy="proxy-command" for kernel.org + gitproxy="myprotocol-command" for "my://" + gitproxy=default-proxy ; for all the rest you can set the filemode to true with @@ -97,7 +112,7 @@ to what URL they apply. Here is how to change the entry for kernel.org to "ssh". ------------ -% git repo-config proxy.command '"ssh" for kernel.org' 'for kernel.org$' +% git repo-config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$' ------------ This makes sure that only the key/value pair for kernel.org is replaced. @@ -108,7 +123,7 @@ To delete the entry for renames, do % git repo-config --unset diff.renames ------------ -If you want to delete an entry for a multivar (like proxy.command above), +If you want to delete an entry for a multivar (like core.gitproxy above), you have to provide a regex matching the value of exactly one line. To query the value for a given key, do @@ -126,27 +141,27 @@ or or, to query a multivar: ------------ -% git repo-config --get proxy.command "for kernel.org$" +% git repo-config --get core.gitproxy "for kernel.org$" ------------ If you want to know all the values for a multivar, do: ------------ -% git repo-config --get-all proxy.command +% git repo-config --get-all core.gitproxy ------------ -If you like to live dangerous, you can replace *all* proxy.commands by a +If you like to live dangerous, you can replace *all* core.gitproxy by a new one with ------------ -% git repo-config --replace-all proxy.command ssh +% git repo-config --replace-all core.gitproxy ssh ------------ However, if you really only want to replace the line for the default proxy, i.e. the one without a "for ..." postfix, do something like this: ------------ -% git repo-config proxy.command ssh '! for ' +% git repo-config core.gitproxy ssh '! for ' ------------ To actually match only values with an exclamation mark, you have to @@ -156,13 +171,16 @@ To actually match only values with an exclamation mark, you have to ------------ +include::config.txt[] + + Author ------ Written by Johannes Schindelin Documentation -------------- -Documentation by Johannes Schindelin. +Documentation by Johannes Schindelin, Petr Baudis and the git-list . GIT ---