Switch some AsciiDoc replacements to attributes.
authorGerald Combs <gerald@wireshark.org>
Wed, 8 Jun 2016 16:15:24 +0000 (09:15 -0700)
committerGerald Combs <gerald@wireshark.org>
Wed, 8 Jun 2016 17:40:32 +0000 (17:40 +0000)
Many of our AsciiDoc "macros" are simple string replacements. Start
converting them to attributes.

Update the release notes.

Change-Id: I23d9ffd311f13a34c16cde3b4898b7f7bb8ba638
Reviewed-on: https://code.wireshark.org/review/15778
Petri-Dish: Gerald Combs <gerald@wireshark.org>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Gerald Combs <gerald@wireshark.org>
docbook/asciidoc.conf
docbook/release-notes.asciidoc
docbook/wsdg_src/WSDG_chapter_quick_setup.asciidoc
docbook/wsdg_src/WSDG_chapter_sources.asciidoc
docbook/wsdg_src/WSDG_chapter_tools.asciidoc
docbook/wsug_src/WSUG_chapter_build_install.asciidoc
make-version.pl

index 9ad99e38705e0d63033a7aa45f69130f905d8917..f17ad8659290ff53391dcb40a8e829cb7c409106 100644 (file)
@@ -1,11 +1,13 @@
 # AsciiDoc configuration for Wireshark
 
+[attributes]
+
+wireshark-version=2.1.0
+
 [replacements]
 
-# Yes, these are fake macros.
+# Most of these are fake macros.
 # We should probably replace some or all of them with attributes.
-wireshark-version:\[\]=2.1.0
-wireshark-major-minor-version:\[\]=2.1
 
 wireshark-authors-url:\[\]=https://www.wireshark.org/about.html#authors
 wireshark-bugs-site:\[\]=https://bugs.wireshark.org/
index 9e5d0e2860cd14af3132545df1ce2565aca6c245..99fc2edce51424903326f8a8d2537f3360e82cc6 100644 (file)
@@ -1,4 +1,4 @@
-= Wireshark wireshark-version:[] Release Notes
+= Wireshark {wireshark-version} Release Notes
 // AsciiDoc quick reference: http://powerman.name/doc/asciidoc
 
 This is a semi-experimental release intended to test new features for Wireshark 2.2.
@@ -19,12 +19,13 @@ used for troubleshooting, analysis, development and education.
 //* cve-idlink:2014-2486[]
 //* Wireshark accepted your prom invitation then cancelled at the last minute. (ws-buglink:0000[])
 
-_Non-empty section placeholder._
+//_Non-empty section placeholder._
 
 === New and Updated Features
 
 The following features are new (or have been significantly updated)
 since version 2.0.0:
+
 * You can now switch between between Capture and File Format dissection of
 the current capture file via the View menu in the Qt GUI.
 * You can now show selected packet bytes as ASCII, HTML, Image, ISO 8859-1, Raw, UTF-8,
@@ -55,13 +56,13 @@ Open File dialog.
 
 New files that Wireshark can open in this mode include:
 
-_Non-empty section placeholder._
+//_Non-empty section placeholder._
 --sort-and-group--
 --sort-and-group--
 
 === New Protocol Support
 
-// Items in --sort-and-group-- blocks will be sorted and comma-separated.
+// Add one protocol per line between the --sort-and-group-- delimiters.
 --sort-and-group--
 CISCO ERSPAN3 Marker
 Nokia Intelligent Service Interface (ISI)
@@ -94,11 +95,12 @@ DecodeAs it over USB, TCP and UDP.
 A preference was added to TCP dissector for handling IPFIX process
 information.  It has been disabled by default.
 
-Too many protocols have been updated to list here.
+//Too many protocols have been updated to list here.
 
 === New and Updated Capture File Support
 
 //_Non-empty section placeholder._
+// Add one file type per line between the --sort-and-group-- delimiters.
 --sort-and-group--
 Micropross mplog
 --sort-and-group--
index 23d6d8155558779d42d3727f2b951cdc4f818ccc..593d6b308f51a948b8a2a49eecd197a40b4edbeb 100644 (file)
@@ -497,7 +497,7 @@ to build Wireshark.
 . For the older GTK version run `C:\Development\wsbuild32\run\RelWithDebInfo\wireshark-gtk.exe`.
 
 . Open 'Help -> About'. If it shows your "private" program
-version, e.g.: Version wireshark-major-minor-version:[].x-myprotocol123
+version, e.g.: Version {wireshark-version}-myprotocol123
 congratulations! You have compiled your own version of Wireshark!
 
 You may also open the Wireshark solution file (Wireshark.sln) in the Visual Studio IDE and build there.
@@ -524,7 +524,7 @@ Note: You should have successfully built Wireshark
 before doing the following.
 
 If you want to build your own
-'wireshark-win32-wireshark-major-minor-version:[].x-myprotocol123.exe',
+'Wireshark-win32-{wireshark-version}-myprotocol123.exe',
 you'll need NSIS.
 
 . NSIS:
@@ -557,7 +557,7 @@ to build a Wireshark installer.
 +
 --
 ----
-> C:\Development\wireshark\packaging\nsis\wireshark-win32-wireshark-major-minor-version:[].x-myprotocol123.exe
+> C:\Development\wireshark\packaging\nsis\wireshark-win32-{wireshark-version}-myprotocol123.exe
 ----
 to test your new installer. It's a good idea to test on a different machine
 than the developer machine. Note that if you've built an x64 version, the installer will be named accordingly.
index 4ff8e5762377bd4cb15a94f60aacc0030f8d5455..5d3676759f67606c98d7bcf74527f39f7c215501 100644 (file)
@@ -1097,7 +1097,7 @@ It might take some time, even on fast machines.
 ====
 
 If everything went well, you will now find something like:
-'wireshark-setup-wireshark-version:[].exe' in
+'wireshark-setup-{wireshark-version}.exe' in
 the 'packaging/nsis' directory in the source tree.
 
 [[ChSrcPortableApps]]
@@ -1132,7 +1132,7 @@ It might take some time, even on fast machines.
 ====
 
 If everything went well, you will now find something like:
-'WiresharkPortable_wireshark-major-minor-version:[].paf.exe' in
+'WiresharkPortable_{wireshark-version}.paf.exe' in
 the 'packaging/portableapps' directory.
 
 ++++++++++++++++++++++++++++++++++++++
index 7e4d0542e4a643780ab004af6672716ee189764c..ab4526d46af0031dace97df9a91be324dfc29dbc 100644 (file)
@@ -371,9 +371,9 @@ CMake Generator: `Visual Studio 10`
 Remarks:: Installers created using express editions require a $$C++$$ redistributable
 '$$vcredist_x86.exe$$' (3MB free
 download) is required to build
-Wireshark-win32-wireshark-major-minor-version:[].x.exe, and
+Wireshark-win32-{wireshark-version}.exe, and
 '$$vcredist_x64.exe$$' is required to build
-Wireshark-win64-wireshark-major-minor-version:[].x.exe. The version of
+Wireshark-win64-{wireshark-version}.exe. The version of
 '$$vcredist_x86.exe$$' or '$$vcredist_x64.exe$$' _must_ match the version for your
 compiler including any service packs installed for the compiler.]
 
@@ -1109,7 +1109,7 @@ installation should be straightforward.
 === Windows: NSIS (optional)
 
 The NSIS (Nullsoft Scriptable Install System) is used to generate
-'wireshark-win32-wireshark-major-minor-version:[].x.exe' from all the files
+'Wireshark-win32-{wireshark-version}.exe' from all the files
 needed to be installed, including all required DLLs, plugins, and supporting
 files.
 
@@ -1127,7 +1127,7 @@ You can find more instructions on using NSIS in <<ChSrcNSIS>>.
 === Windows: PortableApps (optional)
 
 The PortableApps.com Installer is used to generate
-'WiresharkPortable-wireshark-major-minor-version:[].paf.exe' from all the files
+'WiresharkPortable-{wireshark-version}.paf.exe' from all the files
 needed to be installed, including all required DLLs, plugins, and supporting
 files.
 
index bb54b46b6d6b560fd66c711095a269e608254e79..c10375430152d8990a5fbb86faf546d37dc66c72 100644 (file)
@@ -1,7 +1,7 @@
 ++++++++++++++++++++++++++++++++++++++
 <!-- WSUG Chapter BuildInstall -->
 ++++++++++++++++++++++++++++++++++++++
-    
+
 [[ChapterBuildInstall]]
 
 == Building and Installing Wireshark
@@ -19,20 +19,20 @@ If you are running another operating system such as Linux or FreeBSD you might
 want to install from source. Several Linux distributions offer Wireshark
 packages but they commonly ship out-of-date versions. No other versions of UNIX
 ship Wireshark so far. For that reason, you will need to know where to get the
-latest version of Wireshark and how to install it. 
+latest version of Wireshark and how to install it.
 
 This chapter shows you how to obtain source and binary packages and how to
-build Wireshark from source should you choose to do so. 
+build Wireshark from source should you choose to do so.
 
-The following are the general steps you would use: 
+The following are the general steps you would use:
 
 . Download the relevant package for your needs, e.g. source or binary
-  distribution. 
+  distribution.
+
+. Compile the source into a binary if needed.
+  This may involve building and/or installing other necessary packages.
 
-. Compile the source into a binary if needed. 
-  This may involve building and/or installing other necessary packages. 
-    
-. Install the binaries into their final destinations. 
+. Install the binaries into their final destinations.
 
 [[ChBuildInstallDistro]]
 
@@ -45,17 +45,17 @@ binary or source package.
 [NOTE]
 .Download all required files
 ====
-If you are building Wireshark from source you will 
+If you are building Wireshark from source you will
 In general, unless you have already downloaded Wireshark before, you will most
 likely need to download several source packages if you are building Wireshark
-from source. This is covered in more detail below. 
+from source. This is covered in more detail below.
 
 ++++++++++++++++++++++++++++++++++++++
 <!-- Make a ref -->
 ++++++++++++++++++++++++++++++++++++++
 ====
 
-Once you have downloaded the relevant files, you can go on to the next step. 
+Once you have downloaded the relevant files, you can go on to the next step.
 
 //
 // Windows
@@ -65,9 +65,10 @@ Once you have downloaded the relevant files, you can go on to the next step.
 
 === Installing Wireshark under Windows
 
-Windows installers contain the platform and version, e.g.
-Wireshark-win__xx__-wireshark-major-minor-version:[]._x_.exe. The Wireshark
-installer includes WinPcap which is required for packet capture.
+Windows installer names contain the platform and version. For example,
+Wireshark-win64-{wireshark-version}.exe installs Wireshark {wireshark-version}
+for 64-bit Windows. The Wireshark installer includes WinPcap which is required
+for packet capture.
 
 Simply download the Wireshark installer from: wireshark-download-page:[] and
 execute it. Official packages are signed by the *Wireshark Foundation*. You can
@@ -90,44 +91,44 @@ On the _Choose Components_ page of the installer you can select from the followi
 * *Plugins &amp; Extensions* - Extras for the Wireshark and TShark dissection engines
 
   - *Dissector Plugins* - Plugins with some extended dissections.
-  
-  - *Tree Statistics Plugins* - Extended statistics. 
 
-  - *Mate - Meta Analysis and Tracing Engine* - User configurable extension(s) of the display filter engine, see wireshark-wiki-site:[]Mate for details. 
+  - *Tree Statistics Plugins* - Extended statistics.
+
+  - *Mate - Meta Analysis and Tracing Engine* - User configurable extension(s) of the display filter engine, see wireshark-wiki-site:[]Mate for details.
 
-  - *SNMP MIBs* - SNMP MIBs for a more detailed SNMP dissection. 
+  - *SNMP MIBs* - SNMP MIBs for a more detailed SNMP dissection.
 
 * *Tools* - Additional command line tools to work with capture files
 
   - *Editcap* - Reads a capture file and writes some or all of the packets into
-    another capture file. 
+    another capture file.
 
   - *Text2Pcap* - Reads in an ASCII hex dump and writes the data into a
-    pcap capture file. 
+    pcap capture file.
 
-  - *Reordercap* - Reorders a capture file by timestamp. 
+  - *Reordercap* - Reorders a capture file by timestamp.
 
-  - *Mergecap* - Combines multiple saved capture files into a single output file. 
+  - *Mergecap* - Combines multiple saved capture files into a single output file.
 
-  - *Capinfos* - Provides information on capture files. 
+  - *Capinfos* - Provides information on capture files.
 
-  - *Rawshark* - Raw packet filter. 
+  - *Rawshark* - Raw packet filter.
 
 * *User's Guide* - Local installation of the User's Guide. The Help buttons on
   most dialogs will require an internet connection to show help pages if the
-  User's Guide is not installed locally. 
+  User's Guide is not installed locally.
 
 [[ChBuildInstallWinAdditionalTasks]]
 
 ==== Additional Tasks
-* *Start Menu Shortcuts* - Add some start menu shortcuts. 
 
-* *Desktop Icon* - Add a Wireshark icon to the desktop. 
+* *Start Menu Shortcuts* - Add some start menu shortcuts.
 
-* *Quick Launch Icon* - add a Wireshark icon to the Explorer quick launch toolbar. 
+* *Desktop Icon* - Add a Wireshark icon to the desktop.
 
-* *Associate file extensions to Wireshark* - Associate standard network trace files to Wireshark.  
+* *Quick Launch Icon* - add a Wireshark icon to the Explorer quick launch toolbar.
+
+* *Associate file extensions to Wireshark* - Associate standard network trace files to Wireshark.
 
 [[ChBuildInstallWinLocation]]
 
@@ -141,7 +142,7 @@ Files\Wireshark` on most systems.
 
 ==== Installing WinPcap
 
-The Wireshark installer contains the latest WinPcap installer. 
+The Wireshark installer contains the latest WinPcap installer.
 
 If you don't have WinPcap installed you won't be able to capture live network
 traffic but you will still be able to open saved capture files. By default the
@@ -151,36 +152,36 @@ you wish to reinstall WinPcap you can check the _Install WinPcap_ box as needed.
 For more information about WinPcap see winpcap-web-site:[] and
 wireshark-wiki-site:[]WinPcap.
 
+
 [[ChBuildInstallWinWiresharkCommandLine]]
 
 ==== Windows installer command line options
 
-For special cases, there are some command line parameters available: 
+For special cases, there are some command line parameters available:
 
 * `/S` runs the installer or uninstaller silently with default values. The
   silent installer *will not* install WinPCap.
-    
+
 * `/desktopicon` installation of the desktop icon, `=yes` - force installation,
   `=no` - don't install, otherwise use default settings. This option can be
-  useful for a silent installer. 
-    
+  useful for a silent installer.
+
 * `/quicklaunchicon` installation of the quick launch icon, `=yes` - force
-  installation, `=no` - don't install, otherwise use default settings. 
-    
+  installation, `=no` - don't install, otherwise use default settings.
+
 * `/D` sets the default installation directory ($INSTDIR), overriding InstallDir
   and InstallDirRegKey. It must be the last parameter used in the command line
-  and must not contain any quotes even if the path contains spaces. 
+  and must not contain any quotes even if the path contains spaces.
 
 * `/NCRC` disables the CRC check. We recommend against using this flag.
 
-Example: 
+Example:
 ----
 > Wireshark-win64-wireshark-2.0.5.exe /NCRC /S /desktopicon=yes /quicklaunchicon=no /D=C:\Program Files\Foo
 ----
 
 Running the installer without any parameters shows the normal interactive installer.
+
 [[ChBuildInstallWinPcapManually]]
 
 ==== Manual WinPcap Installation
@@ -188,7 +189,7 @@ Running the installer without any parameters shows the normal interactive instal
 As mentioned above, the Wireshark installer takes care of installing WinPcap.
 The following is only necessary if you want to use a different version than the
 one included in the Wireshark installer, e.g. because a new WinPcap version was
-released. 
+released.
 
 Additional WinPcap versions (including newer alpha or beta releases) can be
 downloaded from the main WinPcap site: winpcap-web-site:[]. The _Installer for
@@ -207,7 +208,7 @@ details on subscribing to this list.
 New versions of Wireshark are usually released every four to six weeks. Updating
 Wireshark is done the same way as installing it. Simply download and start the
 installer exe. A reboot is usually not required and all your personal settings
-remain unchanged. 
+remain unchanged.
 
 [[ChBuildInstallWinPcapUpdate]]
 
@@ -215,7 +216,7 @@ remain unchanged.
 
 New versions of WinPcap are less frequently available. You will find WinPcap
 update instructions the WinPcap web site at winpcap-web-site:[]. You may have to
-reboot your machine after installing a new WinPcap version. 
+reboot your machine after installing a new WinPcap version.
 
 [[ChBuildInstallWinUninstall]]
 
@@ -226,7 +227,7 @@ Select the "Wireshark" entry to start the uninstallation procedure.
 
 The Wireshark uninstaller provides several options for removal. The default is
 to remove the core components but keep your personal settings and WinPcap.
-WinPcap is left installed by default in case other programs need it. 
+WinPcap is left installed by default in case other programs need it.
 
 [[ChBuildInstallWinPcapUninstall]]
 
@@ -234,7 +235,7 @@ WinPcap is left installed by default in case other programs need it.
 
 You can uninstall WinPcap independently of Wireshark using the _WinPcap_ entry
 in the _Programs and Features_ control panel. Remember that if you uninstall
-WinPcap you won't be able to capture anything with Wireshark. 
+WinPcap you won't be able to capture anything with Wireshark.
 
 //
 // OS X
@@ -260,54 +261,54 @@ Building Wireshark requires the proper build environment including a compiler
 and many supporting libraries. See the Developer's Guide at
 wireshark-developers-guide-url:[] for more information.
 
-Use the following general steps to build Wireshark from source under UNIX or Linux: 
+Use the following general steps to build Wireshark from source under UNIX or Linux:
 
 . Unpack the source from its compressed `tar` file. If you are using Linux or
-  your version of UNIX uses GNU `tar` you can use the following command: 
+  your version of UNIX uses GNU `tar` you can use the following command:
 +
 --
 ----
 $ tar xaf wireshark-2.0.5.tar.bz2
 ----
-In other cases you will have to use the following commands: 
+In other cases you will have to use the following commands:
 ----
 $ bzip2 -d wireshark-2.0.5.tar.bz2
 $ tar xf wireshark-2.0.5.tar
-----    
+----
 --
 
-. Change directory to the Wireshark source directory. 
+. Change directory to the Wireshark source directory.
 +
 ----
 $ cd wireshark-2.0.5
 ----
 
 . Configure your source so it will build correctly for your version of UNIX. You
-  can do this with the following command: 
+  can do this with the following command:
 +
 ----
 $ ./configure
 ----
 +
 If this step fails you will have to rectify the problems and rerun `configure`.
-Troubleshooting hints are provided in <<ChBuildInstallUnixTrouble>>. 
+Troubleshooting hints are provided in <<ChBuildInstallUnixTrouble>>.
 
-. Build the sources. 
+. Build the sources.
 +
 ----
 $ make
 ----
-   
+
 . Install the software in its final destination.
 +
 ----
-$ make install    
+$ make install
 ----
 
 // XXX To do: CMake
 
 Once you have installed Wireshark with _make install_ above, you should be able
-to run it by entering `wireshark`. 
+to run it by entering `wireshark`.
 
 [[ChBuildInstallUnixInstallBins]]
 
@@ -316,7 +317,7 @@ to run it by entering `wireshark`.
 In general installing the binary under your version of UNIX will be specific to
 the installation methods used with your version of UNIX. For example, under AIX,
 you would use _smit_ to install the Wireshark binary package, while under Tru64
-UNIX (formerly Digital UNIX) you would use _setld_. 
+UNIX (formerly Digital UNIX) you would use _setld_.
 
 ==== Installing from RPM's under Red Hat and alike
 
@@ -348,25 +349,25 @@ rpm -ivh wireshark-2.0.0-1.x86_64.rpm wireshark-qt-2.0.0-1.x86_64.rpm
 ----
 
 If the above command fails because of missing dependencies, install the
-dependencies first, and then retry the step above. 
+dependencies first, and then retry the step above.
 
 ==== Installing from deb's under Debian, Ubuntu and other Debian derivatives
 
 If you can just install from the repository then use
 
 ----
-$ aptitude install wireshark 
+$ aptitude install wireshark
 ----
 
-Aptitude should take care of all of the dependency issues for you. 
+Aptitude should take care of all of the dependency issues for you.
 
-Use the following command to install downloaded Wireshark deb's under Debian: 
+Use the following command to install downloaded Wireshark deb's under Debian:
 
 ----
 $ dpkg -i wireshark-common_2.0.5.0-1_i386.deb wireshark_wireshark-2.0.5.0-1_i386.deb
 ----
 
-dpkg doesn't take care of all dependencies, but reports what's missing. 
+dpkg doesn't take care of all dependencies, but reports what's missing.
 
 
 [NOTE]
@@ -375,13 +376,13 @@ dpkg doesn't take care of all dependencies, but reports what's missing.
 By installing Wireshark packages non-root users won't gain rights automatically
 to capture packets. To allow non-root users to capture packets follow the
 procedure described in
-file:///usr/share/doc/wireshark-common/README.Debian[/usr/share/doc/wireshark-common/README.Debian] 
+file:///usr/share/doc/wireshark-common/README.Debian[/usr/share/doc/wireshark-common/README.Debian]
 ====
 
 ==== Installing from portage under Gentoo Linux
 
 Use the following command to install Wireshark under Gentoo Linux with all of
-the extra features: 
+the extra features:
 
 ----
 $ USE="c-ares gtk ipv6 portaudio snmp ssl kerberos threads selinux" emerge wireshark
@@ -389,13 +390,13 @@ $ USE="c-ares gtk ipv6 portaudio snmp ssl kerberos threads selinux" emerge wires
 
 ==== Installing from packages under FreeBSD
 
-Use the following command to install Wireshark under FreeBSD: 
+Use the following command to install Wireshark under FreeBSD:
 
 ----
 $ pkg_add -r wireshark
 ----
 
-pkg_add should take care of all of the dependency issues for you. 
+pkg_add should take care of all of the dependency issues for you.
 
 [[ChBuildInstallUnixTrouble]]
 
@@ -417,7 +418,7 @@ the required include files) on your system.
 If you cannot determine what the problems are, send an email to the
 _wireshark-dev_ mailing list explaining your problem. Include the output from
 `config.log` and anything else you think is relevant such as a trace of the
-`make` stage. 
+`make` stage.
 
 [[ChBuildInstallWinBuild]]
 
@@ -429,11 +430,11 @@ want to start developing Wireshark on the Windows platform.
 For further information how to build Wireshark for Windows from the sources
 see the Developer's Guide at wireshark-developers-guide-url:[]
 
-You may also want to have a look at the Development Wiki 
+You may also want to have a look at the Development Wiki
 (wireshark-wiki-site:[]Development) for the latest available development
-documentation. 
+documentation.
 
 ++++++++++++++++++++++++++++++++++++++
 <!-- End of WSUG Chapter 2 -->
 ++++++++++++++++++++++++++++++++++++++
-    
+
index c39211659667b6af25a3844736ea898d48e96d0b..b6e54265cf3970c7daca61d46ab65c2c2d91f374 100755 (executable)
@@ -512,8 +512,8 @@ sub update_release_notes
        while ($line = <ADOC_CONF>) {
                # wireshark-version:\[\]=1.9.1
 
-               if ($line =~ /^wireshark-version:\\\[\\\]=.*([\r\n]+)$/) {
-                       $line = sprintf("wireshark-version:\\\[\\\]=%d.%d.%d$1",
+               if ($line =~ /^wireshark-version=.*([\r\n]+)$/) {
+                       $line = sprintf("wireshark-version=%d.%d.%d$1",
                                        $version_pref{"version_major"},
                                        $version_pref{"version_minor"},
                                        $version_pref{"version_micro"},