* [PATCH] Makefile: List the sphinx documentation in 'make help'
@ 2020-01-22 17:21 Philippe Mathieu-Daudé
2020-01-22 19:25 ` Richard Henderson
2020-01-23 11:53 ` Peter Maydell
0 siblings, 2 replies; 4+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-01-22 17:21 UTC (permalink / raw)
To: qemu-devel; +Cc: qemu-trivial, Peter Maydell, Philippe Mathieu-Daudé
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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
2020-01-22 17:21 [PATCH] Makefile: List the sphinx documentation in 'make help' Philippe Mathieu-Daudé
@ 2020-01-22 19:25 ` Richard Henderson
2020-01-23 11:53 ` Peter Maydell
1 sibling, 0 replies; 4+ messages in thread
From: Richard Henderson @ 2020-01-22 19:25 UTC (permalink / raw)
To: Philippe Mathieu-Daudé, qemu-devel; +Cc: qemu-trivial, Peter Maydell
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~
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
2020-01-22 17:21 [PATCH] Makefile: List the sphinx documentation in 'make help' Philippe Mathieu-Daudé
2020-01-22 19:25 ` Richard Henderson
@ 2020-01-23 11:53 ` Peter Maydell
2020-01-23 17:48 ` Philippe Mathieu-Daudé
1 sibling, 1 reply; 4+ messages in thread
From: Peter Maydell @ 2020-01-23 11:53 UTC (permalink / raw)
To: Philippe Mathieu-Daudé; +Cc: QEMU Trivial, QEMU Developers
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Makefile: List the sphinx documentation in 'make help'
2020-01-23 11:53 ` Peter Maydell
@ 2020-01-23 17:48 ` Philippe Mathieu-Daudé
0 siblings, 0 replies; 4+ messages in thread
From: Philippe Mathieu-Daudé @ 2020-01-23 17:48 UTC (permalink / raw)
To: Peter Maydell; +Cc: QEMU Trivial, QEMU Developers
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 :/
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-01-23 19:44 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-01-22 17:21 [PATCH] Makefile: List the sphinx documentation in 'make help' Philippe Mathieu-Daudé
2020-01-22 19:25 ` Richard Henderson
2020-01-23 11:53 ` Peter Maydell
2020-01-23 17:48 ` Philippe Mathieu-Daudé
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).