qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH] Makefile: List the sphinx documentation in 'make help'


From: Peter Maydell
Subject: Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
Date: Thu, 23 Jan 2020 11:53:27 +0000

On Wed, 22 Jan 2020 at 17:21, Philippe Mathieu-Daudé <address@hidden> wrote:
>
> In commit 5f71eac06e1 we started to support the rST documentation.
> List the build target we need to call to generate the rST files in
> the 'make help' output.
>
> Signed-off-by: Philippe Mathieu-Daudé <address@hidden>
> ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Makefile b/Makefile
> index 6562b0dc97..b777f7fcdd 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1197,7 +1197,7 @@ endif
>         @echo  '  vm-help         - Help about targets running tests inside 
> VM'
>         @echo  ''
>         @echo  'Documentation targets:'
> -       @echo  '  html info pdf txt'
> +       @echo  '  html info pdf txt sphinxdocs'
>         @echo  '                  - Build documentation in specified format'
>  ifdef CONFIG_GCOV
>         @echo  '  coverage-report - Create code coverage report'

'sphinxdocs' wasn't intended to be a user-facing target.
If you do 'make html' this will build the HTML Sphinx
documentation (as well as any legacy non-Sphinx HTML).

thanks
-- PMM



reply via email to

[Prev in Thread] Current Thread [Next in Thread]