Skip to content

Commit b313c1d

Browse files
committed
document the new symlink_mode argument
1 parent 232da89 commit b313c1d

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,14 @@ and the optional third argument is the compression format (called “filter” i
114114
libarchive). The acceptable values are listed in ``libarchive.ffi.WRITE_FORMATS``
115115
and ``libarchive.ffi.WRITE_FILTERS``.
116116

117+
Symbolic links
118+
~~~~~~~~~~~~~~
119+
120+
By default, libarchive preserves symbolic links. If you want it to resolve the
121+
links and archive the files they point to instead, pass ``symlink_mode='logical'``
122+
when calling the ``add_files`` method. If you do that, an ``ArchiveError``
123+
exception will be raised when a symbolic link points to a nonexistent file.
124+
117125
File metadata codecs
118126
--------------------
119127

0 commit comments

Comments
 (0)