[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
gnustandards ChangeLog maintain.texi
From: |
Karl Berry |
Subject: |
gnustandards ChangeLog maintain.texi |
Date: |
Sun, 18 Jan 2009 23:21:53 +0000 |
CVSROOT: /sources/gnustandards
Module name: gnustandards
Changes by: Karl Berry <karl> 09/01/18 23:21:53
Modified files:
. : ChangeLog maintain.texi
Log message:
clarify (rm)symlink directive doc
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnustandards/ChangeLog?cvsroot=gnustandards&r1=1.87&r2=1.88
http://cvs.savannah.gnu.org/viewcvs/gnustandards/maintain.texi?cvsroot=gnustandards&r1=1.168&r2=1.169
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnustandards/gnustandards/ChangeLog,v
retrieving revision 1.87
retrieving revision 1.88
diff -u -b -r1.87 -r1.88
--- ChangeLog 31 Dec 2008 18:27:23 -0000 1.87
+++ ChangeLog 18 Jan 2009 23:21:52 -0000 1.88
@@ -1,3 +1,9 @@
+2009-01-18 Karl Berry <address@hidden>
+
+ * maintain.texi (Standalone directives): clarify that `rmsymlink'
+ fails unless the symlink exists, but `symlink' overwrites an
+ existing symlink. Information from Sergey Poznyakoff.
+
2008-12-31 Karl Berry <address@hidden>
* maintain.texi (License Notices for Documentation): clarify that
Index: maintain.texi
===================================================================
RCS file: /sources/gnustandards/gnustandards/maintain.texi,v
retrieving revision 1.168
retrieving revision 1.169
diff -u -b -r1.168 -r1.169
--- maintain.texi 31 Dec 2008 18:27:23 -0000 1.168
+++ maintain.texi 18 Jan 2009 23:21:53 -0000 1.169
@@ -5,7 +5,7 @@
@c For double-sided printing, uncomment:
@c @setchapternewpage odd
@c This date is automagically updated when you save this file:
address@hidden lastupdate December 31, 2008
address@hidden lastupdate January 18, 2009
@c %**end of header
@dircategory GNU organization
@@ -25,7 +25,7 @@
Information for maintainers of GNU software, last updated @value{lastupdate}.
Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
-2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software
+2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software
Foundation, Inc.
@quotation
@@ -1381,7 +1381,15 @@
@code{comment} directive remains optional.
If you use more than one directive, the directives are executed in the
-sequence they are specified in.
+sequence they are specified in. If a directive results in an error,
+further execution of the upload is aborted.
+
+Removing a symbolic link (with @code{rmsymlink}) which does not exist
+results in an error. However, attempting to create a symbolic link
+that already exists (with @code{symlink}) is not an error. In this
+case @code{symlink} behaves like the command @command{ln -s -f}: any
+existing symlink is removed before creating the link. (But an
+existing regular file or directory is not removed.)
Here are a few examples. The first removes a symlink:
@@ -1583,32 +1591,36 @@
section above. It has a companion template file, used as the basis
for the HTML index pages. Both are available from the Texinfo CVS
sources:
address@hidden
+
address@hidden
@uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh}
@uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template}
address@hidden format
address@hidden smallformat
-There is also a ``minimalistic'' template version, available from:
+There is also a minimalistic template, available from:
address@hidden
address@hidden
@uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min}
address@hidden format
address@hidden smallformat
Invoke the script like this, in the directory containing the Texinfo
source:
address@hidden
-gendocs.sh @var{yourmanual} "GNU @var{yourmanual} manual"
address@hidden example
address@hidden where @var{yourmanual} is the short name for your package.
-The script processes the file @address@hidden (or
address@hidden or @file{.txi}). For example:
address@hidden
+gendocs.sh --email @var{yourbuglist} @var{yourmanual} "GNU @var{yourmanual}
manual"
address@hidden smallexample
address@hidden
address@hidden where @var{yourmanual} is the short name for your package
+and @var{yourbuglist} is the email address for bug reports (typically
address@hidden@var{package}@@gnu.org}). The script processes the file
address@hidden@var{yourmanual}.texinfo} (or @file{.texi} or @file{.txi}). For
+example:
+
address@hidden
cd .../emacs/man
# download gendocs.sh and gendocs_template
-gendocs.sh emacs "GNU Emacs manual"
address@hidden example
+gendocs.sh --email bug-gnu-emacs@@gnu.org emacs "GNU Emacs manual"
address@hidden smallexample
@command{gendocs.sh} creates a subdirectory @file{manual/} containing
the manual generated in all the standard output formats: Info, HTML,
@@ -1631,20 +1643,21 @@
directory with @option{-o} each time, and moving all the output to
your web page. Then write (by hand) an overall index.html with links
to them all. For example:
address@hidden
+
address@hidden
cd .../texinfo/doc
-gendocs.sh -o texinfo texinfo "GNU Texinfo manual"
-gendocs.sh -o info info "GNU Info manual"
-gendocs.sh -o info-stnd info-stnd "GNU info-stnd manual"
address@hidden example
+gendocs.sh --email bug-texinfo@@gnu.org -o texinfo texinfo "GNU Texinfo manual"
+gendocs.sh --email bug-texinfo@@gnu.org -o info info "GNU Info manual"
+gendocs.sh --email bug-texinfo@@gnu.org -o info-stnd info-stnd "GNU info-stnd
manual"
address@hidden smallexample
By default, the script uses @command{makeinfo} for generating
@acronym{HTML} output. If you prefer to use @command{texi2html}, use
the @option{--texi2html} command line option, e.g.:
address@hidden
address@hidden
gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"
address@hidden example
address@hidden smallexample
The template files will automatically produce entries for additional
HTML output generated by @command{texi2html} (i.e., split by sections
@@ -1655,6 +1668,9 @@
executed, and @env{GENDOCS_TEMPLATE_DIR} to control where the
@file{gendocs_template} file is found.
+As usual, run @samp{gendocs.sh --help} for a description of all the
+options, environment variables, and more information.
+
Please email bug reports, enhancement requests, or other
correspondence to @email{bug-texinfo@@gnu.org}.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- gnustandards ChangeLog maintain.texi,
Karl Berry <=