aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2017-11-11 12:14:09 +0000
committerAnders Broman <a.broman58@gmail.com>2017-11-11 15:45:31 +0000
commit4ec8ebcebbbd67a54429d3d18982aaefb6118b91 (patch)
tree5717b7605c74d327ea437ca9d348e154d2bcca41 /doc
parent92be91f57a162136523f40b6f9eefddacf7a3328 (diff)
SPDX: Convert doc and docbook.
Replace the GPLv2+ blurbs in the doc and docbook directories with SPDX headers as appropriate. This includes example code such as packet-PROTOABBREV.c. Remove dfilter2pod.pl and dfilter2xml.pl. We haven't used them since 2010. Change-Id: I4adec02a9a4bc3e71e32bdf89f2754edaf696938 Reviewed-on: https://code.wireshark.org/review/24343 Reviewed-by: Gerald Combs <gerald@wireshark.org> Petri-Dish: Gerald Combs <gerald@wireshark.org> Tested-by: Petri Dish Buildbot Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/CMakeLists.txt14
-rw-r--r--doc/Makefile.am14
-rw-r--r--doc/README.stats_tree14
-rwxr-xr-xdoc/dfilter2pod.pl140
-rwxr-xr-xdoc/extcap_example.py13
-rwxr-xr-xdoc/make-authors-format.pl13
-rwxr-xr-xdoc/make-authors-short.pl13
-rw-r--r--doc/packet-PROTOABBREV.c14
-rwxr-xr-xdoc/perlnoutf.pl14
-rw-r--r--doc/plugins.example/Makefile.am14
-rw-r--r--doc/plugins.example/hello.c14
11 files changed, 10 insertions, 267 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index ef0e90a2e1..333e356e2a 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -4,19 +4,7 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
add_custom_command(
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2c30b11ce0..fe517fe4cf 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,19 +5,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
-# 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.
# We include dependencies on ../config.h in order to
# capture when $(VERSION) changes.
@@ -326,7 +315,6 @@ EXTRA_DIST = \
capinfos.pod \
captype.pod \
ciscodump.pod \
- dfilter2pod.pl \
dftest.pod \
dumpcap.pod \
editcap.pod \
diff --git a/doc/README.stats_tree b/doc/README.stats_tree
index 8f62778d93..f42f262b64 100644
--- a/doc/README.stats_tree
+++ b/doc/README.stats_tree
@@ -47,19 +47,7 @@ A small example of a very basic stats_tree plugin follows.
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- * 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.
+ * SPDX-License-Identifier: GPL-2.0+
*/
#include "config.h"
diff --git a/doc/dfilter2pod.pl b/doc/dfilter2pod.pl
deleted file mode 100755
index 4c08a259c9..0000000000
--- a/doc/dfilter2pod.pl
+++ /dev/null
@@ -1,140 +0,0 @@
-#!/usr/bin/perl
-#
-# Reads the display filter keyword dump produced by 'tshark -G' and
-# formats it for a pod document. The pod document is then used to
-# make a manpage
-#
-# STDIN is the wireshark glossary
-# arg1 is the pod template file. The =insert_dfilter_table token
-# will be replaced by the pod-formatted glossary
-# STDOUT is the output
-#
-# Gilbert Ramirez <gram [AT] alumni.rice.edu>
-#
-# Wireshark - Network traffic analyzer
-# By Gerald Combs <gerald@wireshark.org>
-# Copyright 1998 Gerald Combs
-#
-# 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.
-
-use Getopt::Std;
-
-%ftenum_names = (
- 'FT_NONE', 'No value',
- 'FT_PROTOCOL', 'Protocol',
- 'FT_BOOLEAN', 'Boolean',
- 'FT_UINT8', 'Unsigned 8-bit integer',
- 'FT_UINT16', 'Unsigned 16-bit integer',
- 'FT_UINT24', 'Unsigned 24-bit integer',
- 'FT_UINT32', 'Unsigned 32-bit integer',
- 'FT_UINT64', 'Unsigned 64-bit integer',
- 'FT_INT8', 'Signed 8-bit integer',
- 'FT_INT16', 'Signed 16-bit integer',
- 'FT_INT24', 'Signed 24-bit integer',
- 'FT_INT32', 'Signed 32-bit integer',
- 'FT_INT64', 'Signed 64-bit integer',
- 'FT_FLOAT', 'Single-precision floating point',
- 'FT_DOUBLE', 'Double-precision floating point',
- 'FT_ABSOLUTE_TIME', 'Date/Time stamp',
- 'FT_RELATIVE_TIME', 'Time duration',
- 'FT_STRING', 'String',
- 'FT_STRINGZ', 'NULL terminated string',
- 'FT_EBCDIC', 'EBCDIC string',
- 'FT_UINT_STRING', 'Length string pair',
- 'FT_ETHER', '6-byte Hardware (MAC) Address',
- 'FT_BYTES', 'Byte array',
- 'FT_UINT_BYTES', 'Length byte array pair',
- 'FT_IPv4', 'IPv4 address',
- 'FT_IPv6', 'IPv6 address',
- 'FT_IPXNET', 'IPX network or server name',
- 'FT_FRAMENUM', 'Frame number',
- 'FT_PCRE', 'Perl Compatible Regular Expression',
- 'FT_GUID', 'Globally Unique Identifier',
- 'FT_OID', 'Object Identifier',
- 'FT_REL_OID', 'Relative Object Identifier',
-);
-
-getopts('e');
-
-if ($opt_e) {
- $proto_abbrev{'Unable to generate filter documentation'} =
- 'Please refer to https://www.wireshark.org/docs/dfref/';
- printf STDERR "Creating empty filter list.\n";
-} else {
- # Read all the data into memory
- while (<STDIN>) {
- next unless (/^([PF])/);
-
- $record_type = $1;
- # Strip the line from its line-end sequence
- # chomp($_) won't work on Win32/CygWin as it leaves the '\r' character.
- $_ =~ s/[\r\n]//g;
-
- # Store protocol information
- if ($record_type eq 'P') {
- ($junk, $name, $abbrev) = split(/\t+/, $_);
- $proto_abbrev{$name} = $abbrev;
- }
- # Store header field information
- else {
- ($junk, $name, $abbrev, $type, $parent, $blurb) =
- split(/\t+/, $_);
- push(@{$field_abbrev{$parent}}, $abbrev);
- $field_info{$abbrev} = [ $name, $type, $blurb ];
- }
- }
-}
-
-# if there was no input on stdin, bail out
-if ($record_type ne 'P' and $record_type ne 'F' and !defined($opt_e)) {
- exit;
-}
-
-$template = shift(@ARGV);
-
-open(TEMPLATE, $template) || die "Can't open $template for reading: $!\n";
-
-while (<TEMPLATE>) {
- if (/=insert_dfilter_table/) {
- &create_dfilter_table;
- }
- else {
- print;
- }
-}
-
-close(TEMPLATE) || die "Can't close $template: $!\n";
-
-sub create_dfilter_table {
-
- # Print each protocol
- for $proto_name (sort keys %proto_abbrev) {
-
- print "=head2 $proto_name ($proto_abbrev{$proto_name})\n\n";
-
- # If this proto has children fields, print those
- if ($field_abbrev{$proto_abbrev{$proto_name}}) {
-
- for $field_abbrev (sort @{$field_abbrev{$proto_abbrev{$proto_name}}}) {
- print " $field_abbrev ", $field_info{$field_abbrev}[0],"\n",
- " ", $ftenum_names{$field_info{$field_abbrev}[1]},
- "\n";
- print " ", $field_info{$field_abbrev}[2], "\n"
- if $field_info{$field_abbrev}[2];
- print "\n";
- }
- }
- }
-}
diff --git a/doc/extcap_example.py b/doc/extcap_example.py
index 9c14ddeae7..a2ee6fb3b9 100755
--- a/doc/extcap_example.py
+++ b/doc/extcap_example.py
@@ -6,19 +6,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
-# 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.
"""
This is a generic example, which produces pcap packages every n seconds, and
diff --git a/doc/make-authors-format.pl b/doc/make-authors-format.pl
index 763b3e3984..2c37dca54f 100755
--- a/doc/make-authors-format.pl
+++ b/doc/make-authors-format.pl
@@ -9,19 +9,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
-# 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.
use strict;
diff --git a/doc/make-authors-short.pl b/doc/make-authors-short.pl
index df0a335ccf..00e23c3132 100755
--- a/doc/make-authors-short.pl
+++ b/doc/make-authors-short.pl
@@ -9,19 +9,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
-# 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.
use strict;
diff --git a/doc/packet-PROTOABBREV.c b/doc/packet-PROTOABBREV.c
index 52a38890cb..4d9122e19f 100644
--- a/doc/packet-PROTOABBREV.c
+++ b/doc/packet-PROTOABBREV.c
@@ -6,19 +6,7 @@
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- * 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.
+ * SPDX-License-Identifier: GPL-2.0+
*/
/*
diff --git a/doc/perlnoutf.pl b/doc/perlnoutf.pl
index e484a9e4af..a562f964a5 100755
--- a/doc/perlnoutf.pl
+++ b/doc/perlnoutf.pl
@@ -9,20 +9,8 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
-# 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.
-
use strict;
diff --git a/doc/plugins.example/Makefile.am b/doc/plugins.example/Makefile.am
index b477e13933..df90503908 100644
--- a/doc/plugins.example/Makefile.am
+++ b/doc/plugins.example/Makefile.am
@@ -4,19 +4,7 @@
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0+
#
WARNFLAGS = -Wall -Wextra
diff --git a/doc/plugins.example/hello.c b/doc/plugins.example/hello.c
index 8493d12ad0..fce0a5372b 100644
--- a/doc/plugins.example/hello.c
+++ b/doc/plugins.example/hello.c
@@ -4,19 +4,7 @@
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- * 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.
+ * SPDX-License-Identifier: GPL-2.0+
*/
#ifdef HAVE_CONFIG_H