"make doc": use --quitonbreak; don't use workspaces; use single GAP session to do all the work #1448
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change is in accordance with the general UNIX philosophy: Users who want to log the output of `make doc` can simply redirect it into a file manually. But now users who don't want the the log files don't have to clean them out manually.
In addition: * use ----quitonbreak for better error detection. * Remove usage of workspaces, which are not currently available in HPC-GAP, thus breaking "make doc" there. Resolves gap-system#1445
Codecov Report
@@ Coverage Diff @@
## master #1448 +/- ##
==========================================
- Coverage 63.8% 63.79% -0.02%
==========================================
Files 1010 1010
Lines 337925 337925
Branches 13557 13557
==========================================
- Hits 215605 215568 -37
- Misses 119337 119371 +34
- Partials 2983 2986 +3
|
ChrisJefferson
approved these changes
Jun 24, 2017
olexandr-konovalov
approved these changes
Jun 26, 2017
| @@ -34,7 +34,7 @@ How to Proceed with the Reference Manual | |||
| (How to access the two manuals in question: | |||
| The current GAPDoc format version is the one in the development version | |||
| of GAP, | |||
| which can be compiled by calling `make manuals' in the GAP root directory. | |||
| which can be compiled by calling `make doc' in the GAP root directory. | |||
There was a problem hiding this comment.
If merged, remember to update https://github.com/gap-system/gap/wiki/Building-main-GAP-manuals as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an alternative to PR #1446
It also changes mentions of
make manualstomake doc(while the former is still supported, the later is the virtual standard for building documentation).Also, this stops creating
make_manuals.outlog files -- if you want to log the output ofmake doc, just pipe it into a file yourself. Or use the scroll back buffer of your terminal.