Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

[PATCH] Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

Posted by Yi Wang 5 years, 8 months ago

From: Liao Pingfang <liao.pingfang@zte.com.cn>

We need install qemu-[qmp/ga]-ref.* files into the subdirectory of qemu docs: interop.

If we visit the following address and click the link to qemu-qmp-ref.html:
https://www.qemu.org/docs/master/interop/bitmaps.html#basic-qmp-usage

It will report following error:
"
Not Found
The requested URL /docs/master/interop/qemu-qmp-ref.html was not found on this server.
"

Signed-off-by: Liao Pingfang <liao.pingfang@zte.com.cn>
---
 Makefile           | 10 ++++++----
 docs/index.html.in |  4 ++--
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/Makefile b/Makefile
index 40e4f76..49dbe7a 100644
--- a/Makefile
+++ b/Makefile
@@ -879,8 +879,9 @@ install-sphinxdocs: sphinxdocs
 install-doc: $(DOCS) install-sphinxdocs
 	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
 	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
-	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)"
-	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)"
+	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
+	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
+	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
 ifdef CONFIG_POSIX
 	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
 	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu.1 "$(DESTDIR)$(mandir)/man1"
@@ -898,8 +899,9 @@ ifdef CONFIG_TRACE_SYSTEMTAP
 endif
 ifneq (,$(findstring qemu-ga,$(TOOLS)))
 	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
-	$(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)"
-	$(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)"
+	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
+	$(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
+	$(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
 	$(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"
 endif
 endif
diff --git a/docs/index.html.in b/docs/index.html.in
index e9a1603..6736fa4 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -12,8 +12,8 @@
             <li><a href="tools/index.html">Tools Guide</a></li>
             <li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
             <li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
-            <li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
-            <li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
+            <li><a href="interop/qemu-qmp-ref.html">QMP Reference Manual</a></li>
+            <li><a href="interop/qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
         </ul>
     </body>
 </html>
-- 
2.9.5

Re: [PATCH] Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

Posted by Philippe Mathieu-Daudé 5 years, 8 months ago

On 6/9/20 2:47 AM, Yi Wang wrote:
> From: Liao Pingfang <liao.pingfang@zte.com.cn>
> 
> We need install qemu-[qmp/ga]-ref.* files into the subdirectory of qemu docs: interop.
> 
> If we visit the following address and click the link to qemu-qmp-ref.html:
> https://www.qemu.org/docs/master/interop/bitmaps.html#basic-qmp-usage
> 
> It will report following error:
> "
> Not Found
> The requested URL /docs/master/interop/qemu-qmp-ref.html was not found on this server.
> "
> 

Fixes: d59157ea058b5 ('docs: create interop/ subdirectory')
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

> Signed-off-by: Liao Pingfang <liao.pingfang@zte.com.cn>
> ---
>  Makefile           | 10 ++++++----
>  docs/index.html.in |  4 ++--
>  2 files changed, 8 insertions(+), 6 deletions(-)
> 
> diff --git a/Makefile b/Makefile
> index 40e4f76..49dbe7a 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -879,8 +879,9 @@ install-sphinxdocs: sphinxdocs
>  install-doc: $(DOCS) install-sphinxdocs
>  	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
>  	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
> -	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)"
> -	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)"
> +	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
> +	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
> +	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
>  ifdef CONFIG_POSIX
>  	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
>  	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu.1 "$(DESTDIR)$(mandir)/man1"
> @@ -898,8 +899,9 @@ ifdef CONFIG_TRACE_SYSTEMTAP
>  endif
>  ifneq (,$(findstring qemu-ga,$(TOOLS)))
>  	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
> -	$(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)"
> -	$(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)"
> +	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
> +	$(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
> +	$(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
>  	$(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"
>  endif
>  endif
> diff --git a/docs/index.html.in b/docs/index.html.in
> index e9a1603..6736fa4 100644
> --- a/docs/index.html.in
> +++ b/docs/index.html.in
> @@ -12,8 +12,8 @@
>              <li><a href="tools/index.html">Tools Guide</a></li>
>              <li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
>              <li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
> -            <li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
> -            <li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
> +            <li><a href="interop/qemu-qmp-ref.html">QMP Reference Manual</a></li>
> +            <li><a href="interop/qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
>          </ul>
>      </body>
>  </html>
>

Re: [PATCH] Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

Posted by Paolo Bonzini 5 years, 7 months ago

On 09/06/20 06:28, Philippe Mathieu-Daudé wrote:
> On 6/9/20 2:47 AM, Yi Wang wrote:
>> From: Liao Pingfang <liao.pingfang@zte.com.cn>
>>
>> We need install qemu-[qmp/ga]-ref.* files into the subdirectory of qemu docs: interop.
>>
>> If we visit the following address and click the link to qemu-qmp-ref.html:
>> https://www.qemu.org/docs/master/interop/bitmaps.html#basic-qmp-usage
>>
>> It will report following error:
>> "
>> Not Found
>> The requested URL /docs/master/interop/qemu-qmp-ref.html was not found on this server.
>> "
>>
> 
> Fixes: d59157ea058b5 ('docs: create interop/ subdirectory')
> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> 
>> Signed-off-by: Liao Pingfang <liao.pingfang@zte.com.cn>
>> ---
>>  Makefile           | 10 ++++++----
>>  docs/index.html.in |  4 ++--
>>  2 files changed, 8 insertions(+), 6 deletions(-)
>>
>> diff --git a/Makefile b/Makefile
>> index 40e4f76..49dbe7a 100644
>> --- a/Makefile
>> +++ b/Makefile
>> @@ -879,8 +879,9 @@ install-sphinxdocs: sphinxdocs
>>  install-doc: $(DOCS) install-sphinxdocs
>>  	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
>>  	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/index.html "$(DESTDIR)$(qemu_docdir)"
>> -	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)"
>> -	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)"
>> +	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
>> +	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
>> +	$(INSTALL_DATA) docs/interop/qemu-qmp-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
>>  ifdef CONFIG_POSIX
>>  	$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
>>  	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu.1 "$(DESTDIR)$(mandir)/man1"
>> @@ -898,8 +899,9 @@ ifdef CONFIG_TRACE_SYSTEMTAP
>>  endif
>>  ifneq (,$(findstring qemu-ga,$(TOOLS)))
>>  	$(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-ga.8 "$(DESTDIR)$(mandir)/man8"
>> -	$(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)"
>> -	$(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)"
>> +	$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)/interop"
>> +	$(INSTALL_DATA) docs/interop/qemu-ga-ref.html "$(DESTDIR)$(qemu_docdir)/interop"
>> +	$(INSTALL_DATA) docs/interop/qemu-ga-ref.txt "$(DESTDIR)$(qemu_docdir)/interop"
>>  	$(INSTALL_DATA) docs/interop/qemu-ga-ref.7 "$(DESTDIR)$(mandir)/man7"
>>  endif
>>  endif
>> diff --git a/docs/index.html.in b/docs/index.html.in
>> index e9a1603..6736fa4 100644
>> --- a/docs/index.html.in
>> +++ b/docs/index.html.in
>> @@ -12,8 +12,8 @@
>>              <li><a href="tools/index.html">Tools Guide</a></li>
>>              <li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
>>              <li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
>> -            <li><a href="qemu-qmp-ref.html">QMP Reference Manual</a></li>
>> -            <li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
>> +            <li><a href="interop/qemu-qmp-ref.html">QMP Reference Manual</a></li>
>> +            <li><a href="interop/qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
>>          </ul>
>>      </body>
>>  </html>
>>
> 

Queued, thanks.

Paolo

Re: [PATCH] Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

Posted by Peter Maydell 5 years, 7 months ago

On Mon, 15 Jun 2020 at 17:13, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> On 09/06/20 06:28, Philippe Mathieu-Daudé wrote:
> > On 6/9/20 2:47 AM, Yi Wang wrote:
> >> From: Liao Pingfang <liao.pingfang@zte.com.cn>
> >>
> >> We need install qemu-[qmp/ga]-ref.* files into the subdirectory of qemu docs: interop.
> >>
> >> If we visit the following address and click the link to qemu-qmp-ref.html:
> >> https://www.qemu.org/docs/master/interop/bitmaps.html#basic-qmp-usage
> >>
> >> It will report following error:
> >> "
> >> Not Found
> >> The requested URL /docs/master/interop/qemu-qmp-ref.html was not found on this server.
> >> "
> >>

> Queued, thanks.

I guess this works, but it's kind of odd because it's installing
a non-Sphinx document into the Sphinx manual directory.

I'm hoping we'll be able to land the conversion of the qapigen
stuff to rst this cycle, which will make this change moot;
so I suppose it's the most expedient fix for the moment.

thanks
-- PMM

Re: [PATCH] Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

Posted by Paolo Bonzini 5 years, 7 months ago

On 15/06/20 18:32, Peter Maydell wrote:
>> Queued, thanks.
> I guess this works, but it's kind of odd because it's installing
> a non-Sphinx document into the Sphinx manual directory.
> 
> I'm hoping we'll be able to land the conversion of the qapigen
> stuff to rst this cycle, which will make this change moot;
> so I suppose it's the most expedient fix for the moment.

I can keep the patch in the queue and not submit it unless really necessary.

Paolo

Re: [PATCH] Makefile: Install qemu-[qmp/ga]-ref.* into the directory "interop"

Posted by Peter Maydell 5 years, 7 months ago

On Mon, 15 Jun 2020 at 18:00, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> On 15/06/20 18:32, Peter Maydell wrote:
> >> Queued, thanks.
> > I guess this works, but it's kind of odd because it's installing
> > a non-Sphinx document into the Sphinx manual directory.
> >
> > I'm hoping we'll be able to land the conversion of the qapigen
> > stuff to rst this cycle, which will make this change moot;
> > so I suppose it's the most expedient fix for the moment.
>
> I can keep the patch in the queue and not submit it unless really necessary.

Probably better to apply it; the conversion patchset is pretty
big and is going to need at least one more round of review.
And this fix won't be a big deal to fix up the conflict for.

thanks
-- PMM