osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

Docs: Remove the authors list from wireshark(1). 

The AUTHORS section of wireshark(1) is about half the content of the man
page. While it's important to acknowledge the people who have
contributed to the project, the goal of the man page is to tell people
how to use Wireshark.

Replace the list of authors with text that acknowledges their
contributions along with pointers to the AUTHORS file and the list on
the main web site.
This commit is contained in:
Gerald Combs 2021-06-17 18:02:26 -07:00
parent 5eda4c0128
commit 0ae9c3e8eb
3 changed files with 7 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/CMakeLists.txt
View File

@ -18,43 +18,8 @@ add_custom_command(
${CMAKE_SOURCE_DIR}/AUTHORS
)
add_custom_command(
OUTPUT AUTHORS-SHORT-FORMAT
COMMAND ${PERL_EXECUTABLE}
${CMAKE_CURRENT_SOURCE_DIR}/make-authors-format.pl
< ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT
> ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/make-authors-format.pl
${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT
)
if(WIN32)
file(TO_NATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template WPT_WIN_PATH)
file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT ASF_WIN_PATH)
file(TO_NATIVE_PATH ${CMAKE_CURRENT_BINARY_DIR}/wireshark.pod WP_WIN_PATH)
add_custom_command(
OUTPUT wireshark.pod
COMMAND copy /B ${WPT_WIN_PATH} + ${ASF_WIN_PATH} ${WP_WIN_PATH}
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template
${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT
)
else()
add_custom_command(
OUTPUT wireshark.pod
COMMAND cat
${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template
${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT
> ${CMAKE_CURRENT_BINARY_DIR}/wireshark.pod
DEPENDS
${CMAKE_CURRENT_SOURCE_DIR}/wireshark.pod.template
${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT
)
endif()
pod2manhtml(${CMAKE_CURRENT_BINARY_DIR}/wireshark 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/wireshark 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/androiddump 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/capinfos 1)
pod2manhtml(${CMAKE_CURRENT_SOURCE_DIR}/captype 1)
@ -203,7 +168,6 @@ add_custom_target(
docs ALL
DEPENDS
${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT
${CMAKE_CURRENT_BINARY_DIR}/AUTHORS-SHORT-FORMAT
${MAN1_INSTALL_FILES}
${MAN4_INSTALL_FILES}
${HTML_INSTALL_FILES}

53
doc/make-authors-format.pl
View File

@ -1,53 +0,0 @@
# Convert AUTHORS-SHORT file for use in man page and HTML documentation
# after processing through pod2man and pod2html.
#
# Copyright 2004 Graeme Hewson <ghewson@wormhole.me.uk>
#
# Wireshark - Network traffic analyzer
# By Gerald Combs <gerald@wireshark.org>
# Copyright 1998 Gerald Combs
#
# SPDX-License-Identifier: GPL-2.0-or-later
#
use strict;
use open qw(:std :utf8);
# This might not be necessary.
print "=for html <style>div#authors pre, div#authors pre code { white-space: pre-wrap; }</style>\n\n";
print "=for html <div id=authors>\n\n";
print "=for man .nf\n\n";
while (<>) {
printline();
}
print "\n=for html </div>\n";
print "\n=for man .fi\n";
sub printline {
my $line = shift || $_;
if ($line =~ /^=/) {
#
# Convert Asciidoctor-style headings to Pod.
#
$line =~ s/^= /=head2 /;
$line =~ s/\s*=+$//;
print $line;
return;
}
if ($line =~ /<\S+\[AT\]\S+>$/i or $line =~ /address removed.*\)/) {
# Make the author lists verbatim paragraphs.
$line = " " . $line;
}
if ($line =~ /^and by:/) {
# This needs to be a regular paragraph.
$line = "\n" . $line;
}
print $line;
}

10
doc/wireshark.pod.template → doc/wireshark.pod
View File

@ -2952,6 +2952,12 @@ log domains and takes precedence over the active domains filter.
=back
=head1 AUTHORS
Wireshark would not be the powerful, featureful application it is without the generous contributions of hundreds of developers.
A complete list of authors can be found in the AUTHORS file in Wireshark's source code repository and at L<https://www.wireshark.org/about.html#authors>.
=head1 SEE ALSO
wireshark-filter(4), tshark(1), editcap(1), pcap(3), dumpcap(1), mergecap(1),
@ -2964,7 +2970,3 @@ L<https://www.wireshark.org>.
HTML versions of the Wireshark project man pages are available at:
L<https://www.wireshark.org/docs/man-pages>.
=head1 AUTHORS