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

Option -q (quiet) gets not passed to latexmk #12717

Closed
jo-so opened this issue Jul 31, 2024 · 3 comments · Fixed by #12729
Closed

Option -q (quiet) gets not passed to latexmk #12717

jo-so opened this issue Jul 31, 2024 · 3 comments · Fixed by #12729
Milestone

Comments

@jo-so
Copy link

jo-so commented Jul 31, 2024

Describe the bug

Running sphinx-build with -q reduces the output for html, but not for latexpdf. I would be useful if the option -q results in the option -quiet for latexmk.

How to Reproduce

Run make O=-q latexpdf

Environment Information

Platform:              linux; (Linux-6.5.0-45-generic-x86_64-with-glibc2.35)
Python version:        3.10.12 (main, Mar 22 2024, 16:50:05) [GCC 11.4.0])
Python implementation: CPython
Sphinx version:        7.2.6
Docutils version:      0.18.1
Jinja2 version:        3.1.4
Pygments version:      2.18.0

Sphinx extensions

No response

Additional context

A workaround is the environment variable LATEXMKOPTS, e.g. running make O=-q LATEXMKOPTS=-quiet latexpdf reduces the output.

@jo-so jo-so added the type:bug label Jul 31, 2024
@jfbu jfbu added builder:latex type:proposal a feature suggestion labels Jul 31, 2024
@jfbu jfbu added this to the 8.x milestone Jul 31, 2024
@jfbu
Copy link
Contributor

jfbu commented Aug 3, 2024

The -q description is 'no output on stdout, just warnings on stderr'. This is not quite what Latexmk's -quiet (same as -silent) does. There is also -Q which says 'no output at all, not even warnings'.

We have to choose whether

  1. apply shell redirects also to the Latexmk runs after latex file is done,
  2. or follow your suggestion of Latexmk -quiet. In that case I would map -Q to Latexmk -quiet and use for -q rather LATEXOPTS=-halt-on-error -interaction=batchmode in place of LATEXMKOPTS=-quiet.

My preference is rather for 1. as 2. can always be achieved as you indicated with LATEXOPTS and/or LATEXMKOPTS on command line (or in environment).

@jo-so
Copy link
Author

jo-so commented Aug 4, 2024 via email

@jfbu
Copy link
Contributor

jfbu commented Aug 4, 2024

@jo-so I originally planned to do as -q and -Q for make html or make latex. The former inhibits stdout but leaves stderr echo on console output. The latter suppresses all messages. But Latexmk outputs to stderr some purely informative messages.

So it is a bit disturbing to expect only error messages to pop up and to see some innocuous Latexmk messages.

So in actual PR #12729, I decided that -q would leave Latexmk output is usual interaction but -batchmode is used (but maybe I tested on a too minimal project -- I need to check more when I get time) for the actual latex runs.

I am undecided, please have a look. The -Q suppresses completely all output to user except for a one line in case a LaTeX error is encountered in the pdf build phase.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 11, 2024
@AA-Turner AA-Turner modified the milestones: 8.x, 8.1.0 Oct 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants