mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity

(trunk) #1220 'change top folder names' -- tweak the API documentation in transmission.h

This commit is contained in:
Jordan Lee 2013-01-19 08:50:57 +00:00
parent 03ac81e7c7
commit 10e4c297d6
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
libtransmission/transmission.h
View File

@ -1111,16 +1111,16 @@ typedef void (tr_torrent_rename_done_func)(tr_torrent * torrent,
*
* EXAMPLES
*
* Consider a torrent where
* files[0].path is "frobnitz-linux/checksum" and
* files[1].path is "frobnitz-linux/frobnitz.iso".
* Consider a tr_torrent where its
* info.files[0].name is "frobnitz-linux/checksum" and
* info.files[1].name is "frobnitz-linux/frobnitz.iso".
*
* 1. tr_torrentRenamePath (tor, "frobnitz-linux", "foo") will rename
* the "frotbnitz-linux" folder as "foo" and update files[*].path.
* the "frotbnitz-linux" folder as "foo" and update files[*].name.
*
* 2. tr_torrentRenamePath (tor, "frobnitz-linux/checksum", "foo") will
* rename the "frobnitz-linux/checksum" file as "foo" and update
* files[0].path to "frobnitz-linux/foo".
* files[0].name to "frobnitz-linux/foo".
*
* RETURN
*
@ -1130,8 +1130,8 @@ typedef void (tr_torrent_rename_done_func)(tr_torrent * torrent,
*
* On success, the callback's error argument will be 0.
*
* If oldpath can't be found in files[*].path, or if newname is already
* in files[*].path, or contains a directory separator, or is NULL, "",
* If oldpath can't be found in files[*].name, or if newname is already
* in files[*].name, or contains a directory separator, or is NULL, "",
* ".", or "..", the error argument will be EINVAL.
*
* If the path exists on disk but can't be renamed, the error argument