Skip to content
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.

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

Add STYLE document #210

Merged
merged 1 commit into from
Oct 16, 2019
Merged

Add STYLE document #210

merged 1 commit into from
Oct 16, 2019

Conversation

gperciva
Copy link
Member

No description provided.

@gperciva
Copy link
Member Author

This also adds it to the Makefile.am and release-tools/mktarball.sh.

@@ -10,7 +10,7 @@ RELEASEDATE=`date "+%B %d, %Y"`

# Copy bits in
mkdir ${DESTDIR} ${DESTDIR}/autotools
cp main.c FORMAT COPYRIGHT BUILDING ${DESTDIR}
cp main.c FORMAT COPYRIGHT BUILDING STYLE ${DESTDIR}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, do we need to ship STYLE? Do we expect anyone to send us a patch after looking at source code from the tarball rather than looking at the git repository?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, we're inconsistent elsewhere. spiped and kivaloo include STYLE, but tarsnap doesn't. I wouldn't say that we need to ship it, but I also wouldn't say that we don't need to ship it.

Answering a slightly different question: I can't imagine anybody complaining about us including it, but if we don't include it then we might get a helpful bug report about that "oversight". And my recent interest in this arose from somebody who very kindly produced a PR for scrypt, but which didn't match the (non-existent) STYLE (#209).

So I'd lean towards shipping it, but if you're confident that we don't need it, I can take it out of the tarballs (here and elsewhere).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, fair enough. It's small enough that it wouldn't get in the way any more than the other "documentation" files.

@cperciva cperciva merged commit 9a40195 into master Oct 16, 2019
@gperciva gperciva deleted the import-style branch October 16, 2019 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants