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

Interrupt documentation build on error #15455

Closed
vbraun opened this issue Nov 26, 2013 · 12 comments
Closed

Interrupt documentation build on error #15455

vbraun opened this issue Nov 26, 2013 · 12 comments

Comments

@vbraun
Copy link
Member

vbraun commented Nov 26, 2013

Interrupt documentation building if an error is encountered. Aso, search output for more error conditions (equivalent to Jeroen's release manager script).

Component: documentation

Branch/Commit: u/vbraun/docbuild_error @ f6accfa

Reviewer: Jeroen Demeyer

Issue created by migration from https://trac.sagemath.org/ticket/15455

@vbraun vbraun added this to the sage-6.1 milestone Nov 26, 2013
@vbraun
Copy link
Member Author

vbraun commented Nov 26, 2013

Branch: u/vbraun/docbuild_error

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Nov 26, 2013

Branch pushed to git repo; I updated commit sha1. New commits:

[f6accfa](https://github.com/sagemath/sagetrac-mirror/commit/f6accfa)be less strict during inventory build

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Nov 26, 2013

Commit: f6accfa

@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.1, sage-6.2 Jan 30, 2014
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.2, sage-6.3 May 6, 2014
@sagetrac-vbraun-spam sagetrac-vbraun-spam mannequin modified the milestones: sage-6.3, sage-6.4 Aug 10, 2014
@jdemeyer
Copy link

Changed author from Volker Braun to none

@jdemeyer
Copy link

Reviewer: Jeroen Demeyer

@jdemeyer
Copy link

comment:6

Isn't this already happening?

@vbraun
Copy link
Member Author

vbraun commented Sep 10, 2015

comment:8

No, concurrent workers are not interrupted. Especially PDF build errors are typically sandwiched between 1000's of lines of unrelated output.

@jhpalmieri
Copy link
Member

comment:9

I'm not sure I would want concurrent workers interrupted, at least for html docs. If reference/combinat is 90% done and going to build correctly and the error is somewhere else, I want to be able to try to fix the error and then not have to wait for combinat to build again from scratch.

This might be more useful for the PDF docs, since I don't think the docbuilder does a good job of detecting whether the docs have been successfully built already.

@vbraun
Copy link
Member Author

vbraun commented Sep 10, 2015

comment:10

Of course the annoyance factor depends on how much the concurrent jobs spew out. In a makefile, gcc will only add a line or so which is negligible. But you really want to see the error within the last ~50 lines, everything else is imho very confusing. The thousands of lines of PDF output easily flood the scrollback buffer, that I'd call a total disaster.

@jhpalmieri
Copy link
Member

comment:11

Fortunately, the PDF build is logged. If the PDF build fails, maybe we could get better error-reporting: report, for example, if there is a (recent?) LaTeX file in output/latex/en/reference/MODULE/ but no PDF file in output/pdf/en/reference/MODULE/. Or switch to a serial build to isolate the problem.

Comparing with make, I don't want make to interrupt concurrent workers, so I don't think I want docbuilding to do this, either.

@vbraun
Copy link
Member Author

vbraun commented Sep 10, 2015

comment:12

Its a recurring pain point that people fail to find the errors in their PDF file, but I guess it just hurts to be stupid.

@jdemeyer
Copy link

comment:14

Huh? I thought you disagreed with closing this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants