Skip to content

Commit 4ccb5e1

Browse files
committed
[docs] Small fixes to the documentation of TarContainer.create(from:force:)
1 parent ba7e444 commit 4ccb5e1

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

Sources/TAR/TarContainer.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@ public class TarContainer: Container {
8686
/**
8787
Creates a new TAR container with `entries` as its content and generates its `Data` using the specified `format`.
8888

89-
This function forces the usage of the `format`, meaning that certain properties about the `entries` may be missing
90-
from the resulting container data if the chosen format doesn't support certain features. For example, relatively
91-
long names (and linknames) will be truncated if the `.ustar` or `.prePosix` format is specified.
89+
This function forces the usage of the `format`, meaning that certain properties of the `entries` may be missing
90+
from the resulting container data if the chosen format does not support corresponding features. For example,
91+
relatively long names (and linknames) will be truncated if the `.ustar` or `.prePosix` format is specified.
9292

9393
It is highly recommended to use the `TarContainer.create(from:)` function (or use the `.pax` format) to ensure the
9494
best representation of the `entries` in the output. Other (non-PAX) formats should only be used if you have a
9595
specific need for them and you understand limitations of those formats.
9696

9797
- Parameter entries: TAR entries to store in the container.
98-
- Parameter force: For the usage of the specified format.
98+
- Parameter force: Force the usage of the specified format.
9999

100100
- SeeAlso: `TarEntryInfo` properties documenation to see how their values are connected with the specific TAR
101101
format used during container creation.

Sources/swcomp/Extensions/TarEntry+Create.swift

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,6 @@ extension TarEntry {
166166
print(log)
167167
}
168168

169-
170169
if entryType == .directory {
171170
for subPath in try fileManager.contentsOfDirectory(atPath: inputPath) {
172171
try self.generateEntries(&writer, inputURL.appendingPathComponent(subPath).relativePath, verbose)

0 commit comments

Comments
 (0)