@@ -215,19 +215,24 @@ Builtin mechanisms for obtaining version numbers
215215 Git archives are not supported due to Git shortcomings
216216
217217
218- File finders: automatic inclusion of tracked package data
219- ---------------------------------------------------------
218+ File finders hook makes most of MANIFEST.in unnecessary
219+ -------------------------------------------------------
220220
221- By using ``setuptools_scm ``, the default behavior of `include_package_data
222- <https://setuptools.readthedocs.io/en/latest/setuptools.html#including-data-files> `_
223- is altered, such that all data files in packages that are tracked by your SCM
224- are included by default. That is: when using ``setuptools_scm ``, it is not
225- needed to explicitly graft or include any package data in ``MANIFEST.in ``. To
226- exclude files ``MANIFEST.in `` may still be used.
227-
228- This mechanism is implemented using a `file_finders
221+ ``setuptools_scm `` implements a `file_finders
229222<https://setuptools.readthedocs.io/en/latest/setuptools.html#adding-support-for-revision-control-systems> `_
230- entry point.
223+ entry point which returns all files tracked by by your SCM. This eliminates
224+ the need for a manually constructed ``MANIFEST.in `` in most cases where this
225+ would be required when not using ``setuptools_scm ``, namely:
226+
227+ * To ensure all relevant files are packaged when running the ``sdist `` command.
228+
229+ * When using `include_package_data <https://setuptools.readthedocs.io/en/latest/setuptools.html#including-data-files >`_
230+ to include package data as part of the ``build `` or ``bdist_wheel ``.
231+
232+ ``MANIFEST.in `` may still be used: anything defined there overrides the hook.
233+ This is mostly useful to exclude files tracked in your SCM from packages,
234+ although in principle it can be used to explicitly include non-tracked files
235+ too.
231236
232237
233238Configuration parameters
0 commit comments