Commit 5773c9f2 authored by Junio C Hamano's avatar Junio C Hamano

Documentation updates.

Signed-off-by: default avatarJunio C Hamano <[email protected]>
parent 52e4478d
......@@ -48,8 +48,8 @@ A commit encapsulates:
- committer name and email and the commit time.
If not provided, "git-commit-tree" uses your name, hostname and domain to
provide author and committer info. This can be overridden using the
following environment variables.
provide author and committer info. This can be overridden by
either `.git/config` file, or using the following environment variables.
GIT_AUTHOR_NAME
GIT_AUTHOR_EMAIL
......@@ -59,10 +59,17 @@ following environment variables.
(nb "<", ">" and "\n"s are stripped)
In `.git/config` file, the following items are used:
[user]
name = "Your Name"
email = "[email protected]"
A commit comment is read from stdin (max 999 chars). If a changelog
entry is not provided via "<" redirection, "git-commit-tree" will just wait
for one to be entered and terminated with ^D.
Diagnostics
-----------
You don't exist. Go away!::
......
......@@ -9,12 +9,15 @@ git-update-index - Modifies the index or directory cache
SYNOPSIS
--------
'git-update-index'
[--add] [--remove] [--refresh] [--replace]
[--ignore-missing]
[--force-remove]
[--add] [--remove] [--unmerged] [--refresh] [--replace]
[--cacheinfo <mode> <object> <file>]\*
[--chmod=(+|-)x]
[--info-only]
[-z] [--stdin]
[--force-remove]
[--stdin]
[--index-info]
[--ignore-missing]
[-z]
[--] [<file>]\*
DESCRIPTION
......@@ -79,7 +82,7 @@ OPTIONS
<file>::
Files to act on.
Note that files begining with '.' are discarded. This includes
Note that files beginning with '.' are discarded. This includes
`./file` and `dir/./file`. If you don't want this, then use
cleaner names.
The same applies to directories ending '/' and paths with '//'
......@@ -121,6 +124,17 @@ To update and refresh only the files already checked out:
git-checkout-index -n -f -a && git-update-index --ignore-missing --refresh
Configuration
-------------
The command honors `core.filemode` configuration variable. If
your repository is on an filesystem whose executable bits are
unreliable, this should be set to 'false'. This causes the
command to ignore differences in file modes recorded in the
index and the file mode on the filesystem if they differ only on
executable bit. On such an unfortunate filesystem, you may
need to use `git-update-index --chmod=`.
Author
------
Written by Linus Torvalds <[email protected]>
......
......@@ -430,6 +430,37 @@ gitlink:gitk[1]::
gitk.
Configuration Mechanism
-----------------------
Starting from 0.99.9 (actually mid 0.99.8.GIT), .git/config file
is used to hold per-repository configuration options. It is a
simple text file modelled after `.ini` format familiar to some
people. Here is an example:
------------
#
# This is the config file, and
# a '#' or ';' character indicates
# a comment
#
; core variables
[core]
; Don't trust file modes
filemode = false
; user identity
[user]
name = "Junio C Hamano"
email = "[email protected]"
------------
Various commands read from the configuration file and adjust
their operation accordingly.
Identifier Terminology
----------------------
<object>::
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment