diff options
| author | Gerald Combs <gerald@wireshark.org> | 2019-02-11 14:24:18 -0800 |
|---|---|---|
| committer | Gerald Combs <gerald@wireshark.org> | 2019-02-14 23:11:15 +0000 |
| commit | 23c9a1e036445c17ec4bbc5d0fcbea4f588253c1 (patch) | |
| tree | 37fa8cffa8ae7a2fd2cf42e3a1d85749ec3a40f3 /packaging/nsis/wireshark.nsi | |
| parent | ef0ef16c30a8a217645e06df47eb4e5718dabb0b (diff) | |
Convert the FAQ to Asciidoctor and remove old help files.
Convert our self-generating FAQ to Asciidoctor via the following steps:
- `help/faq.py > /tmp/faq.html`.
- `pandoc -t asciidoc -o docbook/faq.adoc /tmp/faq.html`.
- Manually clean up the markup using a text editor.
Question and answer content was left intact. Removing or updating
obsolete content will have to be done in a separate change.
The Asciidoctor project uses the .adoc extension, so start using it here
as well.
The contents of the "help" directory appear to have been used for
offline support in help_url.c, but that functionality was removed in
2008 in 242e3b78bc. Its content is covered in the User's Guide and man
pages so remove it.
Change-Id: I9060eefe97cfc137f8b414077c30f814379b576a
Reviewed-on: https://code.wireshark.org/review/32014
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Diffstat (limited to 'packaging/nsis/wireshark.nsi')
| -rw-r--r-- | packaging/nsis/wireshark.nsi | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/packaging/nsis/wireshark.nsi b/packaging/nsis/wireshark.nsi index 6cf9654dff..06625648af 100644 --- a/packaging/nsis/wireshark.nsi +++ b/packaging/nsis/wireshark.nsi @@ -1159,11 +1159,12 @@ SectionEnd SectionGroupEnd ; "Tools" -!ifdef USER_GUIDE_DIR -Section "User's Guide" SecUsersGuide +!ifdef DOCBOOK_DIR +Section "Documentation" SecDocumentation ;------------------------------------------- SetOutPath $INSTDIR -File "${USER_GUIDE_DIR}\user-guide.chm" +File "${DOCBOOK_DIR}\user-guide.chm" +File "${DOCBOOK_DIR}\faq.html" SectionEnd !endif @@ -1215,8 +1216,8 @@ SectionEnd !insertmacro MUI_DESCRIPTION_TEXT ${SecRandpkt} "Random packet generator." !insertmacro MUI_DESCRIPTION_TEXT ${SecMMDBResolve} "MaxMind Database resolution tool" -!ifdef USER_GUIDE_DIR - !insertmacro MUI_DESCRIPTION_TEXT ${SecUsersGuide} "Install an offline copy of the User's Guide." +!ifdef DOCBOOK_DIR + !insertmacro MUI_DESCRIPTION_TEXT ${SecDocumentation} "Install an offline copy of the User's Guide and FAQ." !endif !insertmacro MUI_FUNCTION_DESCRIPTION_END |