Commit Graph

27 Commits

Author SHA1 Message Date
Serhiy Storchaka b4905efe23 Issue #26736: Used HTTPS for external links in the documentation if possible. 2016-05-07 10:50:12 +03:00
Serhiy Storchaka 9a118f1dc3 Issue #26778: Fixed "a/an/and" typos in code comment and documentation. 2016-04-17 09:37:36 +03:00
Martin Panter d47b99643b Issue #25496: Document compresslevel defaults to 9, by Hamza T Khan 2016-04-13 03:24:06 +00:00
Martin Panter 59b9a16e72 Issues #22468, #21996, #22208: Clarify gettarinfo() and TarInfo usage
* Make it more obvious gettarinfo() is based on stat(), and that non-ordinary
  files may need special care
* Filename taken from fileobj.name; suggest dummy arcname as a workaround
* Indicate TarInfo may be used directly, not just via gettarinfo()
2016-02-19 23:34:56 +00:00
Martin Panter 53ae0ba6e3 Issue #26304: Change "allows to <verb>" to "allows <verb>ing" or similar
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
R David Murray c6cf35d36d #14056: Small improvements to the tarfile documentation.
Patch by Éric Araujo with help from Lars Gustäbel.
2014-10-03 20:30:42 -04:00
Serhiy Storchaka 581448be80 Issue #22369: Change "context manager protocol" to "context management protocol". 2014-09-10 23:46:14 +03:00
Benjamin Peterson 3afd956e09 document the compress_level argument to tarfile.open (closes #21404)
Patch by Katherine Busch.
2014-06-07 12:45:37 -07:00
Raymond Hettinger fd61349848 Issue 21479: Fix markup for the TarFile.open() classmethod. 2014-05-23 03:43:29 +01:00
Raymond Hettinger 198123c607 Issue 21198: Minor tarfile documentation bug. 2014-05-23 00:05:48 +01:00
Ezio Melotti 510ff54324 Use Python 3 instead of 3.0. 2012-05-03 19:21:40 +03:00
Éric Araujo c3cc2acb09 Improve interlinking of archiving/compression modules docs.
- Remove duplicate list of links to the other modules from each
  module’s doc (people can already go up to library/archiving and
  there they can see the list).

- Link to shutil high-level operations.

Reviewed by Nadeem Vawda in #6715.
2012-02-26 01:10:14 +01:00
Éric Araujo 29a0b57e4e Backport source links from 3.x.
Existing links have been updated to use the new reST role.  In some
files, I have also made cosmetic changes to the header.
2011-08-19 02:14:03 +02:00
Éric Araujo d9aeb60465 Remove unneeded reST target 2011-08-19 01:47:48 +02:00
Raymond Hettinger 32074e337e Add note advising that 'filter' be used as a keyword-argument. 2011-01-26 20:40:32 +00:00
Andrew M. Kuchling ca2413e2ad Punctuation fix 2010-04-11 01:40:06 +00:00
Lars Gustäbel 6458104188 Issue #7232: Add support for the context manager protocol
to the TarFile class.
2010-03-03 11:55:48 +00:00
Andrew M. Kuchling f5852f59d9 Fix narkup 2009-10-05 21:24:35 +00:00
Lars Gustäbel 21121e64b4 Issue #6856: Add a filter keyword argument to TarFile.add().
The filter argument must be a function that takes a TarInfo
object argument, changes it and returns it again. If the
function returns None the TarInfo object will be excluded
from the archive.
The exclude argument is deprecated from now on, because it
does something similar but is not as flexible.
2009-09-12 10:28:15 +00:00
Georg Brandl cf5608df81 #5821: add some capabilities of TarFile's file-like object. 2009-04-25 15:05:04 +00:00
Lars Gustäbel 727bd0b687 Issue #3039: Fix TarFileCompat.writestr() which always raised an
AttributeError since __slots__ were added to zipfile.ZipInfo in
r46967 two years ago.
Add a warning about the removal of TarFileCompat in Python 3.0.
2008-08-02 11:26:39 +00:00
Lars Gustäbel 4bfb59390c Replace signatures with optional arguments in square brackets with
keyword arguments and the actual default values.
Fix references that point nowhere or to the wrong place.
Add description of the ENCODING module-level variable.
Fix the URL pointing to the GNU tar manual.
Remove two obsolete examples.
Add an example on how to use a generator with TarFile.extractall().
2008-05-17 16:50:22 +00:00
Georg Brandl b19be571e0 Some cleanup in the docs. 2007-12-29 10:57:00 +00:00
Georg Brandl 2b92f6bab3 Diverse markup fixes. 2007-12-06 01:52:24 +00:00
Mark Summerfield aea6e5913b Added cross-references between the various archive file formats. 2007-11-05 09:22:48 +00:00
Lars Gustäbel 89241a3889 Warn about possible risks when extracting untrusted archives. 2007-08-30 20:24:31 +00:00
Georg Brandl 8ec7f65613 Move the 2.6 reST doc tree in place. 2007-08-15 14:28:01 +00:00