[PATCH v3] docs: make sphinx-build be quiet by default

Daniel P. Berrangé posted 1 patch 2 years, 8 months ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20210812102427.4036399-1-berrange@redhat.com
docs/meson.build | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH v3] docs: make sphinx-build be quiet by default
Posted by Daniel P. Berrangé 2 years, 8 months ago
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 v3:

 - Just set -q flag once in common arg list

 docs/meson.build | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/meson.build b/docs/meson.build
index 300b134329..cffe1ecf1d 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -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


Re: [PATCH v3] docs: make sphinx-build be quiet by default
Posted by Philippe Mathieu-Daudé 2 years, 8 months ago
On 8/12/21 12:24 PM, Daniel P. Berrangé 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>
> ---
> 
> In v3:
> 
>  - Just set -q flag once in common arg list
> 
>  docs/meson.build | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/docs/meson.build b/docs/meson.build
> index 300b134329..cffe1ecf1d 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -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: Philippe Mathieu-Daudé <philmd@redhat.com>


Re: [PATCH v3] docs: make sphinx-build be quiet by default
Posted by Marc-André Lureau 2 years, 8 months ago
On Thu, Aug 12, 2021 at 2:25 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>
>

much welcome
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>

---
>
> In v3:
>
>  - Just set -q flag once in common arg list
>
>  docs/meson.build | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/docs/meson.build b/docs/meson.build
> index 300b134329..cffe1ecf1d 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -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
>
>
>

-- 
Marc-André Lureau