qemu.nsi: Install Sphinx documentation
PATCH 1/1 qemu.nsi: Install Sphinx documentation
The old qemu-doc.html is no longer built, so update the Windows installer to install the new Sphinx manual sets.
We install all five of the manuals, even though some of them (notably the user-mode manual) will not be very useful to Windows users, because skipping some of them would mean broken links in the top level 'index.html' page.
---
I've tested this (building it via the fedora docker image and installing into a Windows VM) but I don't know anything much about the installer so there might be neater ways to do it...
NB: I didn't realize that patchew included a test of building the Windows installer, so until we get this (or some variant) into master I'm afraid patchew will be emailing failure reports to every submitted patchseries. Sorry about that :-(
--- qemu.nsi | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-)
qemu.nsi +19 -3
@@ -177,9 +177,20 @@ SectionEnd !ifdef CONFIG_DOCUMENTATION Section "Documentation" SectionDoc SetOutPath "$INSTDIR" - File "${BINDIR}\qemu-doc.html" + File "${BINDIR}\index.html" + SetOutPath "$INSTDIR\interop" + FILE /r "${BINDIR}\interop\*.*" + SetOutPath "$INSTDIR\specs" + FILE /r "${BINDIR}\specs\*.*" + SetOutPath "$INSTDIR\system" + FILE /r "${BINDIR}\system\*.*" + SetOutPath "$INSTDIR\tools" + FILE /r "${BINDIR}\tools\*.*" + SetOutPath "$INSTDIR\user" + FILE /r "${BINDIR}\user\*.*" + SetOutPath "$INSTDIR" CreateDirectory "$SMPROGRAMS\${PRODUCT}" - CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\qemu-doc.html" "" "$INSTDIR\qemu-doc.html" 0 + CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\index.html" "" "$INSTDIR\index.html" 0 SectionEnd !endif
@@ -227,7 +238,12 @@ Section "Uninstall" Delete "$INSTDIR\qemu-io.exe" Delete "$INSTDIR\qemu.exe" Delete "$INSTDIR\qemu-system-*.exe" - Delete "$INSTDIR\qemu-doc.html" + Delete "$INSTDIR\index.html" + RMDir /r "$INSTDIR\interop" + RMDir /r "$INSTDIR\specs" + RMDir /r "$INSTDIR\system" + RMDir /r "$INSTDIR\tools" + RMDir /r "$INSTDIR\user" RMDir /r "$INSTDIR\keymaps" RMDir /r "$INSTDIR\share" ; Remove generated files
Signature · 1 line
2.20.1
Quoted 27 lines · Peter Maydell
The old qemu-doc.html is no longer built, so update the Windows installer to install the new Sphinx manual sets.
We install all five of the manuals, even though some of them (notably the user-mode manual) will not be very useful to Windows users, because skipping some of them would mean broken links in the top level 'index.html' page.
Signed-off-by Peter Maydell <[email protected]>---
I've tested this (building it via the fedora docker image and installing into a Windows VM) but I don't know anything much about the installer so there might be neater ways to do it...NB: I didn't realize that patchew included a test of building the Windows installer, so until we get this (or some variant) into master I'm afraid patchew will be emailing failure reports to every submitted patchseries. Sorry about that :-(
--- qemu.nsi | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-)qemu.nsi +0
-0
qemu.nsi SectionEnd · line 179
Quoted 3 lines
qemu.nsi +0
-0@@ -177,9 +177,20 @@ SectionEnd !ifdef CONFIG_DOCUMENTATION Section "Documentation" SectionDoc SetOutPath "$INSTDIR"
Now that we have multiple files installed, I'd move them into a separate directory: ${INSTDIR}/docs/ seems appropriate. Can be done later.
qemu.nsi SectionEnd · line 191
Quoted 13 lines
qemu.nsi +12
-1- File "${BINDIR}\qemu-doc.html" + File "${BINDIR}\index.html" + SetOutPath "$INSTDIR\interop" + FILE /r "${BINDIR}\interop\*.*" + SetOutPath "$INSTDIR\specs" + FILE /r "${BINDIR}\specs\*.*" + SetOutPath "$INSTDIR\system" + FILE /r "${BINDIR}\system\*.*" + SetOutPath "$INSTDIR\tools" + FILE /r "${BINDIR}\tools\*.*" + SetOutPath "$INSTDIR\user" + FILE /r "${BINDIR}\user\*.*" + SetOutPath "$INSTDIR"
The last SetOutPath seems alone (copy/paste mistake I suppose). Otherwise looks good.
Quoted 21 lines
qemu.nsi +7
-2CreateDirectory "$SMPROGRAMS\${PRODUCT}" - CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\qemu-doc.html" "" "$INSTDIR\qemu-doc.html" 0 + CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\index.html" "" "$INSTDIR\index.html" 0 SectionEnd !endif@@ -227,7 +238,12 @@ Section "Uninstall" Delete "$INSTDIR\qemu-io.exe" Delete "$INSTDIR\qemu.exe" Delete "$INSTDIR\qemu-system-*.exe" - Delete "$INSTDIR\qemu-doc.html" + Delete "$INSTDIR\index.html" + RMDir /r "$INSTDIR\interop" + RMDir /r "$INSTDIR\specs" + RMDir /r "$INSTDIR\system" + RMDir /r "$INSTDIR\tools" + RMDir /r "$INSTDIR\user" RMDir /r "$INSTDIR\keymaps" RMDir /r "$INSTDIR\share" ; Remove generated files
Quoted 50 lines · Philippe Mathieu-Daudé
Quoted 27 lines · Peter Maydell
The old qemu-doc.html is no longer built, so update the Windows installer to install the new Sphinx manual sets.
We install all five of the manuals, even though some of them (notably the user-mode manual) will not be very useful to Windows users, because skipping some of them would mean broken links in the top level 'index.html' page.
Signed-off-by Peter Maydell <[email protected]>---
I've tested this (building it via the fedora docker image and installing into a Windows VM) but I don't know anything much about the installer so there might be neater ways to do it...NB: I didn't realize that patchew included a test of building the Windows installer, so until we get this (or some variant) into master I'm afraid patchew will be emailing failure reports to every submitted patchseries. Sorry about that :-(
--- qemu.nsi | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-)qemu.nsi +0
-0qemu.nsi SectionEnd · line 179
Quoted 3 lines
qemu.nsi +0
-0@@ -177,9 +177,20 @@ SectionEnd !ifdef CONFIG_DOCUMENTATION Section "Documentation" SectionDoc SetOutPath "$INSTDIR"Now that we have multiple files installed, I'd move them into a separate
directory: ${INSTDIR}/docs/ seems appropriate. Can be done later.qemu.nsi SectionEnd · line 191
Quoted 13 lines
qemu.nsi +12
-1- File "${BINDIR}\qemu-doc.html" + File "${BINDIR}\index.html" + SetOutPath "$INSTDIR\interop" + FILE /r "${BINDIR}\interop\*.*" + SetOutPath "$INSTDIR\specs" + FILE /r "${BINDIR}\specs\*.*" + SetOutPath "$INSTDIR\system" + FILE /r "${BINDIR}\system\*.*" + SetOutPath "$INSTDIR\tools" + FILE /r "${BINDIR}\tools\*.*" + SetOutPath "$INSTDIR\user" + FILE /r "${BINDIR}\user\*.*" + SetOutPath "$INSTDIR"
Quoted 2 lines
The last SetOutPath seems alone (copy/paste mistake I suppose). Otherwise looks good.
No, it's deliberate. I wanted to put the output path back to what it was at the start of this section, because I wasn't sure if any of the commands below this point implicitly depended on it.
Quoted 5 lines
qemu.nsi SectionEnd · line 195
Quoted 5 lines
qemu.nsi +1
-1CreateDirectory "$SMPROGRAMS\${PRODUCT}" - CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\qemu-doc.html" "" "$INSTDIR\qemu-doc.html" 0 + CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\index.html" "" "$INSTDIR\index.html" 0 SectionEnd !endif
thanks
-- PMM
Philippe Mathieu-Daudé
Reviewed-byQuoted 51 lines · Peter Maydell
Quoted 50 lines · Philippe Mathieu-Daudé
Quoted 27 lines · Peter Maydell
The old qemu-doc.html is no longer built, so update the Windows installer to install the new Sphinx manual sets.
We install all five of the manuals, even though some of them (notably the user-mode manual) will not be very useful to Windows users, because skipping some of them would mean broken links in the top level 'index.html' page.
Signed-off-by Peter Maydell <[email protected]>---
I've tested this (building it via the fedora docker image and installing into a Windows VM) but I don't know anything much about the installer so there might be neater ways to do it...NB: I didn't realize that patchew included a test of building the Windows installer, so until we get this (or some variant) into master I'm afraid patchew will be emailing failure reports to every submitted patchseries. Sorry about that :-(
--- qemu.nsi | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-)qemu.nsi +0
-0qemu.nsi SectionEnd · line 179
Quoted 3 lines
qemu.nsi +0
-0@@ -177,9 +177,20 @@ SectionEnd !ifdef CONFIG_DOCUMENTATION Section "Documentation" SectionDoc SetOutPath "$INSTDIR"Now that we have multiple files installed, I'd move them into a separate
directory: ${INSTDIR}/docs/ seems appropriate. Can be done later.Quoted 13 lines
qemu.nsi +12
-1- File "${BINDIR}\qemu-doc.html" + File "${BINDIR}\index.html" + SetOutPath "$INSTDIR\interop" + FILE /r "${BINDIR}\interop\*.*" + SetOutPath "$INSTDIR\specs" + FILE /r "${BINDIR}\specs\*.*" + SetOutPath "$INSTDIR\system" + FILE /r "${BINDIR}\system\*.*" + SetOutPath "$INSTDIR\tools" + FILE /r "${BINDIR}\tools\*.*" + SetOutPath "$INSTDIR\user" + FILE /r "${BINDIR}\user\*.*" + SetOutPath "$INSTDIR"
Quoted 7 lines
Quoted 2 lines
The last SetOutPath seems alone (copy/paste mistake I suppose). Otherwise looks good.
No, it's deliberate. I wanted to put the output path back to what it was at the start of this section, because I wasn't sure if any of the commands below this point implicitly depended on it.
Ah good point.
As this patch unbreaks patchew:
Quoted 9 lines
Quoted 5 lines
qemu.nsi SectionEnd · line 195
Quoted 5 lines
qemu.nsi +1
-1CreateDirectory "$SMPROGRAMS\${PRODUCT}" - CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\qemu-doc.html" "" "$INSTDIR\qemu-doc.html" 0 + CreateShortCut "$SMPROGRAMS\${PRODUCT}\User Documentation.lnk" "$INSTDIR\index.html" "" "$INSTDIR\index.html" 0 SectionEnd !endifthanks
-- PMM
Quoted 13 lines · Philippe Mathieu-Daudé
Quoted 11 lines · Peter Maydell
Quoted 10 lines · Philippe Mathieu-Daudé
Quoted 8 lines · Peter Maydell
The old qemu-doc.html is no longer built, so update the Windows installer to install the new Sphinx manual sets.
We install all five of the manuals, even though some of them (notably the user-mode manual) will not be very useful to Windows users, because skipping some of them would mean broken links in the top level 'index.html' page.
Quoted 4 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Signed-off-by Peter Maydell <[email protected]>As this patch unbreaks patchew:
Reviewed-by Philippe Mathieu-Daudé <[email protected]>
Thanks. Stefan, I've applied this to master as it unbreaks one of the patchew configs, but feel free to let me know if there are changes you'd like me to make and I'll send a followup patch.
-- PMM