diff options
| author | Johannes Schindelin <johannes.schindelin@gmx.de> | 2017-05-11 15:47:40 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-05-12 15:05:58 +0900 |
| commit | dcf0f19943ef4e6d158bc05bd9c017c4b1d5ef1e (patch) | |
| tree | d2bf8d00e643df22ad6b9a0671ed26dd9d5045f8 | |
| parent | f8e017397ec3daeb80ad2b58776fe5bb493d22b9 (diff) | |
| download | git-dcf0f19943ef4e6d158bc05bd9c017c4b1d5ef1e.tar.gz | |
Documentation: really deprecate .git/remotes/ and .git/branches/
The documentation did not make it quite clear just how deprecated these
directories are.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/gitrepository-layout.txt | 19 | ||||
| -rw-r--r-- | Documentation/urls-remotes.txt | 65 |
2 files changed, 11 insertions, 73 deletions
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index f51ed4e37c..9f2275f06d 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -144,12 +144,11 @@ config:: used instead. branches:: - A slightly deprecated way to store shorthands to be used + A highly deprecated way to store shorthands to be used to specify a URL to 'git fetch', 'git pull' and 'git push'. A file can be stored as `branches/<name>` and then 'name' can be given to these commands in place of - 'repository' argument. See the REMOTES section in - linkgit:git-fetch[1] for details. This mechanism is legacy + 'repository' argument. This mechanism is legacy and not likely to be found in modern repositories. This directory is ignored if $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/branches" will be used instead. @@ -213,13 +212,13 @@ info/sparse-checkout:: See also: linkgit:git-read-tree[1]. remotes:: - Stores shorthands for URL and default refnames for use - when interacting with remote repositories via 'git fetch', - 'git pull' and 'git push' commands. See the REMOTES section - in linkgit:git-fetch[1] for details. This mechanism is legacy - and not likely to be found in modern repositories. This - directory is ignored if $GIT_COMMON_DIR is set and - "$GIT_COMMON_DIR/remotes" will be used instead. + A highly deprecated location to store shorthands for URL and + default refnames for use when interacting with remote + repositories via 'git fetch', 'git pull' and 'git push' + commands. This mechanism is legacy and not likely to be + found in modern repositories. This directory is ignored if + $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/remotes" will + be used instead. logs:: Records of changes made to refs are stored in this directory. diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt index bd184cd653..a7214a9cae 100644 --- a/Documentation/urls-remotes.txt +++ b/Documentation/urls-remotes.txt @@ -3,15 +3,8 @@ include::urls.txt[] REMOTES[[REMOTES]] ------------------ -The name of one of the following can be used instead -of a URL as `<repository>` argument: - -* a remote in the Git configuration file: `$GIT_DIR/config`, -* a file in the `$GIT_DIR/remotes` directory, or -* a file in the `$GIT_DIR/branches` directory. - -All of these also allow you to omit the refspec from the command line -because they each contain a refspec which git will use by default. +The name of a remote in the Git configuration file: `$GIT_DIR/config` +can be used instead of a URL as `<repository>` argument. Named remote in configuration file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -35,60 +28,6 @@ config file would appear like this: The `<pushurl>` is used for pushes only. It is optional and defaults to `<url>`. -Named file in `$GIT_DIR/remotes` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can choose to provide the name of a -file in `$GIT_DIR/remotes`. The URL -in this file will be used to access the repository. The refspec -in this file will be used as default when you do not -provide a refspec on the command line. This file should have the -following format: - ------------- - URL: one of the above URL format - Push: <refspec> - Pull: <refspec> - ------------- - -`Push:` lines are used by 'git push' and -`Pull:` lines are used by 'git pull' and 'git fetch'. -Multiple `Push:` and `Pull:` lines may -be specified for additional branch mappings. - -Named file in `$GIT_DIR/branches` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can choose to provide the name of a -file in `$GIT_DIR/branches`. -The URL in this file will be used to access the repository. -This file should have the following format: - - ------------- - <url>#<head> ------------- - -`<url>` is required; `#<head>` is optional. - -Depending on the operation, git will use one of the following -refspecs, if you don't provide one on the command line. -`<branch>` is the name of this file in `$GIT_DIR/branches` and -`<head>` defaults to `master`. - -git fetch uses: - ------------- - refs/heads/<head>:refs/heads/<branch> ------------- - -git push uses: - ------------- - HEAD:refs/heads/<head> ------------- - |