diff options
| author | Marc Mueller <30130371+cdce8p@users.noreply.github.com> | 2021-03-28 13:39:35 +0200 |
|---|---|---|
| committer | Marc Mueller <30130371+cdce8p@users.noreply.github.com> | 2021-04-03 21:13:18 +0200 |
| commit | 91e7956d961ef84080c30eb5253c220fa3b001dc (patch) | |
| tree | af717191d21c0281e9cac68a78ecc7e7dad4ef93 | |
| parent | 749b97499ea36d9a7660ed73db622837ae64c57d (diff) | |
| download | python-setuptools-git-91e7956d961ef84080c30eb5253c220fa3b001dc.tar.gz | |
Add documentation + changelog entries
| -rw-r--r-- | changelog.d/2620.breaking.rst | 5 | ||||
| -rw-r--r-- | changelog.d/2620.change.rst | 1 | ||||
| -rw-r--r-- | changelog.d/2620.deprecation.rst | 2 | ||||
| -rw-r--r-- | changelog.d/2620.doc.rst | 1 | ||||
| -rw-r--r-- | docs/references/keywords.rst | 12 | ||||
| -rw-r--r-- | docs/userguide/declarative_config.rst | 2 |
6 files changed, 22 insertions, 1 deletions
diff --git a/changelog.d/2620.breaking.rst b/changelog.d/2620.breaking.rst new file mode 100644 index 00000000..de91facc --- /dev/null +++ b/changelog.d/2620.breaking.rst @@ -0,0 +1,5 @@ +If neither ``license_file`` nor ``license_files`` is specified, the ``sdist`` +option will now auto-include files that match the following patterns: +``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, ``AUTHORS*``. +This matches the behavior of ``bdist_wheel``. +Any ``exclude`` in ``MANIFEST.in`` will overwrite it. -- by :user:`cdce8p` diff --git a/changelog.d/2620.change.rst b/changelog.d/2620.change.rst new file mode 100644 index 00000000..5470592d --- /dev/null +++ b/changelog.d/2620.change.rst @@ -0,0 +1 @@ +The ``license_file`` and ``license_files`` options now support glob patterns. -- by :user:`cdce8p` diff --git a/changelog.d/2620.deprecation.rst b/changelog.d/2620.deprecation.rst new file mode 100644 index 00000000..1af5f246 --- /dev/null +++ b/changelog.d/2620.deprecation.rst @@ -0,0 +1,2 @@ +The ``license_file`` option is now marked as deprecated. +Use ``license_files`` instead. -- by :user:`cdce8p` diff --git a/changelog.d/2620.doc.rst b/changelog.d/2620.doc.rst new file mode 100644 index 00000000..7564adac --- /dev/null +++ b/changelog.d/2620.doc.rst @@ -0,0 +1 @@ +Added documentation for the ``license_files`` option. -- by :user:`cdce8p` diff --git a/docs/references/keywords.rst b/docs/references/keywords.rst index 03ce9fa2..6485437b 100644 --- a/docs/references/keywords.rst +++ b/docs/references/keywords.rst @@ -76,6 +76,18 @@ Keywords ``license`` A string specifying the license of the package. +``license_file`` + + .. warning:: + ``license_file`` is deprecated. Use ``license_files`` instead. + +``license_files`` + + A list of glob patterns for license related files that should be included. + If neither ``license_file`` nor ``license_files`` is specified, this option + defaults to ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, and ``AUTHORS*``. + Any ``exclude`` specified in ``MANIFEST.in`` will overwrite it. + ``keywords`` A list of strings or a comma-separated string providing descriptive meta-data. See: `PEP 0314`_. diff --git a/docs/userguide/declarative_config.rst b/docs/userguide/declarative_config.rst index f2e8b81f..7c97ca1c 100644 --- a/docs/userguide/declarative_config.rst +++ b/docs/userguide/declarative_config.rst @@ -184,7 +184,7 @@ maintainer_email maintainer-email str classifiers classifier file:, list-comma license str license_file str -license_files list-comma +license_files list-comma 42.0.0 description summary file:, str long_description long-description file:, str long_description_content_type str 38.6.0 |