Skip to content

Commit

Permalink
[PATCH] Rename git-repo-config to git-config.
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Prince <tom.prince@ualberta.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
  • Loading branch information
Tom Prince authored and Junio C Hamano committed Jan 29, 2007
1 parent 829a686 commit e0d10e1
Show file tree
Hide file tree
Showing 58 changed files with 460 additions and 439 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ git-clean
git-clone
git-commit
git-commit-tree
git-config
git-convert-objects
git-count-objects
git-cvsexportcommit
Expand Down
2 changes: 1 addition & 1 deletion Documentation/cmd-list.perl
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ sub format_one {
git-reflog ancillarymanipulators
git-relink ancillarymanipulators
git-repack ancillarymanipulators
git-repo-config ancillarymanipulators
git-config ancillarymanipulators
git-request-pull foreignscminterface
git-rerere ancillaryinterrogators
git-reset mainporcelain
Expand Down
2 changes: 1 addition & 1 deletion Documentation/config.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The values following the equals sign in variable assign are all either
a string, an integer, or a boolean. Boolean values may be given as yes/no,
0/1 or true/false. Case is not significant in boolean values, when
converting value to the canonical form using '--bool' type specifier;
`git-repo-config` will ensure that the output is "true" or "false".
`git-config` will ensure that the output is "true" or "false".

String values may be entirely or partially enclosed in double quotes.
You need to enclose variable value in double quotes if you want to
Expand Down
2 changes: 1 addition & 1 deletion Documentation/core-tutorial.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1130,7 +1130,7 @@ the remote repository URL in the local repository's config file
like this:

------------------------------------------------
$ git repo-config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/
$ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/
------------------------------------------------

and use the "linus" keyword with `git pull` instead of the full URL.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/cvs-migration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ them first before running git pull.
================================
The `pull` command knows where to get updates from because of certain
configuration variables that were set by the first `git clone`
command; see `git repo-config -l` and the gitlink:git-repo-config[1] man
command; see `git config -l` and the gitlink:git-config[1] man
page for details.
================================

Expand Down
4 changes: 2 additions & 2 deletions Documentation/everyday.txt
Original file line number Diff line number Diff line change
Expand Up @@ -212,12 +212,12 @@ Push into another repository.::
------------
satellite$ git clone mothership:frotz frotz <1>
satellite$ cd frotz
satellite$ git repo-config --get-regexp '^(remote|branch)\.' <2>
satellite$ git config --get-regexp '^(remote|branch)\.' <2>
remote.origin.url mothership:frotz
remote.origin.fetch refs/heads/*:refs/remotes/origin/*
branch.master.remote origin
branch.master.merge refs/heads/master
satellite$ git repo-config remote.origin.push \
satellite$ git config remote.origin.push \
master:refs/remotes/satellite/master <3>
satellite$ edit/compile/test/commit
satellite$ git push origin <4>
Expand Down
227 changes: 227 additions & 0 deletions Documentation/git-config.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
git-config(1)
=============

NAME
----
git-config - Get and set repository or global options


SYNOPSIS
--------
[verse]
'git-config' [--global] [type] name [value [value_regex]]
'git-config' [--global] [type] --add name value
'git-config' [--global] [type] --replace-all name [value [value_regex]]
'git-config' [--global] [type] --get name [value_regex]
'git-config' [--global] [type] --get-all name [value_regex]
'git-config' [--global] [type] --unset name [value_regex]
'git-config' [--global] [type] --unset-all name [value_regex]
'git-config' [--global] -l | --list

DESCRIPTION
-----------
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.

Multiple lines can be added to an option by using the '--add' option.
If you want to update or 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).

The type specifier can be either '--int' or '--bool', which will make
'git-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.

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,
. you try to unset/set an option for which multiple lines match, or
. you use --global option without $HOME being properly set.


OPTIONS
-------

--replace-all::
Default behavior is to replace at most one line. This replaces
all lines matching the key (and optionally the value_regex).

--add::
Adds a new line to the option without altering any existing
values. This is the same as providing '^$' as the value_regex.

--get::
Get the value for a given key (optionally filtered by a regex
matching the value). Returns error code 1 if the key was not
found and error code 2 if multiple key values were found.

--get-all::
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.

--global::
Use global ~/.gitconfig file rather than the repository .git/config.

--unset::
Remove the line matching the key from config file.

--unset-all::
Remove all matching lines from config file.

-l, --list::
List all variables set in config file.

--bool::
git-config will ensure that the output is "true" or "false"

--int::
git-config will ensure that the output is a simple
decimal number. An optional value suffix of 'k', 'm', or 'g'
in the config file will cause the value to be multiplied
by 1024, 1048576, or 1073741824 prior to output.


ENVIRONMENT
-----------

GIT_CONFIG::
Take the configuration from the given file instead of .git/config.
Using the "--global" option forces this to ~/.gitconfig.

GIT_CONFIG_LOCAL::
Currently the same as $GIT_CONFIG; when Git will support global
configuration files, this will cause it to take the configuration
from the global configuration file in addition to the given file.


EXAMPLE
-------

Given a .git/config like this:

#
# This is the config file, and
# a '#' or ';' character indicates
# a comment
#

; core variables
[core]
; Don't trust file modes
filemode = false

; Our diff algorithm
[diff]
external = "/usr/local/bin/gnu-diff -u"
renames = true

; Proxy settings
[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

------------
% git config core.filemode true
------------

The hypothetical proxy command entries actually have a postfix to discern
what URL they apply to. Here is how to change the entry for kernel.org
to "ssh".

------------
% git config core.gitproxy '"ssh" for kernel.org' 'for kernel.org$'
------------

This makes sure that only the key/value pair for kernel.org is replaced.

To delete the entry for renames, do

------------
% git config --unset diff.renames
------------

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

------------
% git config --get core.filemode
------------

or

------------
% git config core.filemode
------------

or, to query a multivar:

------------
% git config --get core.gitproxy "for kernel.org$"
------------

If you want to know all the values for a multivar, do:

------------
% git config --get-all core.gitproxy
------------

If you like to live dangerous, you can replace *all* core.gitproxy by a
new one with

------------
% git 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 config core.gitproxy ssh '! for '
------------

To actually match only values with an exclamation mark, you have to

------------
% git config section.key value '[!]'
------------

To add a new proxy, without altering any of the existing ones, use

------------
% git config core.gitproxy '"proxy" for example.com'
------------


include::config.txt[]


Author
------
Written by Johannes Schindelin <Johannes.Schindelin@gmx.de>

Documentation
--------------
Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.kernel.org>.

GIT
---
Part of the gitlink:git[7] suite

4 changes: 2 additions & 2 deletions Documentation/git-pull.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ git pull, git pull origin::
current branch. Normally the branch merged in is
the HEAD of the remote repository, but the choice is
determined by the branch.<name>.remote and
branch.<name>.merge options; see gitlink:git-repo-config[1]
branch.<name>.merge options; see gitlink:git-config[1]
for details.

git pull origin next::
Expand Down Expand Up @@ -94,7 +94,7 @@ gitlink:git-reset[1].

SEE ALSO
--------
gitlink:git-fetch[1], gitlink:git-merge[1], gitlink:git-repo-config[1]
gitlink:git-fetch[1], gitlink:git-merge[1], gitlink:git-config[1]


Author
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-remote.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ In the third form, gives some information about the remote <name>.

The remote configuration is achieved using the `remote.origin.url` and
`remote.origin.fetch` configuration variables. (See
gitlink:git-repo-config[1]).
gitlink:git-config[1]).

Examples
--------
Expand Down Expand Up @@ -58,7 +58,7 @@ See Also
--------
gitlink:git-fetch[1]
gitlink:git-branch[1]
gitlink:git-repo-config[1]
gitlink:git-config[1]

Author
------
Expand Down
Loading

0 comments on commit e0d10e1

Please sign in to comment.