Recommend to put gnulib-cache.m4 into EXTRA_DIST.
[gnulib.git] / doc / maintain.texi
index f96069f..96955d5 100644 (file)
@@ -5,7 +5,7 @@
 @c For double-sided printing, uncomment:
 @c @setchapternewpage odd
 @c This date is automagically updated when you save this file:
-@set lastupdate October 24, 2007
+@set lastupdate April 25, 2008
 @c %**end of header
 
 @dircategory GNU organization
 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 Free Software
+2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software
 Foundation, Inc.
 
 @quotation
-Permission is granted to make and distribute verbatim copies
-of this entire document without royalty provided the
-copyright notice and this permission notice are preserved.
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+Texts.  A copy of the license is included in the section entitled
+``GNU Free Documentation License''.
 @end quotation
 @end copying
 
@@ -69,6 +72,7 @@ copyright notice and this permission notice are preserved.
 * Hosting::
 * Free Software Directory::
 * Using the Proofreaders List::
+* GNU Free Documentation License::
 * Index::
 @end menu
 
@@ -196,7 +200,7 @@ GPL-covered status in court if necessary.
 @strong{Before} incorporating significant changes, make sure that the
 person who wrote the changes has signed copyright papers and that the
 Free Software Foundation has received and signed them.  We may also need
-a disclaimer from the person's employer.
+an employer's disclaimer from the person's employer.
 
 @cindex data base of GNU copyright assignments
 To check whether papers have been received, look in
@@ -216,7 +220,7 @@ for accounts for people who help you a large amount in working on the
 package.)
 
 In order for the contributor to know person should sign papers, you need
-to ask for the necessary papers.  If you don't know per well, and you
+to ask per for the necessary papers.  If you don't know per well, and you
 don't know that person is used to our ways of handling copyright papers,
 then it might be a good idea to raise the subject with a message like
 this:
@@ -257,8 +261,8 @@ copy of the file @file{request-assign.changes}.  (Like all the
 @samp{request-} files, it is in @file{/gd/gnuorg/Copyright} and in
 @code{gnulib}.)
 
-For medium to small changes, request a disclaimer by sending per the
-file @file{request-disclaim.changes}.
+For medium to small changes, request a personal disclaimer by sending
+per the file @file{request-disclaim.changes}.
 
 If the contributor is likely to keep making changes, person might want
 to sign an assignment for all per future changes to the program.  So it
@@ -269,7 +273,7 @@ When you send a @file{request-} file, you don't need to fill in anything
 before sending it.  Just send the file verbatim to the contributor.  The
 file gives per instructions for how to ask the FSF to mail per the
 papers to sign.  The @file{request-} file also raises the issue of
-getting a copyright disclaimer from the contributor's employer.
+getting an employer's disclaimer from the contributor's employer.
 
 When the contributor emails the form to the FSF, the FSF sends per
 papers to sign.  If person signs them right away, the whole process
@@ -296,6 +300,16 @@ manual.  For smaller changes, use
 changes to a manual, you can use @file{assign.future.manual}.
 For a translation of a manual, use @file{assign.translation.manual}.
 
+For translations of program strings (as used by GNU Gettext, for
+example; @pxref{Internationalization,,,standards,GNU Coding
+Standards}), use @file{disclaim.translation}.  If you make use of the
+Translation Project (@url{http://translationproject.org}) facilities,
+please check with the TP coordinators that they have sent the
+contributor the papers; if they haven't, then you should send the
+papers.  In any case, you should wait for the confirmation from the
+FSF that the signed papers have been received and accepted before
+integrating the new contributor's material, as usual.
 If a contributor is reluctant to sign an assignment for a large change,
 and is willing to sign a disclaimer instead, that is acceptable, so you
 should offer this alternative if it helps you reach agreement.  We
@@ -336,8 +350,8 @@ and we will work with a lawyer to decide what to do.}
 @section Legally Significant Changes
 
 If a person contributes more than around 15 lines of code and/or text
-that is legally significant for copyright purposes, which means we
-need copyright papers for it as described above.
+that is legally significant for copyright purposes, we
+need copyright papers for that contribution, as described above.
 
 A change of just a few lines (less than 15 or so) is not legally
 significant for copyright.  A regular series of repeated changes, such
@@ -377,9 +391,9 @@ had contributed code, and we might have to track them down and ask
 them.
 
 When you record a small patch in a change log file, first search for
-previous changes by the same person, and see if his past
+previous changes by the same person, and see if per past
 contributions, plus the new one, add up to something legally
-significant.  If so, you should get copyright papers for all his
+significant.  If so, you should get copyright papers for all per
 changes before you install the new change.
 
 If that is not so, you can install the small patch.  Write @samp{(tiny
@@ -394,9 +408,9 @@ change)} after the patch author's name, like this:
 @cindex recording contributors
 
 @strong{Keep correct records of which portions were written by whom.}
-This is very important.  These records should say which files
-parts of files, were written by each person, and which files or
-portions were revised by each person.  This should include
+This is very important.  These records should say which files or
+parts of files were written by each person, and which files or
+parts of files were revised by each person.  This should include
 installation scripts as well as manuals and documentation
 files---everything.
 
@@ -535,23 +549,23 @@ To update the list of year numbers, add each year in which you have
 made nontrivial changes to the package.  (Here we assume you're using
 a publicly accessible revision control server, so that every revision
 installed is also immediately and automatically published.)  When you
-add the new year, it is not required to keep track which files have
+add the new year, it is not required to keep track of which files have
 seen significant changes in the new year and which have not.  It is
 recommended and simpler to add the new year to all files in the
 package, and be done with it for the rest of the year.
 
-For files which are regularly copied from another project (such as
-@samp{gnulib}), the copyright notice should left as it is in the
-original.
-
-Don't delete old year numbers, though; they can indicate when older
-versions might theoretically go into the public domain.  If you copy a
-file into the package from some other program, keep the copyright
-years that come with the file.
+Don't delete old year numbers, though; they are significant since they
+indicate when older versions might theoretically go into the public
+domain, if the movie companies don't continue buying laws to further
+extend copyright.  If you copy a file into the package from some other
+program, keep the copyright years that come with the file.
 
 Do not abbreviate the year list using a range; for instance, do not
 write @samp{1996--1998}; instead, write @samp{1996, 1997, 1998}.
 
+For files which are regularly copied from another project (such as
+@samp{gnulib}), leave the copyright notice as it is in the original.
+
 The copyright statement may be split across multiple lines, both in
 source files and in any generated output.  This often happens for
 files with a long history, having many different years of
@@ -599,6 +613,9 @@ files distributed under the Lesser GPL, it should contain a full copy
 of that as well (conventionally in a file named
 @file{COPYING.LESSER}).
 
+If you have questions about license issues for your GNU package,
+please write @email{licensing@@gnu.org}.
+
 @menu
 * Source: Canonical License Sources.
 * Code: License Notices for Code.
@@ -686,13 +703,13 @@ Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.2 or
 any later version published by the Free Software Foundation; with the
 Invariant Sections being ``GNU General Public License'', with the
-Front-Cover Texts being ``A GNU Manual,'' and with the Back-Cover Texts
+Front-Cover Texts being ``A GNU Manual'', and with the Back-Cover Texts
 as in (a) below.  A copy of the license is included in the section
 entitled ``GNU Free Documentation License''.
 
-(a) The FSF's Back-Cover Text is: ``You are free to copy and modify
-this GNU Manual.  Buying copies from GNU Press supports the FSF in
-developing GNU and promoting software freedom.''
+(a) The FSF's Back-Cover Text is: ``You have the freedom to
+copy and modify this GNU manual.  Buying copies from the FSF
+supports it in developing GNU and promoting software freedom.''
 @end smallexample
 
 If the FSF does not publish this manual on paper, then omit the last
@@ -741,9 +758,6 @@ used (hence distributed) by third-party packages under possibly
 incompatible licenses, you may also use the above all-permissive
 license for these macros.
 
-If you would like help with license issues or with using the GFDL,
-please contact @email{licensing@@gnu.org}.
-
 
 @node External Libraries
 @section External Libraries
@@ -1153,6 +1167,9 @@ In order to upload new releases to @code{ftp.gnu.org} or
 information.  Then, you can perform uploads yourself, with no
 intervention needed by the system administrators.
 
+The general idea is that releases should be crytographically signed
+before they are made publicly available.
+
 @menu
 * Automated Upload Registration::
 * Automated Upload Procedure::
@@ -1167,9 +1184,26 @@ intervention needed by the system administrators.
 @cindex registration
 @cindex uploads, registration for
 
-To register your information to perform automated uploads, send a
-message, preferably GPG-signed, to @email{ftp-upload@@gnu.org} with
-the following:
+Here is how to register your information so you can perform uploads
+for your GNU package:
+
+@enumerate
+
+@item
+Create an account for yourself at @url{http://savannah.gnu.org}, if
+you don't already have one.  By the way, this is also needed to
+maintain the web pages at @url{www.gnu.org} for your project
+(@pxref{Web Pages}).
+
+@item
+In the @samp{My Account Conf} page on @code{savannah}, upload the GPG
+key you will use to sign your packages.  You can create a key with the
+command @code{gpg --gen-key}.  (For full information about GPG, see
+@url{http://www.gnu.org/software/gpg}).
+
+@item
+Send a message, preferably GPG-signed, to @email{ftp-upload@@gnu.org}
+with the following:
 
 @enumerate
 @item
@@ -1177,8 +1211,8 @@ Name of package(s) that you are the maintainer for, and your
 preferred email address.
 
 @item
-An ASCII armored copy of your GnuPG key, as an attachment.
-(@samp{gpg --export -a YOUR_KEY_ID >mykey.asc} should give you this.)
+An ASCII armored copy of your GnuPG key, as an attachment.  (@samp{gpg
+--export -a @var{your_key_id} >mykey.asc} should give you this.)
 
 @item
 A list of names and preferred email addresses of other individuals you
@@ -1188,6 +1222,7 @@ don't make all releases yourself).
 @item
 ASCII armored copies of GnuPG keys for any individuals listed in (3).
 @end enumerate
+@end enumerate
 
 The administrators will acknowledge your message when they have added
 the proper GPG keys as authorized to upload files for the
@@ -1394,15 +1429,15 @@ your package (in the example above, that is @code{bar}).
 @node Announcements
 @section Announcing Releases
 
-When you have a new release, please make an announcement.  You can
-maintain your own mailing list for announcements if you like, or you can
-use the moderated general GNU announcements list,
-@email{info-gnu@@gnu.org}.
+When you have a new release, please make an announcement.  For
+official new releases, including those made just to fix bugs, we
+recommend using the (moderated) general GNU announcements list,
+@email{info-gnu@@gnu.org}.  Doing so makes it easier for users and
+developers to find the latest GNU releases.
 
-If you use your own list, you can decide as you see fit what events are
-worth announcing.  If you use @email{info-gnu@@gnu.org}, please do not
-announce pretest releases, only real releases.  But real releases do
-include releases made just to fix bugs.
+You can maintain your own mailing list for announcements as well if
+you like.  For your own list, you can decide as you see fit what
+events are worth announcing.
 
 
 @node Web Pages
@@ -1682,7 +1717,7 @@ different movements which differ in their basic philosophy.  The Free
 Software Movement is idealistic, and raises issues of freedom, ethics,
 principle and what makes for a good society.  The Open Source Movement,
 founded in 1998, studiously avoids such questions.  For more explanation,
-see @url{http://www.gnu.org/philosophy/free-software-for-freedom.html}.
+see @url{http://www.gnu.org/philosophy/open-source-misses-the-point.html}.
 
 The GNU Project is aligned with the Free Software Movement.  This
 doesn't mean that all GNU contributors and maintainers have to agree;
@@ -1693,7 +1728,7 @@ However, due to the much greater publicity that the Open Source
 Movement receives, the GNU Project needs to overcome a widespread
 mistaken impression that GNU is @emph{and always was} an activity of
 the Open Source Movement.  For this reason, please use the term ``free
-software,'' not ``open source,'' in GNU software releases, GNU
+software'', not ``open source'', in GNU software releases, GNU
 documentation, and announcements and articles that you publish in your
 role as the maintainer of a GNU package.  A reference to the URL given
 above, to explain the difference, is a useful thing to include as
@@ -1727,7 +1762,7 @@ role as the maintainer of a GNU package.  If you want to explain the
 terminology and its reasons, you can refer to the URL
 @url{http://www.gnu.org/gnu/linux-and-gnu.html}.
 
-Do contrast the GNU system properly speaking to GNU/Linux, you can
+To contrast the GNU system properly with respect to GNU/Linux, you can
 call it ``GNU/Hurd'' or ``the GNU/Hurd system.''  However, when that
 contrast is not specifically the focus, please call it just ``GNU'' or
 ``the GNU system.''
@@ -1741,15 +1776,20 @@ Note that this uses a space, not a slash.
 @chapter Hosting
 @cindex CVS repository
 @cindex repository
+@cindex source repository
+@cindex version control system
 @cindex FTP site
 @cindex hosting
 
-We would like to recommend using @code{subversions.gnu.org} as the CVS
-repository for your package, and using @code{ftp.gnu.org} as the
-standard FTP site.  It is ok to use other machines if you wish.  If you
-use a company's machine to hold the repository for your program, or as
-its ftp site, please put this statement in a prominent place on the
-site, so as to prevent people from getting the wrong idea about the
+We recommend using @code{savannah.gnu.org} for the source code
+repository for your package, and, even more so, using
+@code{ftp.gnu.org} as the standard distribution site.  Doing so makes
+it easier for developers and users to find the latest GNU releases.
+
+However, it is ok to use other machines if you wish.  If you use a
+company's machine to hold the repository for your program, or as its
+ftp site, please put this statement in a prominent place on the site,
+so as to prevent people from getting the wrong idea about the
 relationship between the package and the company:
 
 @smallexample
@@ -1838,6 +1878,13 @@ When you get enough volunteers, send another message to the list saying
 @end itemize
 
 
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+
+@cindex FDL, GNU Free Documentation License
+@include fdl.texi
+
+
 @node Index
 @unnumbered Index
 @printindex cp