Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Misc: moved documentation in release tarballs. #377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jan 30, 2025
Merged

Misc: moved documentation in release tarballs. #377

merged 1 commit into from
Jan 30, 2025

Conversation

pluknet
Copy link
Contributor

@pluknet pluknet commented Dec 9, 2024

Switch to GitHub added unrelated files, which now pollutes the top-level archive directory.
This change moves them to the expected place, together with other files to be consistent across tarball and zip.

@pluknet pluknet added this to the nginx-1.27.4 milestone Dec 26, 2024
@bavshin-f5
Copy link
Member

zip: changes look good.

I don't believe in the necessity of this consistency though. The pre-GitHub tarball structure was fine (and in line with many other opensource projects), and between keeping 3 new files at the top level or moving everything under docs/ I'd prefer the former.
Although it wouldn't hurt to wrap the README at 80 col, to make it readable from the terminal.

@pluknet
Copy link
Contributor Author

pluknet commented Jan 21, 2025

zip: changes look good.

I don't believe in the necessity of this consistency though. The pre-GitHub tarball structure was fine (and in line with many other opensource projects), and between keeping 3 new files at the top level or moving everything under docs/ I'd prefer the former.

Indeed, LICENSE would break in various packaged software after this change, at least in FreeBSD ports.
And moving CHANGES* may break POLA.
Considering the above, it seems there is no much opportunity than to limit the change to the "zip" target only.

Although it wouldn't hurt to wrap the README at 80 col, to make it readable from the terminal.

That ship has sailed. Anyway, feel free to send patches.

@pluknet
Misc: moved documentation in generated ZIP archive.
df5ca7b 
The recently added GitHub files now reside in the docs directory.
@pluknet pluknet merged commit 04914cf into nginx:master Jan 30, 2025
1 check passed
@pluknet pluknet deleted the docs branch January 30, 2025 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bavshin-f5 bavshin-f5 bavshin-f5 approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
nginx-1.27.4
Development

Successfully merging this pull request may close these issues.
3 participants
@pluknet @bavshin-f5 @Maryna-f5