| Age | Commit message (Collapse) | Author | Files | Lines |
|---|
|
Move the top-level user-guide.adoc and developer-guide.adoc to their
respective source directores. This is in preparation for a future
toolchain revamp.
Move the wsug_graphics directory to wsug_src/images and wsdg_graphics
directory to wsdg_src/images. Copy common_graphics/* to the each images
directory and remove common_graphics. We only have five admonition
graphics; duplicating them lets us remove some build config overhead.
Rename wsluarm.adoc to wsdg_src/wsdg_lua_support.adoc.
Remove a dummy file.
Tested visually and by enabling `--failure-level=WARN`.
|
|
Rename the various "WSUG_" and "WSDG_" files to wsug_ and wsdg_
respectively. Remove the "chapter" and "app" parts from the filenames as
well.
|
|
Use the variables WIRESHARK_QT{5,6}_PREFIX_PATH.
This allows having Qt5 and Qt6 paths configured isimultaneously and switch easily between them.
Use list(APPEND) to avoid clobbering other CMAKE_PREFIX_PATH paths.
Follow-up to b33210750c1fc38fe4ee827443e2c8a3aeaafc88.
|
|
|
|
Change our legacy block anchors to section IDs as described at
https://docs.asciidoctor.org/asciidoc/latest/sections/custom-ids/
|
|
|
|
If only someone could create a proper cover page
|
|
|
|
Remove nested example tags from the dissection chapter, including and
unbalanced one. Mark our source blocks with [source,c].
Enable syntax highlighting in the Developer's and User's guides. This
isn't supported in the DocBook backend (which we use to generate the
HTML guides), but it is in the PDF backend.
Add a comment about failing on warnings when we generate our guides.
Change-Id: Ieee29fe75364ca23769aa997f90126e31b72cc8b
Reviewed-on: https://code.wireshark.org/review/36767
Petri-Dish: Guy Harris <gharris@sonic.net>
Tested-by: Petri Dish Buildbot
Reviewed-by: Guy Harris <gharris@sonic.net>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
|
|
Asn2wrs generates quite a bit of our dissector code, so convert some of
our asn2wrs wiki pages to a WSDG chapter. Conversion was done using the
script below and editing as needed.
----
OUT_ADOC="docbook/wsdg_src/WSDG_chapter_asn2wrs.adoc"
cp /dev/null "$OUT_ADOC"
PAGES="
Asn2wrs
Asn2wrs_Handmassaging_the_ASN_file
ASN1_sample
Asn2wrsAuxiliary
#.END
#.EXPORTS
#.FN_BODY
#.INCLUDE
#.MODULE_IMPORT
#.NO_EMIT
#.PDU
#.PDU_NEW
#.REGISTER
#.REGISTER_NEW
#.USER_DEFINED
"
for PAGE in $PAGES ; do
PAGE=${PAGE/\#/%23}
curl "https://wiki.wireshark.org/$PAGE" \
| xmllint --html --format --xpath '//div[@id="content"]' - \
| pandoc -f html -t asciidoctor \
| sed -e 's/\[\#[^ ][^ ]* .anchor\]##*//g' -e 's/\[content\]//g' \
| cat -s \
>> "$OUT_ADOC"
done
----
Change-Id: Ibc02b7b463dfc37abf5c2fd0a4e66f6161d290f6
Reviewed-on: https://code.wireshark.org/review/36707
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
|
|
As noted in "AsciiDoc Recommended Practices" at
https://asciidoctor.org/docs/asciidoc-recommended-practices/, the
AsciiDoc/Asciidoctor community seems to have settled on ".adoc" as a
file extension and that's the one preferred by the Asciidoctor project.
Update our filenames to match.
Change-Id: I2d352623d42d65d950b64310c3655b0fd177ee8c
Reviewed-on: https://code.wireshark.org/review/32037
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot
Reviewed-by: Anders Broman <a.broman58@gmail.com>
|
