sphinx icon indicating copy to clipboard operation
sphinx copied to clipboard

Please use consistent UNIX line endings in release tarballs

Open mitya57 opened this issue 3 years ago • 0 comments

Describe the bug

@AA-Turner Thank you for doing release work for Sphinx.

I am Sphinx maintainer in Debian and we are importing upstream tarballs into our version control system.

In the latest release 5.1.1, line endings format changed from UNIX-style \n to Windows-style \r\n for CHANGES and sphinx/__init__.py. This makes git diff not work properly, for example git thinks that CHANGES file change is 7045 insertions and 7035 deletions (while in fact it should be just 10 insertions).

See here: https://salsa.debian.org/python-team/packages/sphinx/-/commit/8d9ef9861ba22af08f539fd4c3231b10eead9ec8.

Please adjust your release scripting to use consistent \n endings for all files inside the tarball. Ideally, also for GPG signature (*.asc).

How to Reproduce

$ wget https://files.pythonhosted.org/packages/3a/30/ac07935542607c876f3fcee1c1ab043d253332567009994a1bf71d9b55cd/Sphinx-5.1.1.tar.gz
$ tar xzf Sphinx-5.1.1.tar.gz
$ cd Sphinx-5.1.1
$ file CHANGES
CHANGES: ASCII text, with CRLF line terminators
$ file README.rst   # this one is correct
README.rst: ASCII text

Expected behavior

No response

Your project

Debian packaging of Sphinx

Screenshots

No response

OS

Debian

Python version

3.10

Sphinx version

5.1.1

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

mitya57 avatar Jul 27 '22 09:07 mitya57