From bae89f9c6725e48e650d844eb1cd269767fe184d Mon Sep 17 00:00:00 2001 From: Bastian Kleineidam Date: Fri, 11 May 2012 21:09:32 +0200 Subject: [PATCH] Document convenience functions. --- doc/changelog.txt | 3 ++- doc/development.txt | 17 +++++++++++++---- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/doc/changelog.txt b/doc/changelog.txt index d157b13..e0b0e13 100644 --- a/doc/changelog.txt +++ b/doc/changelog.txt @@ -3,6 +3,8 @@ * Document the --outdir option for the extract command. Closes: SF bug #3363964 * Added convenience library function to handle archives. + Documentation for those functions can be found in + doc/development.txt. Closes: SF bug #3351936 * Fix generating an RPM installer. Closes: SF bug #2977749 @@ -10,7 +12,6 @@ * Added support for the plzip program handling LZIP archives. * Prevent overwriting the same file with repack. - 0.15 "Contraband" (released 8.4.2012) * Print help when unknown options are given. diff --git a/doc/development.txt b/doc/development.txt index 3f3cd38..ab88193 100644 --- a/doc/development.txt +++ b/doc/development.txt @@ -48,18 +48,27 @@ The convenience functions are: * ``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 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 program is shown. * ``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)`` - 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.