Skip to contentSkip to conversation

docs: make sphinx-build be quiet by default

PATCH In review Daniel P. Berrangé 3 participants 3 messages Aug 12, 2021 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 docs: make sphinx-build be quiet by default

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.

---

In v3:

- Just set -q flag once in common arg list

 docs/meson.build | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/meson.build +1 -1
index 300b134329..cffe1ecf1d 100644
@@ -9,7 +9,7 @@ endif
 # Check if tools are available to build documentation.
 build_docs = false
 if sphinx_build.found()
-  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
+  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build, '-q']
   # If we're making warnings fatal, apply this to Sphinx runs as well
   if get_option('werror')
     SPHINX_ARGS += [ '-W' ]
Signature · 1 line
2.31.1
Reviewed-by on v3 1/1
#1 lore raw
Quoted 21 lines · 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.

---

In v3:

- Just set -q flag once in common arg list

 docs/meson.build | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/meson.build +0 -0
index 300b134329..cffe1ecf1d 100644

docs/meson.build endif · line 15

Quoted 8 lines
docs/meson.build +1 -1
@@ -9,7 +9,7 @@ endif
 # Check if tools are available to build documentation.
 build_docs = false
 if sphinx_build.found()
-  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
+  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build, '-q']
   # If we're making warnings fatal, apply this to Sphinx runs as well
   if get_option('werror')
     SPHINX_ARGS += [ '-W' ]
Reviewed-by on v3 1/1
#2 lore raw
In reply to Daniel P. Berrangé
Quoted 7 lines · 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.

much welcome

---

Quoted 26 lines

In v3:

- Just set -q flag once in common arg list

 docs/meson.build | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
docs/meson.build +1 -2
index 300b134329..cffe1ecf1d 100644
@@ -9,7 +9,7 @@ endif
 # Check if tools are available to build documentation.
 build_docs = false
 if sphinx_build.found()
-  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build]
+  SPHINX_ARGS = ['env', 'CONFDIR=' + qemu_confdir, sphinx_build, '-q']
   # If we're making warnings fatal, apply this to Sphinx runs as well
   if get_option('werror')
     SPHINX_ARGS += [ '-W' ]
--

2.31.1

Signature · 1 line
Marc-André Lureau