aboutsummaryrefslogtreecommitdiffstats
path: root/docbook/CMakeLists.txt
AgeCommit message (Collapse)AuthorFilesLines
2016-02-26cmake: fix parallel docbook buildPeter Wu1-2/+2
Let targets depend on the generate_developer-guide.xml target instead of the developer-guide.xml output file. Change-Id: I66106ad69c9baedbd58a008b4dbbbf93b787c2c2 Reviewed-on: https://code.wireshark.org/review/14156 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2016-01-10Update the packet list documentation.Gerald Combs1-0/+9
Update images and describe related packets and the intelligent scrollbar. Suggest a way to make it easier to get a screenshot of related packets. Change-Id: I5bf27b0c53fb62f3e567765400141a374a465e4e Reviewed-on: https://code.wireshark.org/review/13159 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-11-21cmake: do not remove ws.css; ignore auto-generated filesPeter Wu1-7/+11
Do not remove "ws.css" when doing a build in the source tree. Ignore files that were automatically generated with cmake and the Ninja generator (cmake -GNinja). Change-Id: I24cae27eb8ae9664e3354ba646fd5503649349b1 Reviewed-on: https://code.wireshark.org/review/12007 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Peter Wu <peter@lekensteyn.nl>
2015-08-08Generate DocBook conditionally.Gerald Combs1-18/+24
Add back a check when generating DocBook. Change-Id: I00679853d537f543db6f37a60ae4c46b3cce76e6 Reviewed-on: https://code.wireshark.org/review/9935 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-08CMake: Try to fix generated docbook dependencies.Gerald Combs1-94/+127
Add custom {developer,user}_guide_docbook targets for docbook output. Make sure the HTML, PDF, and CHM outputs depend on their associated docbook target and not on the output .xml file. This keeps us from running a2x instances in parallel. Change-Id: I73b0db50ae92f62eb08ae284d498cdf2d697ac00 Reviewed-on: https://code.wireshark.org/review/9920 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07Add a missing dependency.Gerald Combs1-0/+2
Change-Id: I2c9814419882f9bee30e70697d6f284393f275a9 Reviewed-on: https://code.wireshark.org/review/9919 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-07Rework CMake dependendencies in the docbook directory.Gerald Combs1-52/+67
Create dependencies explicitly using add_dependencies. Otherwise MSBuild only builds one output per run. Change-Id: If42605d7e7df499cf4d4b70336d97ac6d37e8ba6 Reviewed-on: https://code.wireshark.org/review/9918 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-07-12Lua: split up wslua files into class-based filesHadriel Kaplan1-0/+14
The size of some of the wslua source files has grown large, and it's hard to quickly find things. So split them up based on class name, as much as seems reasonable. Also have the make-wsluarm.pl Perl script handle this. Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213 Reviewed-on: https://code.wireshark.org/review/9579 Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
2015-04-28Fix Windows asciidoc buildGraham Bloice1-3/+3
Replace some unixisms with CMake equivalents Change-Id: I8dc125e830cdf7c31b13539c0a86df736097afef Reviewed-on: https://code.wireshark.org/review/8208 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org> Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2015-04-17Retire git_version.xml.Gerald Combs1-11/+0
Remove check_git_version.sh and its associated targets. We haven't used git_version.xml since the AsciiDoc conversion. Change-Id: I480f0094c4355d71201f2dd285198581bbbfc415 Reviewed-on: https://code.wireshark.org/review/8104 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-02-07WSUG: Update the Packet Colorization section.Gerald Combs1-1/+0
Change-Id: I0f880293bd185e202d230f0db1a6bc4cbe6cfbfb Reviewed-on: https://code.wireshark.org/review/7011 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-14CMake: Look for FOP and HHC only when needed.Gerald Combs1-2/+3
FOP is only required for generating PDF output and HHC is only needed for CHM output. Don't look for them unconditionally. Change-Id: I7bec7d061c9e9e8b99431cab873e8c719469552c Reviewed-on: https://code.wireshark.org/review/6539 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-11Update CMake "Project names" and FoldersGraham Bloice1-0/+4
This gives a more structured layout in Visual Studio Change-Id: I0da87a3e5ec759c69aeee031366cf287485cdac2 Reviewed-on: https://code.wireshark.org/review/6485 Reviewed-by: Graham Bloice <graham.bloice@trihedral.com> Tested-by: Graham Bloice <graham.bloice@trihedral.com>
2015-01-09CMake: Migrate to hhc.cmake.Gerald Combs1-9/+12
Remove FindHHC.cmake in favor of CMake's FindHTMLHelp. Remove the hhc.cmd wrapper. Change-Id: I548e58d2264c74596e9067d5053b056c35089b3c Reviewed-on: https://code.wireshark.org/review/6449 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-08CMake: Enable DocBook on Windows.Gerald Combs1-52/+50
Add a wrapper script and CMake macros which lets us run Cygwin's a2x from Windows. Add *another* wrapper script that ignores the return value of hhc.exe. Move the ASCIIDOC2DOCBOOK macro to FindASCIIDOC.cmake. Add FindHHC.cmake. Add hints to FindFOP.cmake. Use unique file names in the HTML Help chain in an attempt to avoid a race condition. To do: - Fix curly quote in HHC title. Change-Id: I9b154b7fbd02703656e2ab380199ec0a6db4e36d Reviewed-on: https://code.wireshark.org/review/6379 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-12-11CMake: Make it easier to generate the release notes & NEWS.Gerald Combs1-36/+58
Add convenience targets for generating the release notes and the NEWS file. Make sure we don't run multiple instances of a2x + AsciiDoc at the same time. Add the docbook directory to the build by default unless we're running Windows. Explain why we don't yet build docs on Windows. Make each docbook makefile target optional. Split the ENABLE_GUIDES option into ENABLE_HTML_GUIDES and ENABLE_PDF_GUIDES. Add a default "all_guides" target if either is on. Remove the Debian patch that hacked around the PDF requirement. Copy ws.css to the docbook build directory. Don't build PDF release notes. I'm not sure we ever used them and I don't want to install Java and FOP just to make a release. Change-Id: Ia2f710000c17f9e0b4b514fd373d9a5902889553 Reviewed-on: https://code.wireshark.org/review/5712 Petri-Dish: Gerald Combs <gerald@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-10Finish converting the User's Guide to AsciiDoc.Gerald Combs1-85/+2
As with the Developer's Guide, add user-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in user-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Remove the various makefile targets for converting AsciiDoc files to DocBook chapters. Remove GPL_appendix.xml. We use the AsciiDoc version. Change-Id: I543fa2a92f2c735c5f00c97ec65cff2187e09e3a Reviewed-on: https://code.wireshark.org/review/5216 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09WSUG: Convert ``Command Line Tools'' to AsciiDoc.Gerald Combs1-1/+2
Move the idl2wrs section to the Developer's Guide. Leave most of the other content intact for now. Change-Id: I98c6eeab62af5cc55e3ce23ab1107df02b1a22cf Reviewed-on: https://code.wireshark.org/review/5214 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09WSUG: Convert ``Troubleshooting'' to AsciiDoc.Gerald Combs1-1/+2
The chapter is disabled so its final output hasn't been checked. Leave most of the content intact for now. Change-Id: I2147ee2863e7ededadf892794a836b4dc8055649 Reviewed-on: https://code.wireshark.org/review/5211 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09WSUG: Convert ``Protocols'', ``Messages'', and ``How Wireshark Works''Gerald Combs1-3/+6
to AsciiDoc. ``How Wireshark Works'' is disabled, so its final output hasn't been checked. Leave most of the content intact for now. Change-Id: Ia78951faa3ffd9c6d2e23067dbfb954ab4042f60 Reviewed-on: https://code.wireshark.org/review/5210 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09WSUG: Convert ``Files'' to AsciiDoc.Gerald Combs1-2/+3
Leave most of the content intact for now. Change-Id: I78f47b8310cb41ac5a07d352e56ec907b36665f8 Reviewed-on: https://code.wireshark.org/review/5209 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-09Convert the Lua reference to AsciiDoc.Gerald Combs1-2/+3
Move it to the Developer's Guide while we're here. Nudge the markup in epan/wslua where needed. Note that we should probably convert it to AsciiDoc (if we're going to keep it in the DG) or Doxygen. Change-Id: Ie175111043f98b7a37eeeb8d185a833d8e866f8b Reviewed-on: https://code.wireshark.org/review/5203 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-11-02WSUG: Convert ``Customizing'' to AsciiDoc.Gerald Combs1-1/+2
Leave most of the content intact for now. Change-Id: Id00d942f87e0a25e27333ac56eb9b99311694a13 Reviewed-on: https://code.wireshark.org/review/5063 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01WSUG: Convert ``Telephony'' to AsciiDoc.Gerald Combs1-1/+2
Leave most of the content intact for now. Change-Id: I21aad681194d1bb1841e29f4ac41be4677fcb909 Reviewed-on: https://code.wireshark.org/review/3939 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01WSUG: Convert ``Advanced Topics'' to AsciiDoc.Gerald Combs1-1/+2
Leave most of the content intact for now. Change-Id: Ie91fda8a3fe6ea2eb4c47acf7c41d7e6979235b0 Reviewed-on: https://code.wireshark.org/review/3938 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01WSUG: Convert ``Working with captured packets'' to AsciiDoc.Gerald Combs1-1/+2
Leave most of the content intact for now. Change-Id: Ic264814aa8e442df100ae8533098843ef6a2e6c9 Reviewed-on: https://code.wireshark.org/review/3937 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-09-01WSUG: Convert the ``File I/O'' chapter to AsciiDoc.Gerald Combs1-4/+2
Leave most of the content intact for now. Remove images for no-longer-supported versions of GTK+. Add an example for building the Guides to README.cmake. Change-Id: Id9e6a308c91b594d1fb7f107d7b9b28074a92a8b Reviewed-on: https://code.wireshark.org/review/3931 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-25WSUG_chapter_capture is now an asciidoc file that gets convertedJoerg Mayer1-1/+2
into an xml file. Change-Id: I43ae59d14cbdcf460250cf62005aea4a2772d11f Reviewed-on: https://code.wireshark.org/review/3846 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-08-24Convert admon graphics to SVG.Gerald Combs1-6/+8
Use a common set of SVG files for AsciiDoc / DocBook admonition graphics. Put them in a common directory. According to http://caniuse.com/svg all common browsers have had SVG support for a while now. The graphics themselves were created with Inkscape. If you would like to refine them further you are more than welcome. Use variables to assemble xsltproc commands in Autotools and Nmake while we're here. Try to update Debian rules to reflect ga92c3fb. Change-Id: If82647af27a60117c517125dff0aca81c033be72 Reviewed-on: https://code.wireshark.org/review/3206 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-24CMake: More a2x / asciidoc fixes.Gerald Combs1-12/+10
Create graphics directories and copy files into them similar to Autotools and Nmake. Adjust some xsltproc arguments. Fix the --asciidoc-opts flag. Note: Admon graphics are broken pending change 3206. Change-Id: I94d498de36150a7cb4ffd080581523300b222bd4 Reviewed-on: https://code.wireshark.org/review/3805 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-23WSUG: Convert the "User Interface" chapter to AsciiDoc.Gerald Combs1-15/+37
Add the "asciidoc.conf" compatibility configuration file from Asciidoctor. Although we don't use Asciidoctor it gives us macros that keep us from losing some useful DocBook elements. Update various CMake files to support multiple AsciiDoc configuration files. Leave most of the content intact for now. Hopefully the other chapters aren't as laden with markup. Change-Id: Id69757342b86abb2b3130cb61e90f5695a26ea8a Reviewed-on: https://code.wireshark.org/review/3680 Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-02Convert the Statistics chapter to AsciiDoc.Gerald Combs1-1/+2
Don't update any content for now. Change-Id: Ib4f6402d9b23bd1ad57a57831b63c63a150391aa Reviewed-on: https://code.wireshark.org/review/3372 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-08-02Convert the build and install chapter to AsciiDoc.Gerald Combs1-1/+2
Add OS X content. Remove GTK+ content. Update the names in the NSIS package to match the documentation (untested). Change-Id: Id8fd08982bc26871bb8a319b0319808bcdba878c Reviewed-on: https://code.wireshark.org/review/3366 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-07-21Start converting the User's Guide to AsciiDoc.Gerald Combs1-9/+14
Convert the preface and introduction. Update various makefiles. Change-Id: Id998cabadb6de458f04b7a43bdba4f98e4edb052 Reviewed-on: https://code.wireshark.org/review/3139 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-06-04Fix typo that would have hit once conversion of the users guide toJoerg Mayer1-1/+1
asciidoc would have started Change-Id: Ie4f79bbf65a56a83995c70eb864d2476885c9170 Reviewed-on: https://code.wireshark.org/review/1966 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-06-04Do not rebuild developers-guide.xml on each run. Do this only whenJoerg Mayer1-3/+7
required. Change-Id: I525c09e78c385593a7132ad3bfbca1114ea0de8b Reviewed-on: https://code.wireshark.org/review/1965 Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-03-31Continue to remove $Id$ from top of fileAlexis La Goutte1-2/+0
(Using sed : sed -i '/^\# \$Id\$/,+1 d') (start with dash) Change-Id: Ia4b5a6c2302f6a531f6a86c1ec3a2f8205c8c2dd Reviewed-on: https://code.wireshark.org/review/881 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-26Add various functions for Lua directory handling and path infoHadriel Kaplan1-0/+1
This adds new functions to get plugins path info, find out if a directory exists, make a new one, remove one, etc. It also creates a file environment for user-supplied Lua scripts, to prevent global variable contamination as well as supply the script-specific file name. Some other minor cleanup was done as I found them. A new testsuite was added to test the existing and new directory functions. Change-Id: I19bd587b5e8a73d89b8521af73670e023314fb33 Reviewed-on: https://code.wireshark.org/review/832 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-19Add capture file reader/writer support for Lua so scripts can implement new ↵Michael Mann1-0/+1
capture file formats. This enables a Lua script to implement a brand new capture file format reader/writer, so that for example one could write a script to read from vendor-specific "logs" of packets, and show them as normal packets in wireshark. Change-Id: Id394edfffa94529f39789844c382b7ab6cc2d814 Reviewed-on: https://code.wireshark.org/review/431 Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com> Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-10Add GLib's regex library into LuaHadriel Kaplan1-1/+0
While Lua's built-in pattern support is ok for simple things, many people end up wanting a real regex engine. Since Wireshark already includes the GLib Regex library (a wrapper for PCRE), it makes sense to expose that library to Lua scripts. This has been done using Lrexlib, one of the most popular regex bindings for Lua. Lrexlib didn't support binding GLib's Regex in particular - it does for PCRE but GLib is a different API - so I've done that. A fairly thorough testsuite came along with that, which has been incorporated into the wireshark wslua testuites as well in this commit. Change-Id: I05811d1edf7af8d7c9f4f081de6850f31c0717c7 Reviewed-on: https://code.wireshark.org/review/332 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-02-14Adds support for Lua struct library so one can pack/unpack binary structuresHadriel Kaplan1-0/+2
This is based on Roberto Ierusalimschy's struct library, along with additional options based on Flemming Madsen's patch to the lua-users mailing list, and some changes I made to support 64-bit integer packing/unpacking. Details are in the top comments for wslua_struct.c. This also includes a test script. Change-Id: Ifcd0116ba013d5c760927721c8d6e9f28965534b Reviewed-on: https://code.wireshark.org/review/98 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-02-11Finish converting the Developer's Guide to AsciiDoc.Gerald Combs1-25/+38
Add developer-guide-docinfo.xml, which lets us carry over DocBook front matter. Remove the meta_info chapter. Most of its contents are now in developer-guide-docinfo.xml. Add a DocBook revision history based on hints from the Git/SVN/CVS revision history. Comment out or note makefile content that's no longer necessary for converting the Developer's Guide but will be useful for converting the User's Guide. Fix building the release notes with CMake. Other minor changes. Tested with Autotools, nmake, and CMake. Change-Id: Ib6d50c821ca906fff50a84ad4d6af3212ebdff0a Reviewed-on: https://code.wireshark.org/review/155 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-06Convert the user interface chapter to AsciiDoc.Gerald Combs1-1/+2
Start mentioning Qt. Update and add HIG links. Change-Id: Iac984045b03a96862981d58ff63c9ee6bcdbbce8 Reviewed-on: https://code.wireshark.org/review/127 Tested-by: Wireshark Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-04Adds support for Lua Int64 and UInt64 operators, functions, and generalHadriel Kaplan1-0/+1
usefulness, working around bug #9162 until Lua 5.3 is released. The existing Int64 and UInt64 classes provide virtually no usefullness, other than for creating a string of their value. While one could then write Lua code to convert the string to Lua numbers and such, ultimately Lua has no native 64-bit integer support, making such a task difficult to handle in Lua. This change adds a host of functions and operators to the existing Int64 (gint64) and UInt64 (guint64) classes, to enable true 64-bit integer support on par with native Lua numbers. A test script is also provided, which tests the functions/operators. Change-Id: I4c5f8f5219b9a88198902283bd32ddf24c346bbe Reviewed-on: https://code.wireshark.org/review/83 Tested-by: Evan Huus <eapache@gmail.com> Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-03Convert the dissection chapter to AsciiDoc.Gerald Combs1-1/+2
Change-Id: Ieccd2ad235576b9ec6013ddb23a8373ccf2f8cdf Reviewed-on: https://code.wireshark.org/review/92 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-02Convert three more WSDG chapters: works, build, and capture.Gerald Combs1-4/+7
Start adding references to Qt and wsutil. Fix a file extension in CMakeLists.txt. Change-Id: I0cbe7e802d88a05effff40b5de72669e22c0df53 Reviewed-on: https://code.wireshark.org/review/79 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01Convert the libraries chapter to AsciiDoc.Gerald Combs1-1/+2
Add some docbook-related entries to .gitignore. Whoever maintains the Windows libraries has done a terrible job of keeping this chapter up to date. Change-Id: Ic6dcbd9e8369eae9f07403bd3f805a515886f542 Reviewed-on: https://code.wireshark.org/review/72 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-02-01Convert the tools chapter to AsciiDoc.Gerald Combs1-1/+2
Replace SVN text with Git, other mostly-minor edits. Change-Id: I41b602cc9334656dc8e5f37c33fb6cd660043d17 Reviewed-on: https://code.wireshark.org/review/69 Reviewed-by: Gerald Combs <gerald@wireshark.org> Tested-by: Gerald Combs <gerald@wireshark.org>
2014-01-27Convert the quick setup chapter to AsciiDoc and start converting itsGerald Combs1-1/+2
content to Git. svn path=/trunk/; revision=54985
2014-01-27Migrate the build environment introduction to AsciiDoc.Gerald Combs1-1/+2
svn path=/trunk/; revision=54971