diff options
| author | Russell Belfer <rb@github.com> | 2013-07-23 09:43:07 -0700 |
|---|---|---|
| committer | Russell Belfer <rb@github.com> | 2013-07-23 09:43:07 -0700 |
| commit | cdbcb8dd80ccae119ab56daa6da51990667e653c (patch) | |
| tree | cfe3f13a012130686ae07e446eaa2ad2e6074226 /include/git2/remote.h | |
| parent | e5bdf82976c631a5b4cc36d8bfad61de609d7802 (diff) | |
| parent | 64061d4a14f77fdcf6ecc038ea6e9b02f14e03a8 (diff) | |
| download | libgit2-cdbcb8dd80ccae119ab56daa6da51990667e653c.tar.gz | |
Merge pull request #1745 from libgit2/doc-fixes
Doc fixes
Diffstat (limited to 'include/git2/remote.h')
| -rw-r--r-- | include/git2/remote.h | 20 |
1 files changed, 7 insertions, 13 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h index 13b04367c..fa8b378c6 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -25,13 +25,6 @@ GIT_BEGIN_DECL typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, void *payload); -/* - * TODO: This functions still need to be implemented: - * - _listcb/_foreach - * - _add - * - _rename - * - _del (needs support from config) - */ /** * Add a remote with the default fetch refspec to the repository's configuration. This @@ -255,13 +248,14 @@ GIT_EXTERN(int) git_remote_connect(git_remote *remote, git_direction direction); GIT_EXTERN(int) git_remote_ls(git_remote *remote, git_headlist_cb list_cb, void *payload); /** - * Download the packfile + * Download and index the packfile + * + * Connect to the remote if it hasn't been done yet, negotiate with + * the remote git which objects are missing, download and index the + * packfile. * - * Negotiate what objects should be downloaded and download the - * packfile with those objects. The packfile is downloaded with a - * temporary filename, as it's final name is not known yet. If there - * was no packfile needed (all the objects were available locally), - * filename will be NULL and the function will return success. + * The .idx file will be created and both it and the packfile with be + * renamed to their final name. * * @param remote the remote to download from * @param progress_cb function to call with progress information. Be aware that |