annotate Doc/tools/push-docs.sh @ 21467:4e35fa5d5708 legacy-trunk

Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 5cd8c87a88ae
children c118d095bdde
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15266
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
1 #! /bin/sh
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
2
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
3 # Script to push docs from my development area to SourceForge, where the
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
4 # update-docs.sh script unpacks them into their final destination.
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
5
17728
a626fa0e3d75 Update the directory names to match changes at SourceForge.
Fred Drake <fdrake@acm.org>
parents: 17615
diff changeset
6 TARGET=python.sourceforge.net:/home/users/f/fd/fdrake/tmp
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
7
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
8 ADDRESSES='python-dev@python.org doc-sig@python.org python-list@python.org'
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
9
17615
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
10 VERSION=`echo '$Revision$' | sed 's/[$]Revision: \(.*\) [$]/\1/'`
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
11 EXTRA=`echo "$VERSION" | sed 's/^[0-9][0-9]*\.[0-9][0-9]*//'`
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
12 if [ "$EXTRA" ] ; then
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
13 DOCLABEL="maintenance"
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
14 DOCTYPE="maint"
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
15 else
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
16 DOCLABEL="development"
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
17 DOCTYPE="devel"
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
18 fi
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
19
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
20 EXPLANATION=''
19057
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
21 ANNOUNCE=true
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
22
18087
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
23 while [ "$#" -gt 0 ] ; do
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
24 case "$1" in
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
25 -m)
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
26 EXPLANATION="$2"
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
27 shift 2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
28 ;;
19057
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
29 -q)
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
30 ANNOUNCE=false
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
31 shift 1
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
32 ;;
18087
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
33 -t)
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
34 DOCTYPE="$2"
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
35 shift 2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
36 ;;
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
37 -F)
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
38 EXPLANATION="`cat $2`"
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
39 shift 2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
40 ;;
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
41 -*)
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
42 echo "Unknown option: $1" >&2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
43 exit 2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
44 ;;
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
45 *)
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
46 break
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
47 ;;
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
48 esac
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
49 done
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
50 if [ "$1" ] ; then
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
51 if [ "$EXPLANATION" ] ; then
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
52 echo "Explanation may only be given once!" >&2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
53 exit 2
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
54 fi
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
55 EXPLANATION="$1"
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
56 shift
15460
d397f66775e8 Adjust to allow an explanation of the changes to be included in the
Fred Drake <fdrake@acm.org>
parents: 15319
diff changeset
57 fi
d397f66775e8 Adjust to allow an explanation of the changes to be included in the
Fred Drake <fdrake@acm.org>
parents: 15319
diff changeset
58
15266
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
59 START="`pwd`"
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
60 MYDIR="`dirname $0`"
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
61 cd "$MYDIR"
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
62 MYDIR="`pwd`"
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
63
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
64 cd ..
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
65
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
66 # now in .../Doc/
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
67 make --no-print-directory bziphtml || exit $?
15266
c94c1b660ddb Helper scripts used in published the "development" snapshots of the
Fred Drake <fdrake@acm.org>
parents:
diff changeset
68 RELEASE=`grep '^RELEASE=' Makefile | sed 's|RELEASE=||'`
17466
b84f084b2992 Update the helper scripts that push development docs to SourceForge;
Fred Drake <fdrake@acm.org>
parents: 16979
diff changeset
69 PACKAGE="html-$RELEASE.tar.bz2"
b84f084b2992 Update the helper scripts that push development docs to SourceForge;
Fred Drake <fdrake@acm.org>
parents: 16979
diff changeset
70 scp "$PACKAGE" tools/update-docs.sh $TARGET/ || exit $?
17615
b830df083a9a Update publish-to-SourceForge scripts to automatically determine if the
Fred Drake <fdrake@acm.org>
parents: 17466
diff changeset
71 ssh python.sourceforge.net tmp/update-docs.sh $DOCTYPE $PACKAGE '&&' rm tmp/update-docs.sh || exit $?
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
72
19057
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
73 if $ANNOUNCE ; then
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
74 sendmail $ADDRESSES <<EOF
18431
459173237915 Change the way notification mails are sent so people who respond to the
Fred Drake <fdrake@acm.org>
parents: 18087
diff changeset
75 To: $ADDRESSES
459173237915 Change the way notification mails are sent so people who respond to the
Fred Drake <fdrake@acm.org>
parents: 18087
diff changeset
76 From: "Fred L. Drake" <fdrake@acm.org>
459173237915 Change the way notification mails are sent so people who respond to the
Fred Drake <fdrake@acm.org>
parents: 18087
diff changeset
77 Subject: [$DOCLABEL doc updates]
459173237915 Change the way notification mails are sent so people who respond to the
Fred Drake <fdrake@acm.org>
parents: 18087
diff changeset
78
18521
b1d6ae329dd0 Generate a more meaningful message regarding the type of the documentation
Fred Drake <fdrake@acm.org>
parents: 18431
diff changeset
79 The $DOCLABEL version of the documentation has been updated:
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
80
18087
6254737cb629 Make the option processing more robust.
Fred Drake <fdrake@acm.org>
parents: 17728
diff changeset
81 http://python.sourceforge.net/$DOCTYPE-docs/
16970
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
82
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
83 $EXPLANATION
723cf5e378e5 Revise the scripts I use to update the documentation on the SourceForge
Fred Drake <fdrake@acm.org>
parents: 15460
diff changeset
84 EOF
19057
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
85 exit $?
65fe6b07247b Add option to push the development docs to SF without announcing, for
Fred Drake <fdrake@acm.org>
parents: 18521
diff changeset
86 fi