[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[bug-diffutils] [PATCH 1/4] doc: rename diff.texi to diffutils.texi
|
From: |
Jim Meyering |
|
Subject: |
[bug-diffutils] [PATCH 1/4] doc: rename diff.texi to diffutils.texi |
|
Date: |
Wed, 15 Jun 2011 14:53:37 +0200 |
FYI, just pushed:
>From df0a31f6110b14cce7d1b3fa5a48a38d603a4e12 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Sat, 11 Jun 2011 14:06:10 +0200
Subject: [PATCH 1/4] doc: rename diff.texi to diffutils.texi
This makes the .texi basename the same as the package name,
which is consistent with most other GNU packages.
* doc/diffutils.texi: Rename from...
* doc/diff.texi: ...removed.
* doc/Makefile.am (info_TEXINFOS): Reflect name change.
(diffutils_TEXINFOS): Likewise.
* cfg.mk (gendocs_options_): Remove this customization. It is no
longer needed, now that the .texi name matches that of the package.
* man/Makefile.am ($(dist_man1_MANS)): Remove now-unnecessary sed
filter.
* README: Update references to diffutils.texi etc. here, too.
* .gitignore: Update here, too.
Suggested by Karl Berry.
---
.gitignore | 2 +-
README | 8 ++++----
cfg.mk | 2 --
doc/Makefile.am | 4 ++--
doc/{diff.texi => diffutils.texi} | 14 +++++++-------
man/Makefile.am | 3 +--
6 files changed, 15 insertions(+), 18 deletions(-)
rename doc/{diff.texi => diffutils.texi} (99%)
diff --git a/.gitignore b/.gitignore
index bef4fe3..d79a385 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,7 +17,7 @@
/diffutils-*.tar.gz
/diffutils-*.tar.xz
/doc/.gitignore
-/doc/diff.info
+/doc/diffutils.info
/doc/stamp-vti
/doc/version.texi
/gnulib-tests
diff --git a/README b/README
index 1a386f7..f51587a 100644
--- a/README
+++ b/README
@@ -8,10 +8,10 @@ Please see the file COPYING for copying conditions.
Please see the file doc/version.texi for version information.
-Please see the file doc/diff.texi (or doc/diff.info) for documentation
-that can be printed with TeX, or read with the `info' program or with
-Emacs's `M-x info'. Brief man pages are in man/*, but they are no
-substitute for the documentation.
+Please see the file doc/diffutils.texi (or doc/diffutils.info) for
+documentation that can be printed with TeX, or read with the `info'
+program or with Emacs's `M-x info'. Brief man pages are in man/*,
+but they are no substitute for the documentation.
Please see the file ABOUT-NLS for notes about translations.
diff --git a/cfg.mk b/cfg.mk
index 5f0d836..c62f966 100644
--- a/cfg.mk
+++ b/cfg.mk
@@ -41,8 +41,6 @@ update-copyright-env = \
-include $(srcdir)/dist-check.mk
-gendocs_options_ = -s $(srcdir)/diff.texi
-
_cf_state_dir ?= .config-state
_date_time := $(shell date +%F.%T)
config-compare:
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 99287fa..73e8a37 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -17,7 +17,7 @@
AM_MAKEINFOFLAGS = --no-split
-info_TEXINFOS = diff.texi
-diff_TEXINFOS = fdl.texi
+info_TEXINFOS = diffutils.texi
+diffutils_TEXINFOS = fdl.texi
EXTRA_DIST = diagmeet.note
diff --git a/doc/diff.texi b/doc/diffutils.texi
similarity index 99%
rename from doc/diff.texi
rename to doc/diffutils.texi
index b9e23dc..4abc3fe 100644
--- a/doc/diff.texi
+++ b/doc/diffutils.texi
@@ -1,6 +1,6 @@
\input texinfo @c -*-texinfo-*-
@comment %**start of header
address@hidden diff.info
address@hidden diffutils.info
@include version.texi
@settitle Comparing and Merging Files
@syncodeindex vr cp
@@ -36,16 +36,16 @@ supports it in developing GNU and promoting software
freedom.''
@c first dircategory. Put this one first, as it is more useful in practice.
@dircategory Individual utilities
@direntry
-* cmp: (diff)Invoking cmp. Compare 2 files byte by byte.
-* diff: (diff)Invoking diff. Compare 2 files line by line.
-* diff3: (diff)Invoking diff3. Compare 3 files line by line.
-* patch: (diff)Invoking patch. Apply a patch to a file.
-* sdiff: (diff)Invoking sdiff. Merge 2 files side-by-side.
+* cmp: (diffutils)Invoking cmp. Compare 2 files byte by byte.
+* diff: (diffutils)Invoking diff. Compare 2 files line by line.
+* diff3: (diffutils)Invoking diff3. Compare 3 files line by line.
+* patch: (diffutils)Invoking patch. Apply a patch to a file.
+* sdiff: (diffutils)Invoking sdiff. Merge 2 files side-by-side.
@end direntry
@dircategory Text creation and manipulation
@direntry
-* Diff: (diff). Comparing and merging files.
+* Diffutils: (diffutils). Comparing and merging files.
@end direntry
@titlepage
diff --git a/man/Makefile.am b/man/Makefile.am
index d3cff23..16a6b4b 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -31,5 +31,4 @@ $(dist_man1_MANS): $(top_srcdir)/configure.ac
$(AM_V_GEN)base=`expr $@ : '\(.*\).1'` && \
(echo '[NAME]' && sed 's@/\* *@@; s/-/\\-/; q' $S/$$base.c) | \
$(HELP2MAN) -i - -i $(srcdir)/$$base.x -S '$(PACKAGE) $(VERSION)' \
- ../src/$$base \
- | sed 's/^\.B info .*/.B info diff/' >$@
+ ../src/$$base > address@hidden && mv address@hidden $@
--
1.7.6.rc0.293.g40857
>From 929cf564727acb17435e98b6d05e9d6453f10808 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Sun, 12 Jun 2011 10:14:22 +0200
Subject: [PATCH 2/4] doc: ensure each program has a man/*.x file: add "SEE
ALSO" references
* man/cmp.x: New file.
* man/diff3.x: New file.
* man/sdiff.x: New file.
* man/diff.x: Add xrefs to the other three programs, and to patch.
* man/Makefile.am (EXTRA_DIST): List new files.
(cmp.1, diff3.1, sdiff.1): Depend on each .x file.
---
man/Makefile.am | 8 ++++----
man/cmp.x | 2 ++
man/diff.x | 2 +-
man/diff3.x | 2 ++
man/sdiff.x | 2 ++
5 files changed, 11 insertions(+), 5 deletions(-)
create mode 100644 man/cmp.x
create mode 100644 man/diff3.x
create mode 100644 man/sdiff.x
diff --git a/man/Makefile.am b/man/Makefile.am
index 16a6b4b..1bd5fe7 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -18,13 +18,13 @@
dist_man1_MANS = cmp.1 diff.1 diff3.1 sdiff.1
MAINTAINERCLEANFILES = $(dist_man1_MANS)
-EXTRA_DIST = diff.x
+EXTRA_DIST = $(dist_man1_MANS:%.1=%.x)
S = $(top_srcdir)/src
-cmp.1: $S/cmp.c
+cmp.1: $S/cmp.c cmp.x
diff.1: $S/diff.c diff.x
-diff3.1: $S/diff3.c
-sdiff.1: $S/sdiff.c
+diff3.1: $S/diff3.c diff3.x
+sdiff.1: $S/sdiff.c sdiff.x
# Depend on configure.ac to get version number changes.
$(dist_man1_MANS): $(top_srcdir)/configure.ac
diff --git a/man/cmp.x b/man/cmp.x
new file mode 100644
index 0000000..5c9ef82
--- /dev/null
+++ b/man/cmp.x
@@ -0,0 +1,2 @@
+[SEE ALSO]
+diff(1), diff3(1), sdiff(1)
diff --git a/man/diff.x b/man/diff.x
index 52e605c..fdb69d2 100644
--- a/man/diff.x
+++ b/man/diff.x
@@ -1,2 +1,2 @@
[SEE ALSO]
-wdiff(1)
+wdiff(1), cmp(1), diff3(1), sdiff(1), patch(1)
diff --git a/man/diff3.x b/man/diff3.x
new file mode 100644
index 0000000..0751208
--- /dev/null
+++ b/man/diff3.x
@@ -0,0 +1,2 @@
+[SEE ALSO]
+cmp(1), diff(1), sdiff(1)
diff --git a/man/sdiff.x b/man/sdiff.x
new file mode 100644
index 0000000..fdc9c3e
--- /dev/null
+++ b/man/sdiff.x
@@ -0,0 +1,2 @@
+[SEE ALSO]
+cmp(1), diff(1), diff3(1)
--
1.7.6.rc0.293.g40857
>From 7faccb437cb0c08c52ac061db66e9e028bd690a7 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Sun, 12 Jun 2011 11:24:57 +0200
Subject: [PATCH 3/4] build: ccache works better without embedded version
strings
* src/Makefile.am: Generate version.c and version.h and put the
new symbol in a tiny library to be used by each program.
(LDADD): Add the new library.
* src/cmp.c (main): Use Version, not PACKAGE_VERSION, so the .o
file does not change with each commit-derived version increment.
* src/diff.c (main): Likewise.
* src/diff3.c (main): Likewise.
* src/sdiff.c (main): Likewise.
* src/system.h: Include "version.h".
* .gitignore: Add version.[ch]
---
.gitignore | 1 +
src/Makefile.am | 22 ++++++++++++++++++++++
src/cmp.c | 2 +-
src/diff.c | 2 +-
src/diff3.c | 2 +-
src/sdiff.c | 2 +-
src/system.h | 1 +
7 files changed, 28 insertions(+), 4 deletions(-)
diff --git a/.gitignore b/.gitignore
index d79a385..56751e1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -65,4 +65,5 @@ src/diff
src/diff3
src/paths.h
src/sdiff
+src/version.[ch]
tests/*.log
diff --git a/src/Makefile.am b/src/Makefile.am
index e94879c..275c155 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -23,6 +23,7 @@ AM_CPPFLAGS = -I../lib -I$(top_srcdir)/lib
AM_CFLAGS = $(WARN_CFLAGS) $(WERROR_CFLAGS)
LDADD = \
+ libver.a \
../lib/libdiffutils.a \
$(LIBCSTACK) \
$(LIBINTL) \
@@ -52,3 +53,24 @@ BUILT_SOURCES = paths.h
paths.h: Makefile.am
$(AM_V_GEN)(echo '#define DEFAULT_DIFF_PROGRAM "'$(gdiff)'"' && \
echo '#define LOCALEDIR "$(localedir)"') >address@hidden && mv
address@hidden $@
+
+noinst_LIBRARIES = libver.a
+nodist_libver_a_SOURCES = version.c version.h
+
+BUILT_SOURCES += version.c
+version.c: Makefile
+ $(AM_V_GEN)rm -f $@
+ $(AM_V_at)printf '#include <config.h>\n' > address@hidden
+ $(AM_V_at)printf 'char const *Version = "$(PACKAGE_VERSION)";\n' >>
address@hidden
+ $(AM_V_at)chmod a-w address@hidden
+ $(AM_V_at)mv address@hidden $@
+
+BUILT_SOURCES += version.h
+version.h: Makefile
+ $(AM_V_GEN)rm -f $@
+ $(AM_V_at)printf 'extern char const *Version;\n' > address@hidden
+ $(AM_V_at)chmod a-w address@hidden
+ $(AM_V_at)mv address@hidden $@
+
+DISTCLEANFILES = version.c version.h
+MAINTAINERCLEANFILES = $(BUILT_SOURCES)
diff --git a/src/cmp.c b/src/cmp.c
index 92b60bc..adf1cf9 100644
--- a/src/cmp.c
+++ b/src/cmp.c
@@ -248,7 +248,7 @@ main (int argc, char **argv)
break;
case 'v':
- version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, PACKAGE_VERSION,
+ version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, Version,
AUTHORS, (char *) NULL);
check_stdout ();
return EXIT_SUCCESS;
diff --git a/src/diff.c b/src/diff.c
index 0aa09e9..fb8a2bc 100644
--- a/src/diff.c
+++ b/src/diff.c
@@ -480,7 +480,7 @@ main (int argc, char **argv)
break;
case 'v':
- version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, PACKAGE_VERSION,
+ version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, Version,
AUTHORS, (char *) NULL);
check_stdout ();
return EXIT_SUCCESS;
diff --git a/src/diff3.c b/src/diff3.c
index 34e7a8f..0eecb5e 100644
--- a/src/diff3.c
+++ b/src/diff3.c
@@ -280,7 +280,7 @@ main (int argc, char **argv)
strip_trailing_cr = true;
break;
case 'v':
- version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, PACKAGE_VERSION,
+ version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, Version,
AUTHORS, (char *) NULL);
check_stdout ();
return EXIT_SUCCESS;
diff --git a/src/sdiff.c b/src/sdiff.c
index 2d53d2f..6d2e72d 100644
--- a/src/sdiff.c
+++ b/src/sdiff.c
@@ -513,7 +513,7 @@ main (int argc, char *argv[])
break;
case 'v':
- version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, PACKAGE_VERSION,
+ version_etc (stdout, PROGRAM_NAME, PACKAGE_NAME, Version,
AUTHORS, (char *) NULL);
check_stdout ();
return EXIT_SUCCESS;
diff --git a/src/system.h b/src/system.h
index 15656bc..594ef6e 100644
--- a/src/system.h
+++ b/src/system.h
@@ -117,6 +117,7 @@ int strcasecmp (char const *, char const *);
#include <stdbool.h>
#include <intprops.h>
#include "propername.h"
+#include "version.h"
/* Type used for fast comparison of several bytes at a time. */
--
1.7.6.rc0.293.g40857
>From e783a23b1944d89405342f5d6a09dba26c192005 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Mon, 13 Jun 2011 09:17:26 +0200
Subject: [PATCH 4/4] doc: do not distribute generated man/*.1 man files
* man/help2man: New file.
* man/Makefile.am: Use $(srcdir)/help2man.
Convert $(dist_man1_MANS) to $(man1_MANS), to tell automake
not to distribute the generated man/*.1 files. Now they're
generated at build-from-tarball time.
($(man1_MANS)): Depend on version.c, so that man pages are
regenerated whenever the version string changes.
---
man/Makefile.am | 20 +-
man/help2man | 667 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 677 insertions(+), 10 deletions(-)
create mode 100755 man/help2man
diff --git a/man/Makefile.am b/man/Makefile.am
index 1bd5fe7..7c982fe 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -15,10 +15,9 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
-dist_man1_MANS = cmp.1 diff.1 diff3.1 sdiff.1
-MAINTAINERCLEANFILES = $(dist_man1_MANS)
-
-EXTRA_DIST = $(dist_man1_MANS:%.1=%.x)
+man1_MANS = cmp.1 diff.1 diff3.1 sdiff.1
+EXTRA_DIST = $(man1_MANS:%.1=%.x) help2man
+DISTCLEANFILES = $(man1_MANS)
S = $(top_srcdir)/src
cmp.1: $S/cmp.c cmp.x
@@ -26,9 +25,10 @@ diff.1: $S/diff.c diff.x
diff3.1: $S/diff3.c diff3.x
sdiff.1: $S/sdiff.c sdiff.x
-# Depend on configure.ac to get version number changes.
-$(dist_man1_MANS): $(top_srcdir)/configure.ac
- $(AM_V_GEN)base=`expr $@ : '\(.*\).1'` && \
- (echo '[NAME]' && sed 's@/\* *@@; s/-/\\-/; q' $S/$$base.c) | \
- $(HELP2MAN) -i - -i $(srcdir)/$$base.x -S '$(PACKAGE) $(VERSION)' \
- ../src/$$base > address@hidden && mv address@hidden $@
+# Depend on the former to get version number changes.
+$(man1_MANS): ../src/version.c help2man
+ $(AM_V_GEN)base=`expr $@ : '\(.*\).1'` \
+ && (echo '[NAME]' && sed 's@/\* *@@; s/-/\\-/; q' $S/$$base.c) \
+ | PATH=..$(PATH_SEPARATOR)$$PATH \
+ $(srcdir)/help2man -i - -i $(srcdir)/$$base.x \
+ -S '$(PACKAGE) $(VERSION)' $$base > address@hidden && mv
address@hidden $@
diff --git a/man/help2man b/man/help2man
new file mode 100755
index 0000000..ff1013a
--- /dev/null
+++ b/man/help2man
@@ -0,0 +1,667 @@
+#!/usr/bin/perl -w
+
+# Generate a short man page from --help and --version output.
+# Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
2010,
+# 2011 Free Software Foundation, Inc.
+
+# 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 3, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+# Written by Brendan O'Dea <address@hidden>
+# Available from ftp://ftp.gnu.org/gnu/help2man/
+
+use 5.008;
+use strict;
+use Getopt::Long;
+use Text::Tabs qw(expand);
+use POSIX qw(strftime setlocale LC_ALL);
+
+my $this_program = 'help2man';
+my $this_version = '1.39.2';
+
+sub _ { $_[0] }
+sub configure_locale
+{
+ my $locale = shift;
+ die "$this_program: no locale support (Locale::gettext required)\n"
+ unless $locale eq 'C';
+}
+
+sub dec { $_[0] }
+sub enc { $_[0] }
+sub enc_user { $_[0] }
+sub kark { die +(sprintf shift, @_), "\n" }
+sub N_ { $_[0] }
+
+my $version_info = enc_user sprintf _(<<'EOT'), $this_program, $this_version;
+GNU %s %s
+
+Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
+2011 Free Software Foundation, Inc.
+This is free software; see the source for copying conditions. There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+Written by Brendan O'Dea <address@hidden>
+EOT
+
+my $help_info = enc_user sprintf _(<<'EOT'), $this_program, $this_program;
+`%s' generates a man page out of `--help' and `--version' output.
+
+Usage: %s [OPTION]... EXECUTABLE
+
+ -n, --name=STRING description for the NAME paragraph
+ -s, --section=SECTION section number for manual page (1, 6, 8)
+ -m, --manual=TEXT name of manual (User Commands, ...)
+ -S, --source=TEXT source of program (FSF, Debian, ...)
+ -L, --locale=STRING select locale (default "C")
+ -i, --include=FILE include material from `FILE'
+ -I, --opt-include=FILE include material from `FILE' if it exists
+ -o, --output=FILE send output to `FILE'
+ -p, --info-page=TEXT name of Texinfo manual
+ -N, --no-info suppress pointer to Texinfo manual
+ -l, --libtool exclude the `lt-' from the program name
+ --help print this help, then exit
+ --version print version number, then exit
+
+EXECUTABLE should accept `--help' and `--version' options and produce output on
+stdout although alternatives may be specified using:
+
+ -h, --help-option=STRING help option string
+ -v, --version-option=STRING version option string
+ --version-string=STRING version string
+ --no-discard-stderr include stderr when parsing option output
+
+Report bugs to <address@hidden>.
+EOT
+
+my $section = 1;
+my $manual = '';
+my $source = '';
+my $help_option = '--help';
+my $version_option = '--version';
+my $discard_stderr = 1;
+my ($opt_name, @opt_include, $opt_output, $opt_info, $opt_no_info,
$opt_libtool,
+ $version_text);
+
+my %opt_def = (
+ 'n|name=s' => \$opt_name,
+ 's|section=s' => \$section,
+ 'm|manual=s' => \$manual,
+ 'S|source=s' => \$source,
+ 'L|locale=s' => sub { configure_locale pop },
+ 'i|include=s' => sub { push @opt_include, [ pop, 1 ] },
+ 'I|opt-include=s' => sub { push @opt_include, [ pop, 0 ] },
+ 'o|output=s' => \$opt_output,
+ 'p|info-page=s' => \$opt_info,
+ 'N|no-info' => \$opt_no_info,
+ 'l|libtool' => \$opt_libtool,
+ 'help' => sub { print $help_info; exit },
+ 'version' => sub { print $version_info; exit },
+ 'h|help-option=s' => \$help_option,
+ 'v|version-option=s' => \$version_option,
+ 'version-string=s' => \$version_text,
+ 'discard-stderr!' => \$discard_stderr,
+);
+
+# Parse options.
+Getopt::Long::config('bundling');
+die $help_info unless GetOptions %opt_def and @ARGV == 1;
+
+my %include = ();
+my %append = ();
+my @include = (); # retain order given in include file
+
+# Process include file (if given). Format is:
+#
+# [section name]
+# verbatim text
+#
+# or
+#
+# /pattern/
+# verbatim text
+#
+
+while (@opt_include)
+{
+ my ($inc, $required) = @{shift @opt_include};
+
+ next unless -f $inc or $required;
+ kark N_("%s: can't open `%s' (%s)"), $this_program, $inc, $!
+ unless open INC, $inc;
+
+ my $key;
+ my $hash = \%include;
+
+ while (<INC>)
+ {
+ # Convert input to internal Perl format, so that multibyte
+ # sequences are treated as single characters.
+ $_ = dec $_;
+
+ # [section]
+ if (/^\[([^]]+)\]\s*$/)
+ {
+ $key = uc $1;
+ $key =~ s/^\s+//;
+ $key =~ s/\s+$//;
+ $hash = \%include;
+ push @include, $key unless $include{$key};
+ next;
+ }
+
+ # /pattern/
+ if (m!^/(.*)/([ims]*)\s*$!)
+ {
+ my $pat = $2 ? "(?$2)$1" : $1;
+
+ # Check pattern.
+ eval { $key = qr($pat) };
+ if ($@)
+ {
+ $@ =~ s/ at .*? line \d.*//;
+ die "$inc:$.:$@";
+ }
+
+ $hash = \%append;
+ next;
+ }
+
+ # Check for options before the first section--anything else is
+ # silently ignored, allowing the first for comments and
+ # revision info.
+ unless ($key)
+ {
+ # handle options
+ if (/^-/)
+ {
+ local @ARGV = split;
+ GetOptions %opt_def;
+ }
+
+ next;
+ }
+
+ $hash->{$key} ||= '';
+ $hash->{$key} .= $_;
+ }
+
+ close INC;
+
+ kark N_("%s: no valid information found in `%s'"), $this_program, $inc
+ unless $key;
+}
+
+# Compress trailing blank lines.
+for my $hash (\(%include, %append))
+{
+ for (keys %$hash) { $hash->{$_} =~ s/\n+$/\n/ }
+}
+
+sub get_option_value;
+
+# Grab help and version info from executable.
+my $help_text = get_option_value $ARGV[0], $help_option;
+$version_text ||= get_option_value $ARGV[0], $version_option;
+
+my $date = strftime "%B %Y", localtime;
+(my $program = $ARGV[0]) =~ s!.*/!!;
+my $package = $program;
+my $version;
+
+if ($opt_output)
+{
+ unlink $opt_output or kark N_("%s: can't unlink %s (%s)"),
+ $this_program, $opt_output, $! if -e $opt_output;
+
+ open STDOUT, ">$opt_output"
+ or kark N_("%s: can't create %s (%s)"), $this_program, $opt_output, $!;
+}
+
+# The first line of the --version information is assumed to be in one
+# of the following formats:
+#
+# <version>
+# <program> <version>
+# {GNU,Free} <program> <version>
+# <program> ({GNU,Free} <package>) <version>
+# <program> - {GNU,Free} <package> <version>
+#
+# and separated from any copyright/author details by a blank line.
+
+($_, $version_text) = ((split /\n+/, $version_text, 2), '');
+
+if (/^(\S+) +\(((?:GNU|Free) +[^)]+)\) +(.*)/ or
+ /^(\S+) +- *((?:GNU|Free) +\S+) +(.*)/)
+{
+ $program = $1;
+ $package = $2;
+ $version = $3;
+}
+elsif (/^((?:GNU|Free) +)?(\S+) +(.*)/)
+{
+ $program = $2;
+ $package = $1 ? "$1$2" : $2;
+ $version = $3;
+}
+else
+{
+ $version = $_;
+}
+
+$program =~ s!.*/!!;
+
+# No info for `info' itself.
+$opt_no_info = 1 if $program eq 'info';
+
+# Translators: "NAME", "SYNOPSIS" and other one or two word strings in all
+# upper case are manual page section headings. The man(1) manual page in your
+# language, if available should provide the conventional translations.
+for ($include{_('NAME')})
+{
+ if ($opt_name) # --name overrides --include contents.
+ {
+ $_ = "$program \\- $opt_name\n";
+ }
+ elsif ($_) # Use first name given as $program
+ {
+ $program = $1 if /^([^\s,]+)(?:,?\s*[^\s,\\-]+)*\s+\\?-/;
+ }
+ else # Set a default (useless) NAME paragraph.
+ {
+ $_ = sprintf _("%s \\- manual page for %s %s") . "\n", $program,
+ $program, $version;
+ }
+}
+
+# Man pages traditionally have the page title in caps.
+my $PROGRAM = uc $program;
+
+# Set default page head/footers
+$source ||= "$program $version";
+unless ($manual)
+{
+ for ($section)
+ {
+ if (/^(1[Mm]|8)/) { $manual = enc _('System Administration Utilities') }
+ elsif (/^6/) { $manual = enc _('Games') }
+ else { $manual = enc _('User Commands') }
+ }
+}
+
+# Extract usage clause(s) [if any] for SYNOPSIS.
+# Translators: "Usage" and "or" here are patterns (regular expressions) which
+# are used to match the usage synopsis in program output. An example from cp
+# (GNU coreutils) which contains both strings:
+# Usage: cp [OPTION]... [-T] SOURCE DEST
+# or: cp [OPTION]... SOURCE... DIRECTORY
+# or: cp [OPTION]... -t DIRECTORY SOURCE...
+my $PAT_USAGE = _('Usage');
+my $PAT_USAGE_CONT = _('or');
+if ($help_text =~ s/^($PAT_USAGE):( +(\S+))(.*)((?:\n(?: {6}\1|
*($PAT_USAGE_CONT): +\S).*)*)//om)
+{
+ my @syn = $3 . $4;
+
+ if ($_ = $5)
+ {
+ s/^\n//;
+ for (split /\n/) { s/^ *(($PAT_USAGE_CONT): +)?//o; push @syn, $_ }
+ }
+
+ my $synopsis = '';
+ for (@syn)
+ {
+ $synopsis .= ".br\n" if $synopsis;
+ s!^\S*/!!;
+ s/^lt-// if $opt_libtool;
+ s/^(\S+) *//;
+ $synopsis .= ".B $1\n";
+ s/\s+$//;
+ s/(([][]|\.\.+)+)/\\fR$1\\fI/g;
+ s/^/\\fI/ unless s/^\\fR//;
+ $_ .= '\fR';
+ s/(\\fI)( *)/$2$1/g;
+ s/\\fI\\fR//g;
+ s/^\\fR//;
+ s/\\fI$//;
+ s/^\./\\&./;
+
+ $synopsis .= "$_\n";
+ }
+
+ $include{_('SYNOPSIS')} ||= $synopsis;
+}
+
+# Process text, initial section is DESCRIPTION.
+my $sect = _('DESCRIPTION');
+$_ = "$help_text\n\n$version_text";
+
+# Normalise paragraph breaks.
+s/^\n+//;
+s/\n*$/\n/;
+s/\n\n+/\n\n/g;
+
+# Join hyphenated lines.
+s/([A-Za-z])-\n *([A-Za-z])/$1$2/g;
+
+# Temporarily exchange leading dots, apostrophes and backslashes for
+# tokens.
+s/^\./\x80/mg;
+s/^'/\x81/mg;
+s/\\/\x82/g;
+
+# Translators: patterns are used to match common program output. In the source
+# these strings are all of the form of "my $PAT_something = _('...');" and are
+# regular expressions. If there is more than one commonly used string, you
+# may separate alternatives with "|". Spaces in these expressions are written
+# as " +" to indicate that more than one space may be matched. The string
+# "(?:[\\w-]+ +)?" in the bug reporting pattern is used to indicate an
+# optional word, so that either "Report bugs" or "Report _program_ bugs" will
+# be matched.
+my $PAT_BUGS = _('Report +(?:[\w-]+ +)?bugs|Email +bug +reports
+to');
+my $PAT_AUTHOR = _('Written +by');
+my $PAT_OPTIONS = _('Options');
+my $PAT_ENVIRONMENT = _('Environment');
+my $PAT_FILES = _('Files');
+my $PAT_EXAMPLES = _('Examples');
+my $PAT_FREE_SOFTWARE = _('This +is +free +software');
+
+# Start a new paragraph (if required) for these.
+s/([^\n])\n($PAT_BUGS|$PAT_AUTHOR) /$1\n\n$2 /og;
+
+# Convert iso-8859-1 copyright symbol or (c) to nroff
+# character.
+s/^Copyright +(?:\xa9|\([Cc]\))/Copyright \\(co/mg;
+
+sub convert_option;
+
+while (length)
+{
+ # Convert some standard paragraph names.
+ if (s/^($PAT_OPTIONS): *\n//o)
+ {
+ $sect = _('OPTIONS');
+ next;
+ }
+ if (s/^($PAT_ENVIRONMENT): *\n//o)
+ {
+ $sect = _('ENVIRONMENT');
+ next;
+ }
+ if (s/^($PAT_FILES): *\n//o)
+ {
+ $sect = _('FILES');
+ next;
+ }
+ elsif (s/^($PAT_EXAMPLES): *\n//o)
+ {
+ $sect = _('EXAMPLES');
+ next;
+ }
+
+ # Copyright section
+ if (/^Copyright /)
+ {
+ $sect = _('COPYRIGHT');
+ }
+
+ # Bug reporting section.
+ elsif (/^($PAT_BUGS) /o)
+ {
+ $sect = _('REPORTING BUGS');
+ }
+
+ # Author section.
+ elsif (/^($PAT_AUTHOR)/o)
+ {
+ $sect = _('AUTHOR');
+ }
+
+ # Examples, indicated by an indented leading $, % or > are
+ # rendered in a constant width font.
+ if (/^( +)([\$\%>] )\S/)
+ {
+ my $indent = $1;
+ my $prefix = $2;
+ my $break = '.IP';
+ $include{$sect} ||= '';
+ while (s/^$indent\Q$prefix\E(\S.*)\n*//)
+ {
+ $include{$sect} .= "$break\n\\f(CW$prefix$1\\fR\n";
+ $break = '.br';
+ }
+
+ next;
+ }
+
+ my $matched = '';
+ $include{$sect} ||= '';
+
+ # Sub-sections have a trailing colon and the second line indented.
+ if (s/^(\S.*:) *\n / /)
+ {
+ $matched .= $& if %append;
+ $include{$sect} .= qq(.SS "$1"\n);
+ }
+
+ my $indent = 0;
+ my $content = '';
+
+ # Option with description.
+ if (s/^( {1,10}([+-]\S.*?))(?:( +(?!-))|\n( {20,}))(\S.*)\n//)
+ {
+ $matched .= $& if %append;
+ $indent = length ($4 || "$1$3");
+ $content = ".TP\n\x84$2\n\x84$5\n";
+ unless ($4)
+ {
+ # Indent may be different on second line.
+ $indent = length $& if /^ {20,}/;
+ }
+ }
+
+ # Option without description.
+ elsif (s/^ {1,10}([+-]\S.*)\n//)
+ {
+ $matched .= $& if %append;
+ $content = ".HP\n\x84$1\n";
+ $indent = 80; # not continued
+ }
+
+ # Indented paragraph with tag.
+ elsif (s/^( +(\S.*?) +)(\S.*)\n//)
+ {
+ $matched .= $& if %append;
+ $indent = length $1;
+ $content = ".TP\n\x84$2\n\x84$3\n";
+ }
+
+ # Indented paragraph.
+ elsif (s/^( +)(\S.*)\n//)
+ {
+ $matched .= $& if %append;
+ $indent = length $1;
+ $content = ".IP\n\x84$2\n";
+ }
+
+ # Left justified paragraph.
+ else
+ {
+ s/(.*)\n//;
+ $matched .= $& if %append;
+ $content = ".PP\n" if $include{$sect};
+ $content .= "$1\n";
+ }
+
+ # Append continuations.
+ while ($indent ? s/^ {$indent}(\S.*)\n// : s/^(\S.*)\n//)
+ {
+ $matched .= $& if %append;
+ $content .= "\x84$1\n";
+ }
+
+ # Move to next paragraph.
+ s/^\n+//;
+
+ for ($content)
+ {
+ # Leading dot and apostrophe protection.
+ s/\x84\./\x80/g;
+ s/\x84'/\x81/g;
+ s/\x84//g;
+
+ # Convert options.
+ s/(^| |\()(-[][\w=-]+)/$1 . convert_option $2/mge;
+
+ # Escape remaining hyphens
+ s/-/\x83/g;
+
+ if ($sect eq 'COPYRIGHT')
+ {
+ # Insert line breaks before additional copyright messages
+ # and the disclaimer.
+ s/\n(Copyright |$PAT_FREE_SOFTWARE)/\n.br\n$1/og;
+ }
+ elsif ($sect eq 'REPORTING BUGS')
+ {
+ # Handle multi-line bug reporting sections of the form:
+ #
+ # Report <program> bugs to <addr>
+ # GNU <package> home page: <url>
+ # ...
+ s/\n([[:upper:]])/\n.br\n$1/g;
+ }
+ }
+
+ # Check if matched paragraph contains /pat/.
+ if (%append)
+ {
+ for my $pat (keys %append)
+ {
+ if ($matched =~ $pat)
+ {
+ $content .= ".PP\n" unless $append{$pat} =~ /^\./;
+ $content .= $append{$pat};
+ }
+ }
+ }
+
+ $include{$sect} .= $content;
+}
+
+# Refer to the real documentation.
+unless ($opt_no_info)
+{
+ my $info_page = $opt_info || $program;
+
+ $sect = _('SEE ALSO');
+ $include{$sect} ||= '';
+ $include{$sect} .= ".PP\n" if $include{$sect};
+ $include{$sect} .= sprintf _(<<'EOT'), $program, $program, $info_page;
+The full documentation for
+.B %s
+is maintained as a Texinfo manual. If the
+.B info
+and
+.B %s
+programs are properly installed at your site, the command
+.IP
+.B info %s
+.PP
+should give you access to the complete manual.
+EOT
+}
+
+# Output header.
+print <<EOT;
+.\\" DO NOT MODIFY THIS FILE! It was generated by $this_program $this_version.
+.TH $PROGRAM "$section" "$date" "$source" "$manual"
+EOT
+
+# Section ordering.
+my @pre = (_('NAME'), _('SYNOPSIS'), _('DESCRIPTION'), _('OPTIONS'),
+ _('ENVIRONMENT'), _('FILES'), _('EXAMPLES'));
+
+my @post = (_('AUTHOR'), _('REPORTING BUGS'), _('COPYRIGHT'), _('SEE ALSO'));
+my $filter = join '|', @pre, @post;
+
+# Output content.
+for my $sect (@pre, (grep ! /^($filter)$/o, @include), @post)
+{
+ if ($include{$sect})
+ {
+ my $quote = $sect =~ /\W/ ? '"' : '';
+ print enc ".SH $quote$sect$quote\n";
+
+ for ($include{$sect})
+ {
+ # Replace leading dot, apostrophe, backslash and hyphen
+ # tokens.
+ s/\x80/\\&./g;
+ s/\x81/\\&'/g;
+ s/\x82/\\e/g;
+ s/\x83/\\-/g;
+
+ # Convert some latin1 chars to troff equivalents
+ s/\xa0/\\ /g; # non-breaking space
+
+ print enc $_;
+ }
+ }
+}
+
+close STDOUT or kark N_("%s: error writing to %s (%s)"), $this_program,
+ $opt_output || 'stdout', $!;
+
+exit;
+
+# Call program with given option and return results.
+sub get_option_value
+{
+ my ($prog, $opt) = @_;
+ my $stderr = $discard_stderr ? '/dev/null' : '&1';
+ my $value = join '',
+ map { s/ +$//; expand $_ }
+ map { dec $_ }
+ `$prog $opt 2>$stderr`;
+
+ unless ($value)
+ {
+ my $err = N_("%s: can't get `%s' info from %s%s");
+ my $extra = $discard_stderr
+ ? "\n" . N_("Try `--no-discard-stderr' if option outputs to stderr")
+ : '';
+
+ kark $err, $this_program, $opt, $prog, $extra;
+ }
+
+ return $value;
+}
+
+# Convert option dashes to \- to stop nroff from hyphenating 'em, and
+# embolden. Option arguments get italicised.
+sub convert_option
+{
+ local $_ = '\fB' . shift;
+
+ s/-/\x83/g;
+ unless (s/\[=(.*)\]$/\\fR[=\\fI$1\\fR]/)
+ {
+ s/=(.)/\\fR=\\fI$1/;
+ s/ (.)/ \\fI$1/;
+ $_ .= '\fR';
+ }
+
+ $_;
+}
--
1.7.6.rc0.293.g40857
- [bug-diffutils] [PATCH 1/4] doc: rename diff.texi to diffutils.texi,
Jim Meyering <=