aboutsummaryrefslogtreecommitdiff
path: root/libiberty/gather-docs
diff options
context:
space:
mode:
authordj <dj@138bc75d-0d04-0410-961f-82ee72b054a4>2001-09-26 18:16:17 +0000
committerdj <dj@138bc75d-0d04-0410-961f-82ee72b054a4>2001-09-26 18:16:17 +0000
commit614a23c65d9eabed00a5fe30a4d0fa138b6aa5e9 (patch)
tree3731ea290c206f61394a41a0ef3959828587369f /libiberty/gather-docs
parent06c92cbc412348d781face036e144c36d0f73fc5 (diff)
* configure.in (MAKEINFO, PERL): Detect these.
(--enable-maintainer-mode): Add. * configure: Regenerate. * Makefile.in (MAKEINFO, PERL): Define. (libiberty.info, libiberty.dvi, libiberty.html): New. (CFILES): Add bsearch.c. (CONFIGURED_OFILES): New, list of objects configure might add. (maint-missing, maint-buildall): New, for maintainers only. (clean, mostlyclean): Add info/dvi/html files. * libiberty.texi, copying-lib.texi, obstacks.texi, functions.texi: New. * gather-docs: New, for maintainers. * maint-tool: New, for maintainers. * alloca.c, atexit.c, basename.c, bcmp.c, bcopy.c, bsearch.c, bzero.c, calloc.c, clock.c, configure.in, configure, getcwd.c, getpagesize.c, getpwd.c, index.c, memchr.c, memcmp.c, memcpy.c, memmove.c, memset.c, putenv.c, rename.c, rindex.c, setenv.c, sigsetmask.c, strcasecmp.c, strchr.c, strdup.c, strerror.c, strncasecmp.c, strncmp.c, strrchr.c, strstr.c, strtod.c, strtol.c, tmpnam.c, vfork.c, vprintf.c, waitpid.c, xatexit.c, xexit.c, xmalloc.c, xmemdup.c, xstrdup.c, xstrerror.c: Add or update documentation. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@45828 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libiberty/gather-docs')
-rw-r--r--libiberty/gather-docs128
1 files changed, 128 insertions, 0 deletions
diff --git a/libiberty/gather-docs b/libiberty/gather-docs
new file mode 100644
index 00000000000..b272c02ef2a
--- /dev/null
+++ b/libiberty/gather-docs
@@ -0,0 +1,128 @@
+#!/usr/bin/perl
+# -*- perl -*-
+
+# Copyright (C) 2001
+# Free Software Foundation
+#
+# This file is part of the libiberty library.
+# Libiberty is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Library General Public
+# License as published by the Free Software Foundation; either
+# version 2 of the License, or (at your option) any later version.
+#
+# Libiberty 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
+# Library General Public License for more details.
+#
+# You should have received a copy of the GNU Library General Public
+# License along with libiberty; see the file COPYING.LIB. If not,
+# write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+# Boston, MA 02111-1307, USA.
+#
+# Originally written by DJ Delorie <dj@redhat.com>
+
+
+
+# This program looks for texinfo snippets in source files and other
+# files, and builds per-category files with entries sorted in
+# alphabetical order.
+
+# The syntax it looks for is lines starting with '@def' in *.c and
+# other files (see TEXIFILES in Makefile.in). Entries are terminated
+# at the next @def* (which begins a new entry) or, for C files, a line
+# that begins with '*/' without leading spaces (this assumes that the
+# texinfo snippet is within a C-style /* */ comment).
+
+#
+
+
+
+if ($ARGV[0] eq "-v") {
+ $verbose = 1;
+ shift;
+}
+
+$srcdir = shift;
+$outfile = shift;
+
+if ($outfile !~ /\S/ || ! -f "$srcdir/Makefile.in" ) {
+ print STDERR "Usage: gather-docs [-v] srcdir outfile.txi [files with snippets in them ...]\n";
+ exit 1;
+}
+
+$errors = 0;
+
+for $in (@ARGV) {
+
+ if (!open(IN, "$srcdir/$in")) {
+ print STDERR "Cannot open $srcdir/$in for reading: $!\n";
+ $errors ++;
+
+ } else {
+ $first = 1;
+ $pertinent = 0;
+ $man_mode = 0;
+ $line = 0;
+
+ while (<IN>) {
+ $line ++;
+ $pertinent = 1 if /^\@def[a-z]*[a-wyz] /;
+ $pertinent = 0 if /^\*\//;
+ next unless $pertinent;
+
+ if (/^\@def[a-z]*[a-wyz] /) {
+
+ ($name) = m/[^\(]* ([^\( \t\r\n]+) *\(/;
+ $name =~ s/[ ]*$//;
+ $key = $name;
+ $key =~ tr/A-Z/a-z/;
+ $key =~ s/[^a-z0-9]+/ /g;
+ $name{$key} = $node;
+ $lines{$key} = '';
+ $src_file{$key} = $in;
+ $src_line{$key} = $line;
+ print "\nReading $in :" if $verbose && $first;
+ $first = 0;
+ print " $name" if $verbose;
+ $node_lines{$key} .= $_;
+
+ } else {
+ $node_lines{$key} .= $_;
+ }
+
+ $pertinent = 0 if /^\@end def/;
+ }
+ close (IN);
+ }
+}
+
+print "\n" if $verbose;
+exit $errors if $errors;
+
+if (!open (OUT, "> $outfile")) {
+ print STDERR "Cannot open $outfile for writing: $!\n";
+ $errors ++;
+ next;
+}
+print "Writing $outfile\n" if $verbose;
+
+print OUT "\@c Automatically generated from *.c and others (the comments before\n";
+print OUT "\@c each entry tell you which file and where in that file). DO NOT EDIT!\n";
+print OUT "\@c Edit the *.c files, configure with --enable-maintainer-mode,\n";
+print OUT "\@c and let gather-docs build you a new copy.\n\n";
+
+for $key (sort keys %name) {
+ print OUT "\@c $src_file{$key}:$src_line{$key}\n";
+ print OUT $node_lines{$key};
+ print OUT "\n";
+}
+
+if (! print OUT "\n") {
+ print STDERR "Disk full writing $srcdir/$cat.texi\n";
+ $errors ++;
+}
+
+close (OUT);
+
+exit $errors;