Skip to content

Commit 90524ae

Browse files
committed
DOC: update
1 parent 705cd25 commit 90524ae

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/explanations/design-old.rst

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,19 @@ wheel (binary distribution) from Meson_ project.
3434
Source distribution (sdist)
3535
---------------------------
3636

37-
The source distribution is based on ``meson dist``, so make sure all your files
38-
are included there. In git projects, Meson_ will not include files that are not
39-
checked into git, keep that in mind when developing. By default, all files
40-
under version control will be included in the sdist. In order to exclude files,
41-
use ``export-ignore`` or ``export-subst`` attributes in ``.gitattributes`` (see
42-
the ``git-archive`` documentation for details; ``meson dist`` uses
43-
``git-archive`` under the hood).
44-
45-
Local (uncommitted) changes to files that are under version control will be
46-
included. This is often needed when applying patches, e.g. for build issues
47-
found during packaging, to work around test failures, to amend the license for
48-
vendored components in wheels, etc.
37+
The source distribution is base on ``meson dist``: the archive is
38+
created adding the required metadata files to the archive obtained
39+
running ``meson dist --no-tests --allow-dirty``. This archive
40+
contains the full contents of the latest commit in revision
41+
control. All revision control metadata is removed.
42+
43+
The ``meson dist`` uses the archival tool of the revision control
44+
system for creating the archive. Files can be excluded from the source
45+
distribution To exclude files from the source distribution, use
46+
``export-ignore`` or ``export-subst`` attributes in ``.gitattributes``
47+
(see the ``git-archive`` documentation for details; ``meson dist``
48+
uses ``git-archive`` under the hood).
49+
4950

5051
Binary distribution (wheels)
5152
----------------------------

0 commit comments

Comments
 (0)