Commit 64061d4a by Carlos Martín Nieto

remote: fix git_remote_download() documentation

The description of what the function does hasn't been true for quite a
while. Change it to reflect the way it currently works.

While here, remove an even older comment about missing features that
have been implemented.
parent c05a55b0
...@@ -25,13 +25,6 @@ ...@@ -25,13 +25,6 @@
GIT_BEGIN_DECL GIT_BEGIN_DECL
typedef int (*git_remote_rename_problem_cb)(const char *problematic_refspec, void *payload); 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 * 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); ...@@ -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); 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 * The .idx file will be created and both it and the packfile with be
* packfile with those objects. The packfile is downloaded with a * renamed to their final name.
* 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.
* *
* @param remote the remote to download from * @param remote the remote to download from
* @param progress_cb function to call with progress information. Be aware that * @param progress_cb function to call with progress information. Be aware that
......
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