HA
/
patool
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document convenience functions.

This commit is contained in:
Bastian Kleineidam 2012-05-11 21:09:32 +02:00
parent 3bd8441fa5
commit bae89f9c67
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/changelog.txt
View File

@ -3,6 +3,8 @@
* Document the --outdir option for the extract command. * Document the --outdir option for the extract command.
Closes: SF bug #3363964 Closes: SF bug #3363964
* Added convenience library function to handle archives. * Added convenience library function to handle archives.
Documentation for those functions can be found in
doc/development.txt.
Closes: SF bug #3351936 Closes: SF bug #3351936
* Fix generating an RPM installer. * Fix generating an RPM installer.
Closes: SF bug #2977749 Closes: SF bug #2977749
@ -10,7 +12,6 @@
* Added support for the plzip program handling LZIP archives. * Added support for the plzip program handling LZIP archives.
* Prevent overwriting the same file with repack. * Prevent overwriting the same file with repack.
0.15 "Contraband" (released 8.4.2012) 0.15 "Contraband" (released 8.4.2012)
* Print help when unknown options are given. * Print help when unknown options are given.

17
doc/development.txt
View File

@ -48,18 +48,27 @@ The convenience functions are:
* ``def create(archive, *filenames, **kwargs)`` * ``def create(archive, *filenames, **kwargs)``
This function create a new archive. The type of archive is determined This function creates a new archive. The type of archive is determined
by the archive filename extension. The archive must not already by the archive filename extension. The archive must not already
exist. exist.
The list of filenames to add to the archive must not be empty. The list of filenames to add to the archive must not be empty and the
files must exist and be readable.
If verbose operation is set to True, additional output of the archive If verbose operation is set to True, additional output of the archive
program is shown. program is shown.
* ``def diff(archive1, archive2, verbose=False)`` * ``def diff(archive1, archive2, verbose=False)``
This function This function lists differences in the content of the two archives.
Both archives are extracted and the contents are compared
recursively with the diff(1) program.
If verbose operation is set to True, additional output of the archive
program is shown.
* ``def repack(archive1, archive2, verbose=False)`` * ``def repack(archive1, archive2, verbose=False)``
This function This function extracts the contents of archive1 and packs them
into archive2.
Archive1 and archive2 must be different files.
If verbose operation is set to True, additional output of the archive
program is shown.