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

Philippe Mathieu-Daudé posted 1 patch 4 years, 3 months ago
Test FreeBSD passed
Test docker-mingw@fedora passed
Test checkpatch passed
Test docker-quick@centos7 passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20200122172137.7282-1-philmd@redhat.com
Makefile | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Makefile: List the sphinx documentation in 'make help'
Posted by Philippe Mathieu-Daudé 4 years, 3 months ago
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é <philmd@redhat.com>
---
 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'
-- 
2.21.1


Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
Posted by Richard Henderson 4 years, 3 months ago
On 1/22/20 7:21 AM, Philippe Mathieu-Daudé 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é <philmd@redhat.com>
> ---
>  Makefile | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>


r~

Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
Posted by Peter Maydell 4 years, 3 months ago
On Wed, 22 Jan 2020 at 17:21, Philippe Mathieu-Daudé <philmd@redhat.com> 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é <philmd@redhat.com>
> ---
>  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

Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
Posted by Philippe Mathieu-Daudé 4 years, 3 months ago
On 1/23/20 12:53 PM, Peter Maydell wrote:
> On Wed, 22 Jan 2020 at 17:21, Philippe Mathieu-Daudé <philmd@redhat.com> 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é <philmd@redhat.com>
>> ---
>>   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).

Ah OK! I guess I didn't read enough the documentation then :/