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

Improved development docs.

This commit is contained in:
Bastian Kleineidam 2012-05-12 12:57:01 +02:00
parent d93beae6ac
commit d7c7b6fcc6
1 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/development.txt
View File

@ -28,33 +28,35 @@ The convenience functions are:
* ``def extract(archive, verbose=False, outdir=None)`` * ``def extract(archive, verbose=False, outdir=None)``
This function extracts the given archive filename to the current Extracts the given archive filename to the current working directory
working directory or if specified to the given directory name in outdir. or if specified to the given directory name in outdir.
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.
Checks that the archive exists and is readable before extracting it.
* ``def list(archive, verbose=False)`` * ``def list(archive, verbose=False)``
This function lists the contents of the given archive filename Lists the contents of the given archive filename on stdout.
on stdout.
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.
Checks that the archive exists and is readable before listing it.
* ``def test(archive, verbose=False)`` * ``def test(archive, verbose=False)``
This function tests the given archive filename. Tests the given archive filename.
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.
Checks that the archive exists and is readable before testing it.
* ``def create(archive, *filenames, **kwargs)`` * ``def create(archive, *filenames, **kwargs)``
This function creates a new archive. The type of archive is determined 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.
exist.
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.
Checks that the archive is not already existing to avoid overwriting it.
Also checks that the filename list is not empty and that all files exist
and are readable.
* ``def diff(archive1, archive2, verbose=False)`` * ``def diff(archive1, archive2, verbose=False)``
@ -63,12 +65,14 @@ The convenience functions are:
recursively with the diff(1) program. recursively with the diff(1) program.
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.
Checks that both archives exist and are readable.
* ``def repack(archive1, archive2, verbose=False)`` * ``def repack(archive1, archive2, verbose=False)``
This function extracts the contents of archive1 and packs them This function extracts the contents of archive1 and packs them
into archive2. into archive2.
Archive1 and archive2 must be different files.
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.
Checks that archive1 exists and is readable. Also checks that
archive2 does not exist to avoid overwriting it.