Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 1 | include::urls.txt[] |
| 2 | |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 3 | REMOTES[[REMOTES]] |
| 4 | ------------------ |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 5 | |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 6 | The name of one of the following can be used instead |
| 7 | of a URL as `<repository>` argument: |
| 8 | |
Thomas Ackermann | 2de9b71 | 2013-01-21 20:17:53 +0100 | [diff] [blame] | 9 | * a remote in the Git configuration file: `$GIT_DIR/config`, |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 10 | * a file in the `$GIT_DIR/remotes` directory, or |
| 11 | * a file in the `$GIT_DIR/branches` directory. |
| 12 | |
| 13 | All of these also allow you to omit the refspec from the command line |
| 14 | because they each contain a refspec which git will use by default. |
| 15 | |
| 16 | Named remote in configuration file |
| 17 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 18 | |
| 19 | You can choose to provide the name of a remote which you had previously |
| 20 | configured using linkgit:git-remote[1], linkgit:git-config[1] |
| 21 | or even by a manual edit to the `$GIT_DIR/config` file. The URL of |
| 22 | this remote will be used to access the repository. The refspec |
| 23 | of this remote will be used by default when you do |
| 24 | not provide a refspec on the command line. The entry in the |
| 25 | config file would appear like this: |
| 26 | |
| 27 | ------------ |
| 28 | [remote "<name>"] |
Jean-Noël Avila | 7706294 | 2021-11-06 19:48:55 +0100 | [diff] [blame] | 29 | url = <URL> |
Michael J Gruber | 2034623 | 2009-06-09 18:01:34 +0200 | [diff] [blame] | 30 | pushurl = <pushurl> |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 31 | push = <refspec> |
| 32 | fetch = <refspec> |
| 33 | ------------ |
| 34 | |
Michael J Gruber | 2034623 | 2009-06-09 18:01:34 +0200 | [diff] [blame] | 35 | The `<pushurl>` is used for pushes only. It is optional and defaults |
Elijah Newren | 859a6d6 | 2023-10-08 06:45:08 +0000 | [diff] [blame] | 36 | to `<URL>`. Pushing to a remote affects all defined pushurls or all |
Calvin Wan | d390e08 | 2023-02-07 18:12:27 +0000 | [diff] [blame] | 37 | defined urls if no pushurls are defined. Fetch, however, will only |
Linus Arver | 548afb0 | 2023-06-07 19:26:47 +0000 | [diff] [blame] | 38 | fetch from the first defined url if multiple urls are defined. |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 39 | |
| 40 | Named file in `$GIT_DIR/remotes` |
Junio C Hamano | 142d035 | 2015-10-22 10:09:07 -0700 | [diff] [blame] | 41 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 42 | |
| 43 | You can choose to provide the name of a |
| 44 | file in `$GIT_DIR/remotes`. The URL |
| 45 | in this file will be used to access the repository. The refspec |
| 46 | in this file will be used as default when you do not |
| 47 | provide a refspec on the command line. This file should have the |
| 48 | following format: |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 49 | |
| 50 | ------------ |
Elijah Newren | 6cc668c | 2023-10-08 06:45:14 +0000 | [diff] [blame] | 51 | URL: one of the above URL formats |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 52 | Push: <refspec> |
| 53 | Pull: <refspec> |
| 54 | |
| 55 | ------------ |
| 56 | |
Thomas Rast | 0b444cd | 2010-01-10 00:33:00 +0100 | [diff] [blame] | 57 | `Push:` lines are used by 'git push' and |
| 58 | `Pull:` lines are used by 'git pull' and 'git fetch'. |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 59 | Multiple `Push:` and `Pull:` lines may |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 60 | be specified for additional branch mappings. |
| 61 | |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 62 | Named file in `$GIT_DIR/branches` |
| 63 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 64 | |
| 65 | You can choose to provide the name of a |
| 66 | file in `$GIT_DIR/branches`. |
| 67 | The URL in this file will be used to access the repository. |
| 68 | This file should have the following format: |
| 69 | |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 70 | |
| 71 | ------------ |
Jean-Noël Avila | 7706294 | 2021-11-06 19:48:55 +0100 | [diff] [blame] | 72 | <URL>#<head> |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 73 | ------------ |
| 74 | |
Jean-Noël Avila | 7706294 | 2021-11-06 19:48:55 +0100 | [diff] [blame] | 75 | `<URL>` is required; `#<head>` is optional. |
Martin Koegler | 18afe10 | 2008-11-10 22:47:11 +0100 | [diff] [blame] | 76 | |
| 77 | Depending on the operation, git will use one of the following |
| 78 | refspecs, if you don't provide one on the command line. |
| 79 | `<branch>` is the name of this file in `$GIT_DIR/branches` and |
| 80 | `<head>` defaults to `master`. |
| 81 | |
| 82 | git fetch uses: |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 83 | |
| 84 | ------------ |
Martin Koegler | 18afe10 | 2008-11-10 22:47:11 +0100 | [diff] [blame] | 85 | refs/heads/<head>:refs/heads/<branch> |
| 86 | ------------ |
| 87 | |
| 88 | git push uses: |
| 89 | |
| 90 | ------------ |
| 91 | HEAD:refs/heads/<head> |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 92 | ------------ |
| 93 | |
Andrew Ruder | 37ba056 | 2007-07-04 17:21:36 -0500 | [diff] [blame] | 94 | |
John J. Franey | 5812473 | 2008-05-29 13:32:31 -0400 | [diff] [blame] | 95 | |
| 96 | |