Commit Graph

29 Commits

Author SHA1 Message Date
Gerald Combs a183726370 DocBook: Don't require xmllint.
Remove dependencies on xmllint. We don't write DocBook by hand any more
and we haven't used it in a long time in the CMake builds.

Change-Id: Ic07f03b00c4554c058eece0462b0925d565b6da1
Reviewed-on: https://code.wireshark.org/review/14506
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2016-03-18 23:26:51 +00:00
Peter Wu d544ecd0ec cmake: fix parallel docbook build
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-02-26 19:52:09 +00:00
Peter Wu 8d256d26d3 cmake: fix docbook dependency
After changing an asciidoc source file, the html files were not rebuilt
via 'ninja developer_guides'. It turns out that the
developer_guide_docbook target has an order-only dependency on
developer-guide.xml (and not the developer-guide.xml dependencies).

Fix this by adding an explicit dependency on the generated .xml file.

Change-Id: I4bdc0ebca8909caaab9cc0797cc35cc6260bfe43
Reviewed-on: https://code.wireshark.org/review/14065
Reviewed-by: Peter Wu <peter@lekensteyn.nl>
Petri-Dish: Peter Wu <peter@lekensteyn.nl>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2016-02-23 23:31:11 +00:00
Graham Bloice 619a7a35b7 Docbook: Revert part of change 13160
Remove the file dependency on the xml file as this causes
build failures due to parallel building.

There is still an issue with the build of *.hhp if the corresponding
*.xml file is rebuilt.

Change-Id: I738c687be50daebcf93576be8a43dbb6475f4fc8
Reviewed-on: https://code.wireshark.org/review/13217
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
2016-01-12 08:49:59 +00:00
Graham Bloice 25bfbaa0cf CMake: Fix docbook dependencies
unset accumulator variables after use so that successive uses are
not carried forward.
add MAIN_DEPENDENCY for chm generation so that it is correctly
rebuilt when the sources change.

Change-Id: I3b0c47a775f398346cc3a3bbd39d4fab2b0ec000
Reviewed-on: https://code.wireshark.org/review/13160
Reviewed-by: Graham Bloice <graham.bloice@trihedral.com>
Petri-Dish: Graham Bloice <graham.bloice@trihedral.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2016-01-10 07:04:11 +00:00
Guy Harris 12c83d02cc Report an error if we don't find fop and are going to try to use it.
Change-Id: Ide5c43b797a2fa07c7d3c7f986d306a158d68c6b
Reviewed-on: https://code.wireshark.org/review/10840
Reviewed-by: Guy Harris <guy@alum.mit.edu>
(cherry picked from commit 6c45d217d9d4fbf2a4dbc17d0b92334e3bc93052)
Reviewed-on: https://code.wireshark.org/review/10841
2015-10-06 18:46:00 +00:00
Gerald Combs 394773ccae Switch the guides back to html output.
DocBook's xhtml5 stylesheet output didn't render correctly in Firefox.

This reverts commit dc09d18e8e.
This reverts commit 62e56ad92a.
This reverts commit 53a80334bc.

Change-Id: Iafcf18cfce25772146fc2e155728401fd105a44b
Reviewed-on: https://code.wireshark.org/review/9944
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-09 16:16:24 +00:00
Gerald Combs 0626e766cf CMake: Try to fix generated docbook dependencies.
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-08 21:51:56 +00:00
Gerald Combs 62e56ad92a Make sure we use "*.html" in our chunked output.
Change-Id: Idb441084ec50ec336b7f514895aba799832e8f66
Reviewed-on: https://code.wireshark.org/review/9879
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-05 18:01:28 +00:00
Gerald Combs 53a80334bc Generate XHTML5 documentation.
When converting from DocBook to HTML, use DocBook's xhtml5 XSL
stylesheets.

Change-Id: I7a49d60c46a17e1e639b78ee10c4b9fa832d4a77
Reviewed-on: https://code.wireshark.org/review/9878
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-08-05 16:42:03 +00:00
Graham Bloice e15513be9d Fix Windows asciidoc build
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-28 15:43:48 +00:00
Gerald Combs 9a19d6de54 CMake: Look for FOP and HHC only when needed.
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-14 23:27:41 +00:00
Gerald Combs e54b5f052d CMake: Copy admonition graphics to the correct directory.
Change-Id: Iecba4000c487a90efedfc7547771539c3748a7f0
Reviewed-on: https://code.wireshark.org/review/6454
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-09 22:59:38 +00:00
Gerald Combs 2bb26eaf2c CMake: Copy CHM graphics from the correct source.
Change-Id: Iea67bdaf8d83009c808bd39693fe273b3181ff76
Reviewed-on: https://code.wireshark.org/review/6452
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-09 18:29:13 +00:00
Gerald Combs 4f658999e6 CMake: Migrate to hhc.cmake.
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-09 17:49:37 +00:00
Gerald Combs 4bc8d0f9a8 CMake: Try to fix the xsltproc path.
Try to make the xsltproc path compatible with Cygwin. This is a blind
attempt to fix the Windows 8 buildbot. It works fine locally.

Change-Id: Ib9d55dd07c6b17cfddf313716227d347109d2103
Reviewed-on: https://code.wireshark.org/review/6438
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-09 01:11:29 +00:00
Gerald Combs 03f273a5ee HTML Help: Fix titles.
AsciiDoc converts single quotes into curly quote entities, which HTML
Help doesn't support. Use sed to fixup the title string.

We might want to drop HTML Help at some point.

Change-Id: I0c7d3be90c0de7dbac0f1367cc6ba323c7380939
Reviewed-on: https://code.wireshark.org/review/6435
Reviewed-by: Gerald Combs <gerald@wireshark.org>
2015-01-09 00:35:19 +00:00
Gerald Combs cd7408e526 CMake: Enable DocBook on Windows.
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>
2015-01-08 22:05:38 +00:00
Joerg Mayer 7a7a7639f2 cmake:
Avoide rebuilding the guides each and every time.
  Don't print the single file guides to stdout.

Change-Id: Ie94fc4b24676e9abc7258c4ea1c7fd3049a96fb6
Reviewed-on: https://code.wireshark.org/review/5367
Reviewed-by: Jörg Mayer <jmayer@loplof.de>
2014-11-17 20:15:01 +00:00
Gerald Combs d31011572d Convert admon graphics to SVG.
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-24 02:56:35 +00:00
Gerald Combs a92c3fb2fa CMake: More a2x / asciidoc fixes.
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-24 00:11:32 +00:00
Gerald Combs 02c5a12ee4 WSUG: Convert the "User Interface" chapter to AsciiDoc.
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-23 18:32:51 +00:00
Alexis La Goutte 813aa93510 Cmake : (Find XLST Proc) fix indent (use 4spaces)
Change-Id: Ic8abdc9aaae899dcc5d870bc023c52dc7a2bbfe6
Reviewed-on: https://code.wireshark.org/review/2952
Reviewed-by: Evan Huus <eapache@gmail.com>
2014-07-09 19:30:04 +00:00
Alexis La Goutte 757aa33220 Continue to remove $Id$ from top of file
(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-31 18:48:06 +00:00
Jörg Mayer d2fc0179cc - Avoid copying of the graphics, specify the graphics source
dir instead.
- (Finally!) fix the problem of missing admon graphics in out of
  tree builds - specify the admin directory as an absolute path
  This may need porting to Makefile.am

svn path=/trunk/; revision=53618
2013-11-27 23:07:25 +00:00
Balint Reczey 7af36bb2db Revert "Fix using fop from CMake"
This reverts commit r52484

svn path=/trunk/; revision=52488
2013-10-10 08:41:14 +00:00
Balint Reczey 6602789a48 Fix using fop from CMake
svn path=/trunk/; revision=52484
2013-10-10 05:02:50 +00:00
Jörg Mayer 914983a0dc Almost working out-of-tree builds for the documentation,
with a few hacks right now:
- The tip.png, warning.png and note.png images are missing from the
  pdfs and I have no idea how to tell fop how to find them.
- Disabling/enabling building the guides via option currently doesn't
  work (probably too many macros :-), so comment out the subdir instead.
- Right now, in order to build the devleopers guide we need to do the
  following in the source docbook directory:
  touch wsdg_graphics/toolbar/dummy.dummy

Apart from these: The build works with a pristine docbook dir
(svn status --no-ignore).

svn path=/trunk/; revision=32004
2010-02-25 12:30:44 +00:00
Jörg Mayer 9a69a7934e - Beginnings of cmake in docbook directory
- Add note about "make help"
- Move beginnings of packaging into its own file: CPackConfig.txt

svn path=/trunk/; revision=31379
2009-12-29 12:12:26 +00:00