aboutsummaryrefslogtreecommitdiffstats
path: root/docbook
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2021-06-22 10:33:51 -0700
committerGerald Combs <gerald@wireshark.org>2021-06-22 10:47:17 -0700
commit853c438b8ee6fbf51c9073dc16aba7a265f301c7 (patch)
tree076e4e73343447b3e45e7ac12fd47e51da152640 /docbook
parent16f5269d545f2756955c2c885225f91b0bc3ed10 (diff)
WSUG: Add a note about installing a JRE.
Note that Chocolatey doesn't support altnerative package dependencies, and that you have to install a JRE separately when installing AscidoctorJ as a result.
Diffstat (limited to 'docbook')
-rw-r--r--docbook/wsdg_src/WSDG_chapter_quick_setup.adoc16
1 files changed, 9 insertions, 7 deletions
diff --git a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
index 468c463985..f3f7ec33db 100644
--- a/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
+++ b/docbook/wsdg_src/WSDG_chapter_quick_setup.adoc
@@ -121,7 +121,7 @@ You can then run make or Ninja to build Wireshark.
To build the Wireshark User's Guide and the Wireshark Developer's Guide
build the `all_guides` target, e.g. `make all_guides` or `ninja
all_guides`. Detailed information to build these guides can be found in
-the file _docbook\README.adoc_ in the Wireshark sources.
+the file _docbook\README.adoc_ in the Wireshark sources.
==== Optional: Create an installable or source code package
@@ -345,14 +345,16 @@ Chocolatey ensures cmake.exe is on your path.
==== Install Asciidoctor, Xsltproc, And DocBook
-https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby
-script or via a Java wrapper (AsciidoctorJ). It is used in conjunction
-with Xsltproc and DocBook to generate the documentation you're reading
-and the User’s Guide.
+https://asciidoctor.org/[Asciidoctor] can be run directly as a Ruby script or via a Java wrapper (AsciidoctorJ).
+It is used in conjunction with Xsltproc and DocBook to generate the documentation you're reading and the User’s Guide.
-The easiest way to install them on Windows is via Chocolatey:
+You can install AsciidoctorJ, Xsltproc, and DocBook using Chocolatey.
+AsciidoctorJ requires a Java runtime and there are https://en.wikipedia.org/wiki/List_of_Java_virtual_machines[many to choose from].
+Chocolatey doesn't support alternative package dependencies at the present time, including dependencies on Java.
+As a result, installing the asciidoctorj package won't automatically install a Java runtime -- you must install one separately.
----
+PS$> choco install -y <your favorite Java runtime>
PS$> choco install -y asciidoctorj xsltproc docbook-bundle
----
@@ -570,7 +572,7 @@ on using the <<ChToolsDebugger, Debugger Tools>>.
==== Optional: Create User’s and Developer’s Guide
To build the Wireshark User's Guide and the Wireshark Developer's Guide
-build the `all_guides` target, e.g. `msbuild all_guides.vcxproj`.
+build the `all_guides` target, e.g. `msbuild all_guides.vcxproj`.
Detailed information to build these guides can be found in the file
_docbook\README.adoc_ in the Wireshark sources.