diff options
Diffstat (limited to 'archivers/libarchive/files/doc/text/archive_entry_linkify.3.txt')
| -rw-r--r-- | archivers/libarchive/files/doc/text/archive_entry_linkify.3.txt | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/archivers/libarchive/files/doc/text/archive_entry_linkify.3.txt b/archivers/libarchive/files/doc/text/archive_entry_linkify.3.txt index 62eb5226bf0..6c8a5ddc81b 100644 --- a/archivers/libarchive/files/doc/text/archive_entry_linkify.3.txt +++ b/archivers/libarchive/files/doc/text/archive_entry_linkify.3.txt @@ -27,8 +27,8 @@ SYNOPSIS DESCRIPTION Programs that want to create archives have to deal with hardlinks. - Hardlinks are handled in different ways by the archive formats. The - basic strategies are: + Hardlinks are handled in different ways by the archive formats. The ba‐ + sic strategies are: 1. Ignore hardlinks and store the body for each reference (old cpio, zip). @@ -37,23 +37,23 @@ DESCRIPTION 3. Store the body the last time an inode is seen (new cpio). - The archive_entry_linkresolver functions help by providing a unified - interface and handling the complexity behind the scene. + The archive_entry_linkresolver functions help by providing a unified in‐ + terface and handling the complexity behind the scene. - The archive_entry_linkresolver functions assume that archive_entry - instances have valid nlinks, inode and device values. The inode and - device value is used to match entries. The nlinks value is used to - determined if all references have been found and if the internal refer‐ - ences can be recycled. + The archive_entry_linkresolver functions assume that archive_entry in‐ + stances have valid nlinks, inode and device values. The inode and device + value is used to match entries. The nlinks value is used to determined + if all references have been found and if the internal references can be + recycled. - The archive_entry_linkresolver_new() function allocates a new link - resolver. The instance can be freed using + The archive_entry_linkresolver_new() function allocates a new link re‐ + solver. The instance can be freed using archive_entry_linkresolver_free(). All deferred entries are flushed and the internal storage is freed. The archive_entry_linkresolver_set_strategy() function selects the opti‐ - mal hardlink strategy for the given format. The format code can be - obtained from archive_format(3). The function can be called more than + mal hardlink strategy for the given format. The format code can be ob‐ + tained from archive_format(3). The function can be called more than once, but it is recommended to flush all deferred entries first. The archive_entry_linkify() function is the core of @@ -66,8 +66,8 @@ DESCRIPTION 2. For tar like archive formats, *sparse is set to NULL. If *entry is NULL, no action is taken. If the hardlink count of *entry is larger - than 1 and the file type is a regular file or symbolic link, the - internal list is searched for a matching inode. If such an inode is + than 1 and the file type is a regular file or symbolic link, the in‐ + ternal list is searched for a matching inode. If such an inode is found, the link count is decremented and the file size of *entry is set to 0 to notify that no body should be written. If no such inode is found, a copy of the entry is added to the internal cache with a @@ -83,8 +83,8 @@ DESCRIPTION Otherwise, the internal list is searched for a matching inode. If such an inode is not found, the entry is added to the internal list, both *entry and *sparse are set to NULL and the function returns. - If such an inode is found, the link count is decremented. If it - remains larger than one, the existing entry on the internal list is + If such an inode is found, the link count is decremented. If it re‐ + mains larger than one, the existing entry on the internal list is swapped with *entry after retaining the link count. The existing entry is returned in *entry. If the link count reached one, the new entry is also removed from the internal list and returned in @@ -101,8 +101,8 @@ DESCRIPTION 4. If *sparse is not NULL, archive it. 5. After all entries have been written to disk, call - archive_entry_linkify() with *entry set to NULL and archive the - returned entry as long as it is not NULL. + archive_entry_linkify() with *entry set to NULL and archive the re‐ + turned entry as long as it is not NULL. RETURN VALUES archive_entry_linkresolver_new() returns NULL on malloc(3) failures. |