Minor doc cleanups.
Here's a grab bag of trivial cleanup to the documentation. This change: - Cleans up some comments in the asciidoctor macros which are no longer accurate (and do not appear in the build products anyway). - Fixes a missing space in the text "Wireshark Q&A" in the release notes. - Allows the "docbook" backend to produce hyperlinks too... That seems to be necessary if we want to start using our custom link macros in WSDG, which seems like a reasonable thing to do. And fixes up a wrong variable name in the handling of the case where we are not able to produce a hyperlink.
This commit is contained in:
parent
9b3afa0278
commit
4c513fb4ab
|
@ -3,7 +3,8 @@ require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
|
||||||
|
|
||||||
include ::Asciidoctor
|
include ::Asciidoctor
|
||||||
|
|
||||||
# An inline macro that generates links to related man pages.
|
# An inline macro that generates a link to a CVE Record identified by its CVE
|
||||||
|
# Number.
|
||||||
#
|
#
|
||||||
# Usage
|
# Usage
|
||||||
#
|
#
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# SPDX-License-Identifier: MIT
|
# SPDX-License-Identifier: MIT
|
||||||
module WsUtils
|
module WsUtils
|
||||||
def create_doc_links(parent, target, text)
|
def create_doc_links(parent, target, text)
|
||||||
if parent.document.basebackend? 'html'
|
if (parent.document.basebackend? 'docbook') || (parent.document.basebackend? 'html')
|
||||||
parent.document.register :links, target
|
parent.document.register :links, target
|
||||||
create_anchor(parent, text, type: :link, target: target).render.to_s
|
create_anchor(parent, text, type: :link, target: target).render.to_s
|
||||||
elsif parent.document.backend == 'manpage'
|
elsif parent.document.backend == 'manpage'
|
||||||
"\\fB#{text}"
|
"\\fB#{text}"
|
||||||
else
|
else
|
||||||
bugtext
|
text
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
@ -3,7 +3,7 @@ require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
|
||||||
|
|
||||||
include ::Asciidoctor
|
include ::Asciidoctor
|
||||||
|
|
||||||
# An inline macro that generates links to related man pages.
|
# An inline macro that generates a link to a Wireshark bug report.
|
||||||
#
|
#
|
||||||
# Usage
|
# Usage
|
||||||
#
|
#
|
||||||
|
|
|
@ -3,7 +3,7 @@ require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
|
||||||
|
|
||||||
include ::Asciidoctor
|
include ::Asciidoctor
|
||||||
|
|
||||||
# An inline macro that generates links to related man pages.
|
# An inline macro that generates a link to a Wireshark Security Advisory.
|
||||||
#
|
#
|
||||||
# Usage
|
# Usage
|
||||||
#
|
#
|
||||||
|
|
|
@ -115,7 +115,7 @@ The User’s Guide, manual pages and various other documentation can be found at
|
||||||
https://www.wireshark.org/docs/
|
https://www.wireshark.org/docs/
|
||||||
|
|
||||||
Community support is available on
|
Community support is available on
|
||||||
https://ask.wireshark.org/[Wireshark’sQ&A site]
|
https://ask.wireshark.org/[Wireshark’s Q&A site]
|
||||||
and on the wireshark-users mailing list.
|
and on the wireshark-users mailing list.
|
||||||
Subscription information and archives for all of Wireshark’s mailing lists can be found on
|
Subscription information and archives for all of Wireshark’s mailing lists can be found on
|
||||||
https://www.wireshark.org/lists/[the web site].
|
https://www.wireshark.org/lists/[the web site].
|
||||||
|
|
Loading…
Reference in New Issue