* [PATCH v2] docs: make sphinx-build be quiet by default
@ 2021-08-10 11:32 Daniel P. Berrangé
2021-08-11 11:22 ` Marc-André Lureau
0 siblings, 1 reply; 3+ messages in thread
From: Daniel P. Berrangé @ 2021-08-10 11:32 UTC (permalink / raw)
To: qemu-devel; +Cc: Daniel P. Berrangé
The sphinx-build is fairly verbose spitting out pages of output to the
console, which causes errors from other build commands to be scrolled
off the top of the terminal. This can leave the mistaken impression that
the build passed, when in fact there was a failure.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
In v2:
- This time with the extra trailing ',' actually committed
docs/meson.build | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/docs/meson.build b/docs/meson.build
index 300b134329..42d7555bc4 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -21,7 +21,7 @@ if sphinx_build.found()
run_command('mkdir', ['-p', tmpdir / 'sphinx'])
run_command('touch', [tmpdir / 'sphinx/index.rst'])
sphinx_build_test_out = run_command(SPHINX_ARGS + [
- '-c', meson.current_source_dir(),
+ '-q', '-c', meson.current_source_dir(),
'-b', 'html', tmpdir / 'sphinx',
tmpdir / 'sphinx/out'])
build_docs = (sphinx_build_test_out.returncode() == 0)
@@ -98,8 +98,9 @@ if build_docs
input: this_manual,
install: build_docs,
install_dir: install_dirs,
- command: [SPHINX_ARGS, '-b', 'man', '-d', private_dir,
- input_dir, meson.current_build_dir()])
+ command: [SPHINX_ARGS, '-q', '-b', 'man',
+ '-d', private_dir, input_dir,
+ meson.current_build_dir()])
alias_target('sphinxdocs', sphinxdocs)
alias_target('html', sphinxdocs)
--
2.31.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] docs: make sphinx-build be quiet by default
2021-08-10 11:32 [PATCH v2] docs: make sphinx-build be quiet by default Daniel P. Berrangé
@ 2021-08-11 11:22 ` Marc-André Lureau
2021-08-11 11:25 ` Daniel P. Berrangé
0 siblings, 1 reply; 3+ messages in thread
From: Marc-André Lureau @ 2021-08-11 11:22 UTC (permalink / raw)
To: Daniel P. Berrangé; +Cc: QEMU
[-- Attachment #1: Type: text/plain, Size: 2709 bytes --]
Hi
On Tue, Aug 10, 2021 at 3:32 PM Daniel P. Berrangé <berrange@redhat.com>
wrote:
> The sphinx-build is fairly verbose spitting out pages of output to the
> console, which causes errors from other build commands to be scrolled
> off the top of the terminal. This can leave the mistaken impression that
> the build passed, when in fact there was a failure.
>
> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
>
Without this patch, I miss the warnings 99% of the time!!
You are missing one -q though:
diff --git a/docs/meson.build b/docs/meson.build
index 42d7555bc4..51fa902cd9 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -78,7 +78,7 @@ if build_docs
input: files('conf.py'),
depfile: 'docs.d',
depend_files: [ sphinx_extn_depends, sphinx_template_files
],
- command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@',
+ command: [SPHINX_ARGS, '-q', '-Ddepfile=@DEPFILE@',
'-Ddepfile_stamp=@OUTPUT0@',
'-b', 'html', '-d', private_dir,
input_dir, output_dir])
Why not update SPHINX_ARGS instead?
---
>
> In v2:
>
> - This time with the extra trailing ',' actually committed
>
> docs/meson.build | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/docs/meson.build b/docs/meson.build
> index 300b134329..42d7555bc4 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -21,7 +21,7 @@ if sphinx_build.found()
> run_command('mkdir', ['-p', tmpdir / 'sphinx'])
> run_command('touch', [tmpdir / 'sphinx/index.rst'])
> sphinx_build_test_out = run_command(SPHINX_ARGS + [
> - '-c', meson.current_source_dir(),
> + '-q', '-c', meson.current_source_dir(),
> '-b', 'html', tmpdir / 'sphinx',
> tmpdir / 'sphinx/out'])
> build_docs = (sphinx_build_test_out.returncode() == 0)
> @@ -98,8 +98,9 @@ if build_docs
> input: this_manual,
> install: build_docs,
> install_dir: install_dirs,
> - command: [SPHINX_ARGS, '-b', 'man', '-d',
> private_dir,
> - input_dir,
> meson.current_build_dir()])
> + command: [SPHINX_ARGS, '-q', '-b', 'man',
> + '-d', private_dir, input_dir,
> + meson.current_build_dir()])
>
> alias_target('sphinxdocs', sphinxdocs)
> alias_target('html', sphinxdocs)
> --
> 2.31.1
>
>
>
--
Marc-André Lureau
[-- Attachment #2: Type: text/html, Size: 4006 bytes --]
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] docs: make sphinx-build be quiet by default
2021-08-11 11:22 ` Marc-André Lureau
@ 2021-08-11 11:25 ` Daniel P. Berrangé
0 siblings, 0 replies; 3+ messages in thread
From: Daniel P. Berrangé @ 2021-08-11 11:25 UTC (permalink / raw)
To: Marc-André Lureau; +Cc: QEMU
On Wed, Aug 11, 2021 at 03:22:43PM +0400, Marc-André Lureau wrote:
> Hi
>
> On Tue, Aug 10, 2021 at 3:32 PM Daniel P. Berrangé <berrange@redhat.com>
> wrote:
>
> > The sphinx-build is fairly verbose spitting out pages of output to the
> > console, which causes errors from other build commands to be scrolled
> > off the top of the terminal. This can leave the mistaken impression that
> > the build passed, when in fact there was a failure.
> >
> > Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
> >
>
> Without this patch, I miss the warnings 99% of the time!!
>
> You are missing one -q though:
>
> diff --git a/docs/meson.build b/docs/meson.build
> index 42d7555bc4..51fa902cd9 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -78,7 +78,7 @@ if build_docs
> input: files('conf.py'),
> depfile: 'docs.d',
> depend_files: [ sphinx_extn_depends, sphinx_template_files
> ],
> - command: [SPHINX_ARGS, '-Ddepfile=@DEPFILE@',
> + command: [SPHINX_ARGS, '-q', '-Ddepfile=@DEPFILE@',
> '-Ddepfile_stamp=@OUTPUT0@',
> '-b', 'html', '-d', private_dir,
> input_dir, output_dir])
>
> Why not update SPHINX_ARGS instead?
🤦 that would be a better idea.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-08-11 11:27 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-08-10 11:32 [PATCH v2] docs: make sphinx-build be quiet by default Daniel P. Berrangé
2021-08-11 11:22 ` Marc-André Lureau
2021-08-11 11:25 ` Daniel P. Berrangé
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).