From 83071f579c4ae14c469d83caa71e80a4be3689df Mon Sep 17 00:00:00 2001 From: Kerrick Staley Date: Sat, 18 Jun 2011 23:24:05 -0500 Subject: Documented _alpm_download() Documented the _alpm_download() function in dload.c Signed-off-by: Kerrick Staley Signed-off-by: Dan McGee --- lib/libalpm/dload.c | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'lib/libalpm/dload.c') diff --git a/lib/libalpm/dload.c b/lib/libalpm/dload.c index 93545624..33fb1cb8 100644 --- a/lib/libalpm/dload.c +++ b/lib/libalpm/dload.c @@ -311,6 +311,16 @@ cleanup: } #endif +/** Download a file given by a URL to a local directory. + * Does not overwrite an existing file if the download fails. + * @param handle the context handle + * @param url the file's URL + * @param localpath the directory to save the file in + * @param force force download even if there is an up-to-date local copy + * @param allow_resume allow a partial download to be resumed + * @param errors_ok do not log errors (but still return them) + * @return 0 on success, -1 on error (pm_errno is set accordingly if errors_ok == 0) + */ int _alpm_download(pmhandle_t *handle, const char *url, const char *localpath, int force, int allow_resume, int errors_ok) { -- cgit v1.2.3-24-g4f1b