aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.gitignore1
-rw-r--r--cmake/modules/FindASCIIDOC.cmake9
-rw-r--r--docbook/CMakeLists.txt63
-rw-r--r--docbook/GPL_appendix.asciidoc357
-rw-r--r--docbook/Makefile.am12
-rw-r--r--docbook/Makefile.common17
-rw-r--r--docbook/Makefile.nmake15
-rwxr-xr-xdocbook/check_git_version.sh3
-rw-r--r--docbook/developer-guide-docinfo.xml57
-rw-r--r--docbook/developer-guide.asciidoc52
-rw-r--r--docbook/developer-guide.xml159
-rw-r--r--docbook/ws.css2
-rw-r--r--docbook/wsdg_src/WSDG_meta_info.xml21
-rw-r--r--docbook/wsdg_src/WSDG_preface.asciidoc9
14 files changed, 542 insertions, 235 deletions
diff --git a/.gitignore b/.gitignore
index 1942e065d8..fde3bcd666 100644
--- a/.gitignore
+++ b/.gitignore
@@ -117,6 +117,7 @@ doxygen.cfg
help/faq.txt
pod2htm[di].tmp
wireshark.pod
+docbook/developer-guide.xml
docbook/ws?g_src/WS?G_*.dbk
docbook/*-guide-*.fo
docbook/*-guide-*.pdf
diff --git a/cmake/modules/FindASCIIDOC.cmake b/cmake/modules/FindASCIIDOC.cmake
index c3735e0ba5..221781e19f 100644
--- a/cmake/modules/FindASCIIDOC.cmake
+++ b/cmake/modules/FindASCIIDOC.cmake
@@ -38,7 +38,8 @@ MACRO( ASCIIDOC2HTML _output _asciidocsource _conffile )
COMMAND ${A2X_EXECUTABLE}
--format=xhtml
--destination-dir=${CMAKE_CURRENT_BINARY_DIR}
- # --conf-file=${_conffile}
+ --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
+ --fop
${A2X_HTML_OPTS}
${_asciidocsource}
# Replacing file with itself will fail
@@ -65,7 +66,8 @@ MACRO( ASCIIDOC2TXT _output _asciidocsource _conffile )
COMMAND ${A2X_EXECUTABLE}
--format=text
--destination-dir=${CMAKE_CURRENT_BINARY_DIR}
- # --conf-file=${_conffile}
+ --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
+ --fop
${A2X_TEXT_OPTS}
--xsltproc-opts '--stringparam generate.toc "article nop"'
${_asciidocsource}
@@ -91,7 +93,8 @@ MACRO( ASCIIDOC2PDF _output _asciidocsource _conffile _paper )
COMMAND ${A2X_EXECUTABLE}
--format=pdf
--destination-dir=${CMAKE_CURRENT_BINARY_DIR}
- # --conf-file=${_conffile}
+ --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
+ --fop
${A2X_HTML_OPTS}
--xsltproc-opts "--stringparam paper.type ${_paper} --nonet"
--xsl-file=custom_layer_pdf.xsl
diff --git a/docbook/CMakeLists.txt b/docbook/CMakeLists.txt
index 1431c00100..7e4d814ca7 100644
--- a/docbook/CMakeLists.txt
+++ b/docbook/CMakeLists.txt
@@ -182,22 +182,6 @@ set(WSUG_GRAPHICS
)
set(WSDG_FILES
- wsdg_generated_src/WSDG_chapter_build_intro.xml
- wsdg_generated_src/WSDG_chapter_capture.xml
- wsdg_generated_src/WSDG_chapter_dissection.xml
- wsdg_generated_src/WSDG_chapter_env_intro.xml
- wsdg_generated_src/WSDG_chapter_libraries.xml
- wsdg_generated_src/WSDG_chapter_quick_setup.xml
- wsdg_generated_src/WSDG_chapter_sources.xml
- wsdg_generated_src/WSDG_chapter_tools.xml
- wsdg_generated_src/WSDG_chapter_userinterface.xml
- wsdg_generated_src/WSDG_chapter_works.xml
- wsdg_src/WSDG_meta_info.xml
- wsdg_generated_src/WSDG_preface.xml
- ws.css
-)
-
-set(WSDG_ASCIIDOC_FILES
wsdg_src/WSDG_chapter_build_intro.asciidoc
wsdg_src/WSDG_chapter_capture.asciidoc
wsdg_src/WSDG_chapter_dissection.asciidoc
@@ -209,6 +193,7 @@ set(WSDG_ASCIIDOC_FILES
wsdg_src/WSDG_chapter_userinterface.asciidoc
wsdg_src/WSDG_chapter_works.asciidoc
wsdg_src/WSDG_preface.asciidoc
+ ws.css
)
set(WSDG_GRAPHICS
@@ -233,8 +218,37 @@ set(WSUG_SOURCE
${WSUG_GRAPHICS}
)
+MACRO( ASCIIDOC2DOCBOOK _asciidocsource _conffile )
+ GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
+ set( A2X_HTML_OPTS --stylesheet=ws.css )
+ set( _output_xml ${_source_base_name}.xml )
+ set( _output_dbk ${_source_base_name}.dbk )
+ ADD_CUSTOM_TARGET(${_output_xml}
+ # XXX - Output to a specific directory, e.g. wsdg_generated_src
+ WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+ COMMAND ${A2X_EXECUTABLE}
+ --verbose
+ --attribute=docinfo
+ --destination-dir=${CMAKE_CURRENT_BINARY_DIR}
+ --asciidoc-opts="--conf-file=${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}"
+ --no-xmllint
+ --format=docbook
+ --fop
+ ${A2X_HTML_OPTS}
+ ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
+ DEPENDS
+ ${CMAKE_CURRENT_SOURCE_DIR}/${_asciidocsource}
+ ${CMAKE_CURRENT_SOURCE_DIR}/${_conffile}
+ ${WSDG_GENERATED_FILES}
+ )
+ENDMACRO()
+
+ASCIIDOC2DOCBOOK( developer-guide.asciidoc asciidoc.conf )
+
SET( WSDG_GENERATED_FILES )
-# Convert an AsciiDoc document to a Docbook chapter
+# Convert an AsciiDoc document to a DocBook chapter
+# Used for chapter-by-chapter conversion from DocBook to AsciiDoc.
+# Can be removed after the User's Guide is converted.
# .asciidoc -> whole book (.dbk) -> chapter (.xml)
MACRO( ASCIIDOC2CHAPTER _asciidocsource _conffile )
GET_FILENAME_COMPONENT( _source_base_name ${_asciidocsource} NAME_WE )
@@ -268,14 +282,14 @@ MACRO( ASCIIDOC2CHAPTER _asciidocsource _conffile )
LIST( APPEND WSDG_GENERATED_FILES ${CMAKE_CURRENT_BINARY_DIR}/${_output_xml} )
ENDMACRO()
-FOREACH(ASCIIDOCFILE ${WSDG_ASCIIDOC_FILES})
- ASCIIDOC2CHAPTER(
- ${ASCIIDOCFILE}
- asciidoc.conf
- )
-ENDFOREACH()
+#FOREACH(ASCIIDOCFILE ${WSDG_ASCIIDOC_FILES})
+# ASCIIDOC2CHAPTER(
+# ${ASCIIDOCFILE}
+# asciidoc.conf
+# )
+#ENDFOREACH()
-ADD_CUSTOM_TARGET( wsdg_generated_src DEPENDS ${WSDG_GENERATED_FILES} )
+#ADD_CUSTOM_TARGET( wsdg_generated_src DEPENDS ${WSDG_GENERATED_FILES} )
# developer-guide.xml must be first in the list
set(WSDG_SOURCE
@@ -283,7 +297,6 @@ set(WSDG_SOURCE
git_version.xml
${WSDG_FILES}
${WSDG_GRAPHICS}
- wsdg_generated_src
)
set(WSLUA_MODULES
diff --git a/docbook/GPL_appendix.asciidoc b/docbook/GPL_appendix.asciidoc
new file mode 100644
index 0000000000..bbdddf1a6a
--- /dev/null
+++ b/docbook/GPL_appendix.asciidoc
@@ -0,0 +1,357 @@
+++++++++++++++++++++++++++++++++++++++
+<!-- Wireshark GPL Appendix -->
+++++++++++++++++++++++++++++++++++++++
+
+[[AppGPL]]
+=== This Document's License (GPL)
+
+As with the original license and documentation distributed
+with Wireshark, this document is covered by the GNU General Public
+License (GNU GPL).
+
+If you haven't read the GPL before, please do so. It
+explains all the things that you are allowed to do with this
+code and documentation.
+
+----
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ &lt;one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ &lt;signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
+---- \ No newline at end of file
diff --git a/docbook/Makefile.am b/docbook/Makefile.am
index 1ff11bde24..1ce6043d0b 100644
--- a/docbook/Makefile.am
+++ b/docbook/Makefile.am
@@ -55,7 +55,9 @@ else
@false
endif
-# Convert an AsciiDoc document to a Docbook chapter
+# Convert an AsciiDoc document to a DocBook chapter
+# Used for chapter-by-chapter conversion from DocBook to AsciiDoc.
+# Can be removed after the User's Guide is converted.
# .asciidoc -> whole book (.dbk) -> chapter (.xml)
.asciidoc.xml:
$(A2X) --verbose \
@@ -164,6 +166,14 @@ endif
wsdg: $(WSDG_TARGETS)
+developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES)
+ $(A2X) --verbose \
+ --attribute=docinfo \
+ --asciidoc-opts="--conf-file=asciidoc.conf" \
+ --no-xmllint \
+ --format=docbook \
+ $<
+
# validate the content
wsdg.validated: $(WSDG_SOURCE)
if HAVE_XMLLINT
diff --git a/docbook/Makefile.common b/docbook/Makefile.common
index 362ce2a73a..3ebd2fb8f8 100644
--- a/docbook/Makefile.common
+++ b/docbook/Makefile.common
@@ -169,22 +169,11 @@ WSDG_FILES = \
wsdg_src/WSDG_chapter_tools.asciidoc \
wsdg_src/WSDG_chapter_userinterface.asciidoc \
wsdg_src/WSDG_chapter_works.asciidoc \
- wsdg_src/WSDG_meta_info.xml \
wsdg_src/WSDG_preface.asciidoc \
ws.css
WSDG_GENERATED_SOURCE = \
- wsdg_src/WSDG_chapter_build_intro.xml \
- wsdg_src/WSDG_chapter_capture.xml \
- wsdg_src/WSDG_chapter_dissection.xml \
- wsdg_src/WSDG_chapter_env_intro.xml \
- wsdg_src/WSDG_chapter_libraries.xml \
- wsdg_src/WSDG_chapter_quick_setup.xml \
- wsdg_src/WSDG_chapter_sources.xml \
- wsdg_src/WSDG_chapter_tools.xml \
- wsdg_src/WSDG_chapter_userinterface.xml \
- wsdg_src/WSDG_chapter_works.xml \
- wsdg_src/WSDG_preface.xml
+ developer-guide.xml
WSDG_GRAPHICS = \
wsdg_graphics/ws-capture-sync.dia \
@@ -212,8 +201,7 @@ WSUG_SOURCE = \
# developer-guide.xml must be first in the list (to match $<)
WSDG_DIST = \
developer-guide.xml \
- git_version.xml \
- GPL_appendix.xml \
+ GPL_appendix.asciidoc \
custom_layer_pdf.xsl \
Makefile.common \
$(WSDG_FILES) \
@@ -234,7 +222,6 @@ CLEANFILES = \
*.pdf \
*.validated \
$(WSDG_GENERATED_SOURCE) \
- wsdg_src/*.dbk \
wsdg_chm \
wsdg_html.zip \
wsdg_html_chunked.zip \
diff --git a/docbook/Makefile.nmake b/docbook/Makefile.nmake
index aaf55a9aec..20879321c1 100644
--- a/docbook/Makefile.nmake
+++ b/docbook/Makefile.nmake
@@ -32,7 +32,9 @@ A2X_TEXT_OPTS=$(A2X_TEXT_OPTS) --lynx
.SUFFIXES: .fo .pdf
-# Convert an AsciiDoc document to a Docbook chapter
+# Convert an AsciiDoc document to a DocBook chapter
+# Used for chapter-by-chapter conversion from DocBook to AsciiDoc.
+# Can be removed after the User's Guide is converted.
# .asciidoc -> whole book (.dbk) -> chapter (.xml)
.asciidoc.xml:
$(SH) <<
@@ -158,6 +160,17 @@ wsluarm: make-wsluarm.pl $(WSLUA_MODULES)
wsdg_x: wsdg_html_chunked wsdg_html developer-guide-a4.pdf developer-guide-us.pdf developer-guide.chm
+developer-guide.xml: developer-guide.asciidoc $(WSDG_FILES)
+ $(SH) <<
+ PATH=/usr/bin
+ $(A2X) --verbose \
+ --attribute=docinfo \
+ --asciidoc-opts=\"--conf-file=asciidoc.conf\" \
+ --no-xmllint \
+ --format=docbook \
+ developer-guide.asciidoc
+<<
+
# validate the content
wsdg.validated: $(WSDG_SOURCE)
@ echo --- WSDG - VALIDATING XML ---
diff --git a/docbook/check_git_version.sh b/docbook/check_git_version.sh
index f7322559ca..5c5a51f245 100755
--- a/docbook/check_git_version.sh
+++ b/docbook/check_git_version.sh
@@ -23,8 +23,9 @@
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
+GIT_VERSION="unknown git version"
if [ -d ../.git ] ; then
- GIT_VERSION=`git describe --tags --dirty`
+ GIT_VERSION=`git describe --always --long`
fi
echo '<!ENTITY GitVersion "'${GIT_VERSION}'">' > git_version_tmp.xml
diff --git a/docbook/developer-guide-docinfo.xml b/docbook/developer-guide-docinfo.xml
new file mode 100644
index 0000000000..ff47fd679e
--- /dev/null
+++ b/docbook/developer-guide-docinfo.xml
@@ -0,0 +1,57 @@
+<!-- Document information for the Developer's Guide. -->
+
+<subtitle>For Wireshark 1.11</subtitle>
+
+ <!-- <title><inlinegraphic entityref="WiresharkLogo" valign="middle" format="PNG"/> &DocumentTitle;</title> -->
+
+ <!--
+ <authorgroup>
+ <author><firstname>&AuthorFirstName;</firstname><surname>&AuthorSurname;</surname>
+ <affiliation><orgname>&AuthorOrgName;</orgname></affiliation>
+ </author>
+ </authorgroup>
+ -->
+
+ <!--<edition>&DocumentEdition;</edition>
+ <pubdate>2008</pubdate>-->
+ <copyright><year>2004-2014</year>
+ <holder>Ulf Lamping</holder>
+ </copyright>
+
+<revhistory>
+
+<revision>
+ <revnumber>0.9</revnumber>
+ <date>9 Feb 2014</date>
+ <authorinitials>gcc</authorinitials>
+ <revremark>Converted from DocBook to AsciiDoc.</revremark>
+</revision>
+
+<revision>
+ <revnumber>0.5</revnumber>
+ <date>21 Jan 2007</date>
+ <authorinitials>ul</authorinitials>
+ <revremark>Major redesign.</revremark>
+</revision>
+
+<revision>
+ <revnumber>0.1</revnumber>
+ <date>17 Aug 2004</date>
+ <authorinitials>ul</authorinitials>
+ <revremark>Initial version.</revremark>
+</revision>
+
+</revhistory>
+
+<legalnotice>
+ <simpara>
+ Permission is granted to copy, distribute
+ and/or modify this document under the terms of the GNU General Public
+ License, Version 2 or any later version published by the Free Software
+ Foundation.
+ </simpara>
+ <simpara>
+ All logos and trademarks in this document are property of their
+ respective owners.
+ </simpara>
+</legalnotice>
diff --git a/docbook/developer-guide.asciidoc b/docbook/developer-guide.asciidoc
new file mode 100644
index 0000000000..835a2b5759
--- /dev/null
+++ b/docbook/developer-guide.asciidoc
@@ -0,0 +1,52 @@
+= Wireshark Developer's Guide =
+Ulf Lamping <ulf.lamping[AT]web.de>
+//v1.0, February 2014: Finished conversion from DocBook to AsciiDoc
+:doctype: book
+
+[[Preface]]
+["preface",id="Preface"]
+= Preface
+
+include::wsdg_src/WSDG_preface.asciidoc[]
+
+[[PartEnvironment]]
+= Wireshark Build Environment
+[partintro]
+.Wireshark Build Environment
+--
+The first part describes how to set up the tools, libraries and source needed to
+generate Wireshark and how to do some typical development tasks.
+--
+
+include::wsdg_src/WSDG_chapter_env_intro.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_quick_setup.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_sources.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_tools.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_libraries.asciidoc[]
+
+[[PartDevelopment]]
+= Wireshark Development
+[partintro]
+.Wireshark Development
+--
+The second part describes how the Wireshark sources are structured and how to
+change the sources such as adding a new dissector.
+--
+
+include::wsdg_src/WSDG_chapter_works.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_build_intro.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_capture.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_dissection.asciidoc[]
+
+include::wsdg_src/WSDG_chapter_userinterface.asciidoc[]
+
+include::GPL_appendix.asciidoc[]
diff --git a/docbook/developer-guide.xml b/docbook/developer-guide.xml
deleted file mode 100644
index b1c6f9480b..0000000000
--- a/docbook/developer-guide.xml
+++ /dev/null
@@ -1,159 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-
-<!-- $Id$ -->
-
-<!--
-BIOGRAPHICAL SECTION
--Use this section to encode all biographical information
--->
-
-<!-- Authors Names -->
- <!ENTITY AuthorFullName "Ulf Lamping">
- <!ENTITY AuthorFirstName "Ulf">
- <!ENTITY AuthorOtherName "">
- <!ENTITY AuthorSurname "Lamping">
- <!ENTITY AuthorEmail "ulf.lamping[AT]web.de">
-
-<!--Authors Affiliation -->
- <!ENTITY AuthorShortAffiliation "">
- <!ENTITY AuthorJobTitle "">
- <!ENTITY AuthorOrgName "">
- <!ENTITY AuthorOrgDiv "">
-
-<!--
-DOCUMENT SECTION
--Use this section to encode all document information
--->
-
- <!ENTITY DocumentTitle "<application>Wireshark</application> Developer's Guide">
- <!ENTITY DocumentSubTitle "&GitVersion; for Wireshark &WiresharkCurrentVersion;">
- <!ENTITY DocumentTitleAbbreviation "WSDG">
-
- <!ENTITY DocumentCopyrightHolder "Ulf Lamping">
- <!ENTITY DocumentCopyrightYear "2004-2013">
-
- <!ENTITY DocumentEdition "Draft">
- <!ENTITY DocumentVersion "Draft 0.0.3">
- <!ENTITY DocumentPubDate "2008">
- <!ENTITY % GitVersionFile SYSTEM "git_version.xml">
- %GitVersionFile;
-
-<!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute
- and/or modify this document under the terms of the GNU General Public
- License, Version 2 or any later version published by the Free Software
- Foundation.
- </para>
- <para>All logos and trademarks in this document are property of their
- respective owner.</para>">
-
-<!--
-Wireshark Info
--->
- <!ENTITY WiresharkCurrentVersion "1.11">
- <!ENTITY WiresharkWebSite "http://www.wireshark.org">
- <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
- <!ENTITY WiresharkAuthorsPage "&WiresharkRepositorySite;/wireshark/trunk/AUTHORS">
- <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html">
- <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
- <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs/">
- <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/">
- <!ENTITY WiresharkWikiSite "http://wiki.wireshark.org">
- <!ENTITY WiresharkBugsSite "https://bugs.wireshark.org">
- <!ENTITY WiresharkRepositorySite "http://anonsvn.wireshark.org">
- <!ENTITY WiresharkListsPage "&WiresharkWebSite;/lists/">
- <!ENTITY WiresharkQASite "http://ask.wireshark.org">
-
-<!--
-Gnu info
--->
- <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
-
-<!--
-FILE SECTION
--Use this section to specify the files that make up the book. Use FPI (public identifiers)
--->
-
-<!-- These refer to graphics files and figures contained in the document -->
-
- <!ENTITY WiresharkLogo SYSTEM "./wsdg_graphics/ws-logo.png" NDATA PNG>
- <!ENTITY WiresharkFunctionBlocks SYSTEM "./wsdg_graphics/ws-function-blocks.png" NDATA PNG>
-
-<!-- These are the actual files that make up the document -->
-
- <!ENTITY BookMetaInformation SYSTEM "wsdg_src/WSDG_meta_info.xml">
- <!ENTITY Preface SYSTEM "wsdg_src/WSDG_preface.xml">
- <!ENTITY EnvIntroduction SYSTEM "wsdg_src/WSDG_chapter_env_intro.xml">
- <!ENTITY QuickSetup SYSTEM "wsdg_src/WSDG_chapter_quick_setup.xml">
- <!ENTITY Tools SYSTEM "wsdg_src/WSDG_chapter_tools.xml">
- <!ENTITY Libraries SYSTEM "wsdg_src/WSDG_chapter_libraries.xml">
- <!ENTITY Sources SYSTEM "wsdg_src/WSDG_chapter_sources.xml">
-
- <!ENTITY BuildIntroduction SYSTEM "wsdg_src/WSDG_chapter_build_intro.xml">
- <!ENTITY HowWiresharkWorks SYSTEM "wsdg_src/WSDG_chapter_works.xml">
- <!ENTITY Capture SYSTEM "wsdg_src/WSDG_chapter_capture.xml">
- <!ENTITY Dissection SYSTEM "wsdg_src/WSDG_chapter_dissection.xml">
- <!ENTITY UserInterface SYSTEM "wsdg_src/WSDG_chapter_userinterface.xml">
-
- <!ENTITY AppGPL SYSTEM "GPL_appendix.xml">
-
-]>
-
-<book>
-<title>&DocumentTitle;</title>
-<subtitle>&DocumentSubTitle;</subtitle>
-&BookMetaInformation;
-&Preface;
-<part id="PartEnvironment" label="I">
-<title>Wireshark Build Environment</title>
-<partintro>
-<para>
-Part I. Wireshark Build Environment
-</para>
-<para>
-The first part describes how to set up the tools, libraries and
-source needed to generate Wireshark, and how to do some typical development
-tasks.
-</para>
-<para>
-Part II. Wireshark Development
-</para>
-<para>
-The second part describes how the Wireshark sources are structured and how
-to change the sources (e.g. adding a new dissector).
-</para>
-</partintro>
-&EnvIntroduction;
-&QuickSetup;
-&Sources;
-&Tools;
-&Libraries;
-</part>
-<part id="PartDevelopment" label="II">
-<title>Wireshark Development (incomplete)</title>
-<partintro>
-<para>
-Part I. Wireshark Build Environment
-</para>
-<para>
-The first part describes how to set up the tools, libraries and source needed
-to generate Wireshark, and how to do some typical development tasks.
-</para>
-<para>
-<command>Part II. Wireshark Development</command>
-</para>
-<para>
-<command>The second part describes how the Wireshark sources are structured and how
-to change the sources (e.g. adding a new dissector).</command>
-</para>
-</partintro>
-&HowWiresharkWorks;
-&BuildIntroduction;
-&Capture;
-&Dissection;
-&UserInterface;
-</part>
-
-&AppGPL;
-</book>
diff --git a/docbook/ws.css b/docbook/ws.css
index 6c4389231b..16cf9e3651 100644
--- a/docbook/ws.css
+++ b/docbook/ws.css
@@ -104,7 +104,7 @@ body h1, body h2, body h3, body h4, body h5, body h6 {
body pre {
margin: 0.5em 10% 0.5em 1em;
- line-height: 1.0;
+ line-height: 1.4;
color: 333;
}
diff --git a/docbook/wsdg_src/WSDG_meta_info.xml b/docbook/wsdg_src/WSDG_meta_info.xml
deleted file mode 100644
index 007aa5b79b..0000000000
--- a/docbook/wsdg_src/WSDG_meta_info.xml
+++ /dev/null
@@ -1,21 +0,0 @@
-<!-- $Id$ -->
-
-<bookinfo>
- <title><inlinegraphic entityref="WiresharkLogo" valign="middle" format="PNG"/> &DocumentTitle;</title>
- <subtitle>&DocumentSubTitle;</subtitle>
- <authorgroup>
- <author><firstname>&AuthorFirstName;</firstname><surname>&AuthorSurname;</surname>
- <affiliation><orgname>&AuthorOrgName;</orgname></affiliation>
- </author>
- </authorgroup>
- <!--<edition>&DocumentEdition;</edition>
- <pubdate>&DocumentPubDate;</pubdate>-->
- <copyright><year>&DocumentCopyrightYear;</year>
- <holder>&DocumentCopyrightHolder;</holder>
- </copyright>
-
-<legalnotice>
- &DocumentLegalNotice;
-</legalnotice>
-
-</bookinfo>
diff --git a/docbook/wsdg_src/WSDG_preface.asciidoc b/docbook/wsdg_src/WSDG_preface.asciidoc
index 1fdc7b8a66..8309352f6e 100644
--- a/docbook/wsdg_src/WSDG_preface.asciidoc
+++ b/docbook/wsdg_src/WSDG_preface.asciidoc
@@ -1,13 +1,6 @@
-
-
++++++++++++++++++++++++++++++++++++++
-<!-- $Id$ -->
+<!-- WSDG Preface -->
++++++++++++++++++++++++++++++++++++++
-
-[[Preface]]
-
-[preface]
-== Preface
[[PreForeword]]
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-01 18:33:50 +0000