Skip to content

Commit 7705a46

Browse files
committed
sdist format: qualify pax compatibility
Signed-off-by: William Woodruff <william@yossarian.net>
1 parent bdc08be commit 7705a46

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

source/specifications/source-distribution-format.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,19 @@ at their respective paths relative to the root directory of the sdist
7474
No other content of a sdist is required or defined. Build systems can store
7575
whatever information they need in the sdist to build the project.
7676

77-
The tarball must use the modern POSIX.1-2001 pax tar format, which specifies
77+
The tarball MUST use the modern POSIX.1-2001 pax tar format, which specifies
7878
UTF-8 based file names. In particular, source distribution files must be readable
7979
using the standard library tarfile module with the open flag 'r:gz'.
8080

81+
Source distributions MUST NOT use non-pax features, even if those features are
82+
structurally compatible with the pax standard. Installers and other consumers MAY
83+
reject source distributions that are not strictly pax-conforming.
84+
85+
Examples of non-pax features include GNU-style or legacy ("V7")-style tar members
86+
and sparse member encodings (e.g. ``GNU.sparse`` extensions or ``S`` typeflag members).
87+
88+
The use of pax-style vendor extensions (such as ``SCHILY.xattr`` or ``LIBARCHIVE.xattr``)
89+
is NOT RECOMMENDED for interoperability reasons.
8190

8291
.. _sdist-archive-features:
8392

0 commit comments

Comments
 (0)