Doc: Bundle file usage
Improve the command description, including paragraph spacing. Git URLs can accept bundle files for fetch, pull and clone, include in that section. Include git clone in the bundle usage description. Correct the quoting of <git-rev-list-args>. Detail the <git-rev-list-args> options for cloning a complete repo. Signed-off-by: Philip Oakley <philipoakley@iee.email> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
							parent
							
								
									5fa0f5238b
								
							
						
					
					
						commit
						0e40a73a4c
					
				|  | @ -20,11 +20,14 @@ DESCRIPTION | ||||||
| Some workflows require that one or more branches of development on one | Some workflows require that one or more branches of development on one | ||||||
| machine be replicated on another machine, but the two machines cannot | machine be replicated on another machine, but the two machines cannot | ||||||
| be directly connected, and therefore the interactive Git protocols (git, | be directly connected, and therefore the interactive Git protocols (git, | ||||||
| ssh, http) cannot be used.  This command provides support for | ssh, http) cannot be used. | ||||||
| 'git fetch' and 'git pull' to operate by packaging objects and references |  | ||||||
| in an archive at the originating machine, then importing those into | The 'git bundle' command packages objects and references in an archive | ||||||
| another repository using 'git fetch' and 'git pull' | at the originating machine, which can then be imported into another | ||||||
| after moving the archive by some means (e.g., by sneakernet).  As no | repository using 'git fetch', 'git pull', or 'git clone', | ||||||
|  | after moving the archive by some means (e.g., by sneakernet). | ||||||
|  |  | ||||||
|  | As no | ||||||
| direct connection between the repositories exists, the user must specify a | direct connection between the repositories exists, the user must specify a | ||||||
| basis for the bundle that is held by the destination repository: the | basis for the bundle that is held by the destination repository: the | ||||||
| bundle assumes that all objects in the basis are already in the | bundle assumes that all objects in the basis are already in the | ||||||
|  | @ -35,7 +38,7 @@ OPTIONS | ||||||
|  |  | ||||||
| create <file>:: | create <file>:: | ||||||
| 	Used to create a bundle named 'file'.  This requires the | 	Used to create a bundle named 'file'.  This requires the | ||||||
| 	'git-rev-list-args' arguments to define the bundle contents. | 	'<git-rev-list-args>' arguments to define the bundle contents. | ||||||
|  |  | ||||||
| verify <file>:: | verify <file>:: | ||||||
| 	Used to check that a bundle file is valid and will apply | 	Used to check that a bundle file is valid and will apply | ||||||
|  | @ -92,6 +95,14 @@ It is okay to err on the side of caution, causing the bundle file | ||||||
| to contain objects already in the destination, as these are ignored | to contain objects already in the destination, as these are ignored | ||||||
| when unpacking at the destination. | when unpacking at the destination. | ||||||
|  |  | ||||||
|  | `git clone` can use any bundle created without negative refspecs | ||||||
|  | (e.g., `new`, but not `old..new`). | ||||||
|  | If you want to match `git clone --mirror`, which would include your | ||||||
|  | refs such as `refs/remotes/*`, use `--all`. | ||||||
|  | If you want to provide the same set of refs that a clone directly | ||||||
|  | from the source repository would get, use `--branches --tags` for | ||||||
|  | the `<git-rev-list-args>`. | ||||||
|  |  | ||||||
| EXAMPLES | EXAMPLES | ||||||
| -------- | -------- | ||||||
|  |  | ||||||
|  |  | ||||||
|  | @ -53,6 +53,9 @@ These two syntaxes are mostly equivalent, except the former implies | ||||||
| --local option. | --local option. | ||||||
| endif::git-clone[] | endif::git-clone[] | ||||||
|  |  | ||||||
|  | 'git clone', 'git fetch' and 'git pull', but not 'git push', will also | ||||||
|  | accept a suitable bundle file. See linkgit:git-bundle[1]. | ||||||
|  |  | ||||||
| When Git doesn't know how to handle a certain transport protocol, it | When Git doesn't know how to handle a certain transport protocol, it | ||||||
| attempts to use the 'remote-<transport>' remote helper, if one | attempts to use the 'remote-<transport>' remote helper, if one | ||||||
| exists. To explicitly request a remote helper, the following syntax | exists. To explicitly request a remote helper, the following syntax | ||||||
|  |  | ||||||
		Loading…
	
		Reference in New Issue
	
	 Philip Oakley
						Philip Oakley