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

double copy of "Programming in Cryptol" included in release #969

Closed
kiniry opened this issue Nov 16, 2020 · 4 comments · Fixed by #970
Closed

double copy of "Programming in Cryptol" included in release #969

kiniry opened this issue Nov 16, 2020 · 4 comments · Fixed by #970
Labels
bug Something not working correctly docs LaTeX, markdown, literate haskell, or in-REPL documentation low-hanging fruit For issues that should be easy to fix maybe-fixed Might be resolved, but this needs to be confirmed.

Comments

@kiniry
Copy link
Member

kiniry commented Nov 16, 2020

The 2.9.1 release includes both doc/cryptol/Cryptol.pdf and doc/cryptol/ProgrammingCryptol.pdf which are identical.

@kiniry kiniry added bug Something not working correctly docs LaTeX, markdown, literate haskell, or in-REPL documentation low-hanging fruit For issues that should be easy to fix labels Nov 16, 2020
@kiniry
Copy link
Member Author

kiniry commented Nov 16, 2020

It looks like this started with the 2.9.0 release. Earlier releases did not have the duplication.

@brianhuffman
Copy link
Contributor

According to git log, doc/Cryptol.pdf was added in commit 2cb904e on May 15 this year. The log message for commit 5100132, dated July 28, includes the item "Remove duplicate copy of Programming Cryptol", and removes the doc/Cryptol.pdf file. So it looks like the problem is already fixed.

Way back in the git history, I also found 72cd17c, dated Apr 23, 2014, entitled "change name of book pdf". This is when the name of the cryptol book in the makefile was changed from Cryptol.pdf to ProgrammingCryptol.pdf. (Cryptol.pdf is still the name of the original file generated by latex in a temp directory before it is copied into docs by the makefile.) Perhaps this explains why a duplicate Cryptol.pdf might have been accidentally committed in the first place.

@brianhuffman
Copy link
Contributor

Actually I'm not 100% sure if the actual problem is fixed; the duplicate pdf is no longer checked in, but we need to check whatever script we use to generate the release tarballs to make sure that the tarballs don't contain duplicate pdfs.

@brianhuffman brianhuffman added the maybe-fixed Might be resolved, but this needs to be confirmed. label Nov 17, 2020
@atomb
Copy link
Contributor

atomb commented Nov 17, 2020

Yeah, it looks like the nightly build from last night still includes both. I see how to fix it, though. There's an unnecessary copy in one of the Makefiles.

atomb pushed a commit that referenced this issue Nov 17, 2020
Two different Makefiles each copied it and used different file names.

Closes #969.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something not working correctly docs LaTeX, markdown, literate haskell, or in-REPL documentation low-hanging fruit For issues that should be easy to fix maybe-fixed Might be resolved, but this needs to be confirmed.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants