annotate scripts/mkdoc @ 16033:23a7661e529a ss-3-7-2

snapshot version 3.7.2 * configure.ac (AC_INIT): Set version to 3.7.2. (OCTAVE_RELEASE_DATE): Set to 2013-02-09. (OCTAVE_COPYRIGHT): Update year.
author John W. Eaton <jwe@octave.org>
date Sun, 10 Feb 2013 00:59:19 -0500
parents 72c96de7a403
children d63878346099
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
1 #! /bin/sh
7019
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
2 #
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12174
diff changeset
3 # Copyright (C) 1999-2012 John W. Eaton
7019
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
4 #
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
5 # This file is part of Octave.
12174
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
6 #
7019
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
7 # Octave is free software; you can redistribute it and/or modify it
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
8 # under the terms of the GNU General Public License as published by the
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
9 # Free Software Foundation; either version 3 of the License, or (at
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
10 # your option) any later version.
12174
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
11 #
7019
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
12 # Octave is distributed in the hope that it will be useful, but WITHOUT
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
14 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
15 # for more details.
12174
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
16 #
7019
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
17 # You should have received a copy of the GNU General Public License
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
18 # along with Octave; see the file COPYING. If not, see
4270ded9ddc6 [project @ 2007-10-13 01:42:20 by jwe]
jwe
parents: 5333
diff changeset
19 # <http://www.gnu.org/licenses/>.
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
20
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
21 ## Expecting arguments in this order:
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
22 ##
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
23 ## SRCDIR SRCDIR-FILES ... -- LOCAL-FILES ...
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
24
4098
8496ae60db8a [project @ 2002-10-10 05:20:20 by jwe]
jwe
parents: 3390
diff changeset
25 set -e
8496ae60db8a [project @ 2002-10-10 05:20:20 by jwe]
jwe
parents: 3390
diff changeset
26
8445
dd52e541418b scripts/mkdoc: set defaults for FIND and PERL; check usage
John W. Eaton <jwe@octave.org>
parents: 8444
diff changeset
27 PERL=${PERL:-'perl'}
dd52e541418b scripts/mkdoc: set defaults for FIND and PERL; check usage
John W. Eaton <jwe@octave.org>
parents: 8444
diff changeset
28
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
29 prefix="$1/"
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
30 shift
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents:
diff changeset
31
4098
8496ae60db8a [project @ 2002-10-10 05:20:20 by jwe]
jwe
parents: 3390
diff changeset
32 if test -f gethelp; then
5333
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
33 cat << EOF
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
34 ### DO NOT EDIT!
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
35 ###
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
36 ### This file is generated automatically from the Octave sources.
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
37 ### Edit those files instead and run make to update this file.
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
38
ac8d64b9e76a [project @ 2005-05-02 18:15:20 by jwe]
jwe
parents: 4098
diff changeset
39 EOF
9673
acf9952463c3 make mkdoc work on list of filenames
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
40 for arg
acf9952463c3 make mkdoc work on list of filenames
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
41 do
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
42 if [ "$arg" = "--" ]; then
9943
4c681ff57bc3 Modifications to makefiles to pass distcheck test
Rik <rdrider0-list@yahoo.com>
parents: 9927
diff changeset
43 prefix="./"
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
44 else
9927
ecbf1577200c Distribute DOCSTRINGS to prevent unnecessary documentation rebuild
Rik <rdrider0-list@yahoo.com>
parents: 9891
diff changeset
45 $PERL -w -e '
12174
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
46 unless (@ARGV == 2) { die "Usage: $0 srcdir m_filename" ; }
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
47 ($srcdir, $m_fname) = ($ARGV[0], $ARGV[1]);
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
48 $full_fname = $srcdir . $m_fname;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
49 exit unless ( $full_fname =~ m{(.*)/(@|)([^/]*)/(.*)\.m} );
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
50 if ($2) {
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
51 $fcn = "$2$3/$4";
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
52 } else {
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
53 $fcn = $4;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
54 }
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
55 $re_srcdir = quotemeta($srcdir);
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
56 for (qx{ ./gethelp $fcn "$full_fname" < "$full_fname"} ) {
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
57 s/^\s+\@/\@/ unless $in_example;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
58 s/^\s+\@group/\@group/;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
59 s/^\s+\@end\s+group/\@end group/;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
60 s|\@c $fcn $re_srcdir|\@c $fcn scripts/|o;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
61 $in_example = (/\s*\@example\b/ .. /\s*\@end\s+example\b/);
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
62 print;
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11594
diff changeset
63 }' "$prefix" "$arg"
9794
0d4613a736e9 convert build system to use automake and libtool
John W. Eaton <jwe@octave.org>
parents: 9673
diff changeset
64 fi
9673
acf9952463c3 make mkdoc work on list of filenames
John W. Eaton <jwe@octave.org>
parents: 9014
diff changeset
65 done
4098
8496ae60db8a [project @ 2002-10-10 05:20:20 by jwe]
jwe
parents: 3390
diff changeset
66 else
8496ae60db8a [project @ 2002-10-10 05:20:20 by jwe]
jwe
parents: 3390
diff changeset
67 echo "gethelp program seems to be missing!" 1>&2
8496ae60db8a [project @ 2002-10-10 05:20:20 by jwe]
jwe
parents: 3390
diff changeset
68 exit 1
9927
ecbf1577200c Distribute DOCSTRINGS to prevent unnecessary documentation rebuild
Rik <rdrider0-list@yahoo.com>
parents: 9891
diff changeset
69 fi