\input texinfo.tex @c -*-texinfo-*-
@c %**start of header
@setfilename maintain.info
-@settitle Information For Maintainers of GNU Software
+@settitle Information for Maintainers of GNU Software
@c For double-sided printing, uncomment:
@c @setchapternewpage odd
@c This date is automagically updated when you save this file:
-@set lastupdate October 9, 2006
+@set lastupdate March 25, 2010
@c %**end of header
@dircategory GNU organization
@c Put everything in one index (arbitrarily chosen to be the concept index).
@syncodeindex fn cp
-@syncodeindex ky cp
@syncodeindex pg cp
-@syncodeindex vr cp
@copying
Information for maintainers of GNU software, last updated @value{lastupdate}.
-Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
-2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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.3 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
@titlepage
-@title Information For Maintainers of GNU Software
+@title Information for Maintainers of GNU Software
@author Richard Stallman
@author last updated @value{lastupdate}
@page
* Hosting::
* Free Software Directory::
* Using the Proofreaders List::
+* GNU Free Documentation License::
* Index::
@end menu
+
@node Preface
@chapter About This Document
entitled to change and redistribute GNU software; you need not pay
attention to this file to get permission. But if you want to maintain a
version for widespread distribution, we suggest you follow these
-guidelines; if you would like to be a GNU maintainer, then it is
+guidelines. If you would like to be a GNU maintainer, then it is
essential to follow these guidelines.
-Please send corrections or suggestions for this document to
-@email{maintainers@@gnu.org}. If you make a suggestion, please include
-a suggested new wording for it, to help us consider the suggestion
-efficiently. We prefer a context diff to the @file{maintain.texi} file,
-but if you don't have that file, you can make a context diff for some
-other version of this document, or propose it in any way that makes it
-clear.
+In addition to this document, please read and follow the GNU Coding
+Standards (@pxref{Top, , Contents, standards, GNU Coding Standards}).
+@cindex @code{gnustandards-commit@@gnu.org} mailing list
+If you want to receive diffs for every change to these GNU documents,
+join the mailing list @code{gnustandards-commit@@gnu.org}, via the web
+interface at
+@url{http://lists.gnu.org/mailman/listinfo/gnustandards-commit}.
+Archives are also available there.
+
+@cindex @code{bug-standards@@gnu.org} email address
+@cindex Savannah repository for gnustandards
+@cindex gnustandards project repository
+Please send corrections or suggestions for this document to
+@email{bug-standards@@gnu.org}. If you make a suggestion, please
+include a suggested new wording for it, to help us consider the
+suggestion efficiently. We prefer a context diff to the Texinfo
+source, but if that's difficult for you, you can make a context diff
+for some other version of this document, or propose it in any way that
+makes it clear. The source repository for this document can be found
+at @url{http://savannah.gnu.org/projects/gnustandards}.
+
+@cindex @code{mentors@@gnu.org} mailing list
+If you have general questions or encounter a situation where it isn't
+clear what to do, you can ask @email{mentors@@gnu.org}, which is a
+list of a few experienced GNU contributors who have offered to answer
+questions for new maintainers.
+
+The directory @file{/gd/gnuorg} mentioned throughout this document is
+found on the GNU file server, currently @code{fencepost.gnu.org}; if
+you are the maintainer of a GNU package, you should have an account
+there. See @url{http://www.gnu.org/software/README.accounts.html} if
+you don't have one. (You can also ask for accounts for people who
+help you a large amount in working on the package.)
+
+If on occasion you find that any GNU computer systems
+(@code{fencepost.gnu.org}, @code{ftp.gnu.org},
+@code{savannah.gnu.org}, or others) seem to be down, you can check the
+current status at @url{http://identi.ca/group/fsfstatus}. Most likely
+the problem, if it is at the FSF end, is already being worked on.
+
+@cindex Piercy, Marge
This document uses the gender-neutral third-person pronouns ``person'',
``per'', ``pers'' and ``perself'' which were promoted, and perhaps
invented, by Marge Piercy in @cite{Woman on the Edge of Time}. They are
per new program under the GNU GPL, to let the public benefit from per
work, and to enable per to feel person has done the right thing.''
-The directory @file{/gd/gnuorg} is found on the GNU file server,
-currently @code{fencepost.gnu.org}; if you are the maintainer of a GNU
-package, you should have an account there. Contact
-@email{accounts@@gnu.org} if you don't have one. (You can also ask
-for accounts for people who help you a large amount in working on the
-package.) @file{/gd/gnuorg/maintain.tar.gz} is a tar file containing
-all of these files in that directory which are mentioned in this file;
-it is updated daily.
-
This release of the GNU Maintenance Instructions was last updated
@value{lastupdate}.
+
@node Stepping Down
@chapter Stepping Down
a person is capable of doing the job will carry a lot of weight.
As your final act as maintainer, it would be helpful to set up the
-package under @code{savannah.gnu.org} (@pxref{Old Versions}). This will
-make it much easier for the new maintainer to pick up where you left off
-and will ensure that the CVS tree is not misplaced if it takes us a
-while to find a new maintainer.
+package under @code{savannah.gnu.org} if it is not there already
+(@pxref{Old Versions}). This will make it much easier for the new
+maintainer to pick up where you left off and will ensure that the
+source tree is not misplaced if it takes us a while to find a new
+maintainer.
+
@node Recruiting Developers
@chapter Recruiting Developers
some of your developers as co-maintainers, please contact
@email{maintainers@@gnu.org}.
+We're happy to acknowledge all major contributors to GNU packages on
+the @url{http://www.gnu.org/people/people.html} web page. Please send
+an entry for yourself to @email{webmasters@@gnu.org}, and feel free to
+suggest it to other significant developers on your package.
+
+
@node Legal Matters
@chapter Legal Matters
@cindex legal matters
@menu
* Copyright Papers::
* Legally Significant::
-* Recording Contributors::
+* Recording Contributors::
* Copying from Other Packages::
-* Copyright Notices::
-* License Notices::
-* External Libraries::
+* Copyright Notices::
+* License Notices::
+* External Libraries::
@end menu
@node Copyright Papers
@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
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:
@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
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
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
@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
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
@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.
you did was copy it, not write it, then for copyright purposes you are
@emph{not} one of the contributors of @emph{this} code.
+Especially when code has been released into the public domain, authors
+sometimes fail to write a license statement in each file. In this
+case, please first be sure that all the authors of the code have
+disclaimed copyright interest. Then, when copying the new files into
+your project, add a brief note at the beginning of the files recording
+the authors, the public domain status, and anything else relevant.
+
+On the other hand, when merging some public domain code into an
+existing file covered by the GPL (or LGPL or other free software
+license), there is no reason to indicate the pieces which are public
+domain. The notice saying that the whole file is under the GPL (or
+other license) is legally sufficient.
+
+Using code that is released under a GPL-compatible free license,
+rather than being in the public domain, may require preserving
+copyright notices or other steps. Of course, you should do what is
+needed.
+
If you are maintaining an FSF-copyrighted package, please verify we
have papers for the code you are copying, @emph{before} copying it.
If you are copying from another FSF-copyrighted package, then we
for the code, you can only use it as an external library
(@pxref{External Libraries}).
+
@node Copyright Notices
@section Copyright Notices
@cindex copyright notices in program files
that it is in the public domain.
Even image files and sound files should contain copyright notices and
-license notices, if they can. Some formats do not have room for textual
-annotations; for these files, state the copyright and copying
-permissions in a README file in the same directory.
+license notices, if their format permits. Some formats do not have
+room for textual annotations; for these files, state the copyright and
+copying permissions in a @file{README} file in the same directory.
Change log files should have a copyright notice and license notice at
the end, since new material is added at the beginning but the end
A copyright notice looks like this:
@example
-Copyright (C) @var{year1}, @var{year2}, @var{year3} @var{copyright-holder}
+Copyright (C) @var{year1}, @var{year2}, @var{year3} @var{copyright-holder}
@end example
+The word @samp{Copyright} must always be in English, by international
+convention.
+
The @var{copyright-holder} may be the Free Software Foundation, Inc., or
someone else; you should know who is the copyright holder for your
package.
will work. For example, a program's standard @option{--version}
message should use parenthesized @samp{C} by default, though message
translations may use C-in-a-circle in locales where that symbol is
-known to work.
+known to work. Alternatively, the @samp{(C)} or C-in-a-circle can be
+omitted entirely; the word @samp{Copyright} suffices.
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
@cindex license notices in program files
Every nontrivial file needs a license notice as well as the copyright
-notice. (Without a license notice giving permission to copy and change
-the file
-would make the file non-free.)
+notice. (Without a license notice giving permission to copy and
+change the file, the file is non-free.)
-The package itself should contain a full copy of GPL (conventionally in
-a file named @file{COPYING}) and the GNU Free Documentation License
-(included within your documentation). If the package contains any files
-distributed under the Lesser GPL, it should contain a full copy of that
-as well (conventionally in a file named @file{COPYING.LIB}).
+The package itself should contain a full copy of GPL in plain text
+(conventionally in a file named @file{COPYING}) and the GNU Free
+Documentation License (included within your documentation, so there is
+no need for a separate plain text version). If the package contains
+any files distributed under the Lesser GPL, it should contain a full
+copy of its plain text version also (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.
+* Documentation: License Notices for Documentation.
+* Other: License Notices for Other Files.
+@end menu
-You can get the official versions of these files from three places.
+
+@node Canonical License Sources
+@subsection Canonical License Sources
+
+You can get the official versions of these files from several places.
You can use whichever is the most convenient for you.
@itemize @bullet
@uref{http://www.gnu.org/licenses/}.
@item
-The directory @file{/gd/gnuorg} on the host
-@code{fencepost.gnu.org}. (You can ask @email{accounts@@gnu.org}
-for an account there if you don't have one).
-
-@item
The @code{gnulib} project on @code{savannah.gnu.org}, which you
-can access via anonymous CVS. See
+can access via anonymous Git or CVS. See
@uref{http://savannah.gnu.org/projects/gnulib}.
@end itemize
The official Texinfo sources for the licenses are also available in
those same places, so you can include them in your documentation. A
-GFDL-covered manual must include the GFDL in this way. @xref{GNU Sample
-Texts,,,texinfo,Texinfo}, for a full example in a Texinfo manual.
+GFDL-covered manual should include the GFDL in this way. @xref{GNU
+Sample Texts,,,texinfo,Texinfo}, for a full example in a Texinfo
+manual.
+
+
+@node License Notices for Code
+@subsection License Notices for Code
Typically the license notice for program files (including build scripts,
configure files and makefiles) should cite the GPL, like this:
@quotation
-This file is part of GNU @var{program}
+This file is part of GNU @var{program}.
-GNU @var{program} is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2, or (at your option)
-any later version.
+GNU @var{program} is free software: you can redistribute it and/or
+modify it under the terms of the GNU General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
GNU @var{program} is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
-along with @var{program}; see the file COPYING. If not, write to
-the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA.
+along with this program. If not, see @url{http://www.gnu.org/licenses/}.
@end quotation
But in a small program which is just a few files, you can use
this instead:
@quotation
-This program is free software; you can redistribute it and/or modify
+This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
+the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
-You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+You should have received a copy of the GNU General Public License
+along with this program. If not, see @url{http://www.gnu.org/licenses/}.
@end quotation
+
+@node License Notices for Documentation
+@subsection License Notices for Documentation
+
Documentation files should have license notices also. Manuals should
-use the GNU Free Documentation License. Here is an example of the
-license notice to use after the copyright notice. Please adjust the
-list of invariant sections as appropriate for your manual. (If there
-are none, then say ``with no invariant sections''.) @xref{GNU Sample
-Texts,,,texinfo,Texinfo}, for a full example in a Texinfo manual.
+use the GNU Free Documentation License. Following is an example of the
+license notice to use after the copyright line(s) using all the
+features of the GFDL.
@smallexample
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
+under the terms of the GNU Free Documentation License, Version 1.3 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
+Invariant Sections being ``GNU General Public License'', with the
+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.''
+entitled ``GNU Free Documentation License''.
+(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
not the copyright holder, then replace @samp{FSF} with the appropriate
name.
-See @url{http://www.gnu.org/licenses/fdl-howto.html} for more advice
-about how to use the GNU FDL.
+Please adjust the list of invariant sections as appropriate for your
+manual. If there are none, then say ``with no Invariant Sections''.
+If your manual is not published by the FSF, and under 400 pages, you
+can omit both cover texts.
+
+@xref{GNU Sample Texts,,,texinfo,Texinfo}, for a full example in a
+Texinfo manual, and see
+@url{http://www.gnu.org/licenses/fdl-howto.html} for more advice about
+how to use the GNU FDL.
+
+If the manual is over 400 pages, or if the FSF thinks it might be a
+good choice for publishing on paper, then please include the GNU GPL,
+as in the notice above. Please also include our standard invariant
+section which explains the importance of free documentation. Write to
+@email{assign@@gnu.org} to get a copy of this section.
-If the manual is over 400 pages, or if the FSF thinks it might be a good
-choice for publishing on paper, then please include our standard
-invariant section which explains the importance of free documentation.
-Write to @email{assign@@gnu.org} to get a copy of this section.
+When you distribute several manuals together in one software package,
+their on-line forms can share a single copy of the GFDL (see
+section@tie{}6). However, the printed (@samp{.dvi}, @samp{.pdf},
+@dots{}) forms should each contain a copy of the GFDL, unless they are
+set up to be printed and published only together. Therefore, it is
+usually simplest to include the GFDL in each manual.
-Note that when you distribute several manuals together in one software
-package, their on-line forms can share a single copy of the GFDL (see
-section 6). However, the printed (@samp{.dvi}) forms should each
-contain a copy of the GFDL, unless they are set up to be printed
-and published only together. Therefore, it is usually simplest to
-include the GFDL in each manual.
+
+@node License Notices for Other Files
+@subsection License Notices for Other Files
Small supporting files, short manuals (under 300 lines long) and rough
-documentation (README files, INSTALL files, etc) can use a simple
-all-permissive license like this one:
+documentation (@file{README} files, @file{INSTALL} files, etc.)@: can
+use a simple all-permissive license like this one:
@smallexample
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
-notice and this notice are preserved.
+notice and this notice are preserved. This file is offered as-is,
+without any warranty.
@end smallexample
+Older versions of this license did not have the second sentence with
+the express warranty disclaimer. There is no urgent need to update
+existing files, but new files should use the new text.
+
If your package distributes Autoconf macros that are intended to be
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
programs and released separately for general use. For anything that was
written as a contribution to your package, please get papers signed.
+
@node Clean Ups
@chapter Cleaning Up Changes
@cindex contributions, accepting
The GNU Coding Standards are a good thing to send people when you ask
them to clean up changes (@pxref{Top, , Contents, standards, GNU Coding
Standards}). The Emacs Lisp manual contains an appendix that gives
-coding standards for Emacs Lisp programs; it is good to urge authors to
-read it (@pxref{Tips, , Tips and Standards, elisp, The GNU Emacs Lisp
+coding standards for Emacs Lisp programs; it is good to urge Lisp authors to
+read it (@pxref{Tips, , Tips and Conventions, elisp, The GNU Emacs Lisp
Reference Manual}).
+
@node Platforms
@chapter Platforms to Support
nowadays we want to give each program its own bug-reporting list and
move away from using @email{bug-gnu-utils}.
+If you wish, you can also have mailing lists such as
+@samp{info-@var{program}} for announcements (@pxref{Announcements}),
+@samp{help-@var{program}} for general help and discussion (see below),
+or any others you find useful.
+
+By far the easiest way to create mailing lists is through
+@code{savannah.gnu.org}. Once you register your program, you can do
+this yourself through the `Mailing Lists' menu, without needing
+intervention by anyone else. Furthermore, lists created through
+Savannah will have a reasonable default configuration for antispam
+purposes (see below).
+
If you are the maintainer of a GNU package, you should have an account
-on the GNU servers; contact @email{accounts@@gnu.org} if you don't have
-one. (You can also ask for accounts for people who help you a large
-amount in working on the package.) With this account, you can edit
-@file{/com/mailer/aliases} to create a new unmanaged list or add
-yourself to an existing unmanaged list. A comment near the beginning of
-that file explains how to create a Mailman-managed mailing list.
+on the GNU servers; contact
+@url{http://www.gnu.org/software/README.accounts.html} if you don't
+have one. (You can also ask for accounts for people who help you a
+large amount in working on the package.) With this account, you can
+edit @file{/com/mailer/aliases} to create a new unmanaged list or add
+yourself to an existing unmanaged list. A comment near the beginning
+of that file explains how to create a Mailman-managed mailing list.
But if you don't want to learn how to do those things, you can
alternatively ask @email{alias-file@@gnu.org} to add you to the
make bug reports useful. If you want to copy and adapt that, it could
be a very useful thing to do.
+
@node Old Versions
@chapter Recording Old Versions
@cindex version control
It is very important to keep backup files of all source files of GNU.
-You can do this using RCS, CVS or PRCS if you like. The easiest way to
-use RCS or CVS is via the Version Control library in Emacs;
-@ref{VC Concepts,, Concepts of Version Control, emacs, The GNU Emacs
-Manual}.
+You can do this using a source control system (such as RCS, CVS, Git,
+@dots{}) if you like. The easiest way to use RCS or CVS is via the
+Version Control library in Emacs (@pxref{VC Concepts,, Concepts of
+Version Control, emacs, The GNU Emacs Manual}).
The history of previous revisions and log entries is very important for
future maintainers of the package, so even if you do not make it
change log that you would not want to hand over to another maintainer
some day.
-The GNU Project provides a CVS server that GNU software packages can
-use: @code{subversions.gnu.org}. (The name refers to the multiple
-versions and their subversions that are stored in a CVS repository.)
+@cindex @code{savannah-hackers@@gnu.org}
+The GNU Project provides a server that GNU software packages can use
+for source control and other package needs: @code{savannah.gnu.org}.
You don't have to use this repository, but if you plan to allow public
read-only access to your development sources, it is convenient for
-people to be able to find various GNU packages in a central place. The
-CVS Server is managed by @email{cvs-hackers@@gnu.org}.
-
-The GNU project also provides additional developer resources on
-@code{subversions.gnu.org} through its @code{savannah.gnu.org}
-interface. All GNU maintainers are encouraged to take advantage of
-these facilities, as @code{savannah} can serve to foster a sense of
-community among all GNU developers and help in keeping up with project
+people to be able to find various GNU packages in a central place.
+Savannah is managed by @email{savannah-hackers@@gnu.org}.
+
+All GNU maintainers are strongly encouraged to take advantage of
+Savannah, as sharing such a central point can serve to foster a sense
+of community among GNU developers and help in keeping up with project
management.
+@cindex @code{savannah-announce@@gnu.org} mailing list
+If you do use Savannah, it is a good idea to subscribe to the
+@email{savannah-announce@@gnu.org} mailing list
+(@url{http://lists.gnu.org/mailman/listinfo/savannah-announce}). This
+is a very low-volume list to keep Savannah users informed of system
+upgrades, problems, and the like.
+
+
@node Distributions
@chapter Distributions
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::
@node Automated Upload Registration
@subsection Automated Upload Registration
-@cindex registration
+@cindex registration for uploads
@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}. It is
+good to also send your key to the GPG public key server: @code{gpg
+--keyserver keys.gnupg.net --send-keys @var{keyid}}, where @var{keyid}
+is the eight hex digits reported by @code{gpg --list-public-keys} on
+the @code{pub} line before the date. For full information about GPG,
+see @url{http://www.gnu.org/software/gpg})
+
+@item
+Compose a message with the following items in some @var{msgfile}.
+Then GPG-sign it by running @code{gpg --clearsign @var{msgfile}}, and
+finally email the resulting @file{@var{msgfile}.asc}), to
+@email{ftp-upload@@gnu.org}.
@enumerate
@item
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
@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
corresponding packages.
+The upload system will email receipts to the given email addresses
+when an upload is made, either successfully or unsuccessfully.
+
@node Automated Upload Procedure
@subsection Automated Upload Procedure
@cindex uploads
-Once you have registered your information as described in the
-previous section, you will be able to do unattended ftp uploads using
-the following procedure.
+Once you have registered your information as described in the previous
+section, you will be able to do ftp uploads for yourself using the
+following procedure.
For each upload destined for @code{ftp.gnu.org} or
@code{alpha.gnu.org}, three files (a @dfn{triplet}) need to be
@enumerate
@item
-The file to be distributed (for example, @file{foo.tar.gz}).
+The file to be distributed; for example, @file{foo.tar.gz}.
@item
-Detached GPG binary signature for (1), made using @samp{gpg -b}
-(for example, @file{foo.tar.gz.sig}).
+Detached GPG binary signature file for (1); for example,
+@file{foo.tar.gz.sig}. Make this with @samp{gpg -b foo.tar.gz}.
+
@item
-A clearsigned @dfn{directive file}, made using @samp{gpg --clearsign}
-(for example, @file{foo.tar.gz.directive.asc}).
+A clearsigned @dfn{directive file}; for example,
+@file{foo.tar.gz.directive.asc}. Make this by preparing the plain
+text file @file{foo.tar.gz.directive} and then run @samp{gpg
+--clearsign foo.tar.gz.directive}. @xref{FTP Upload Directive File -
+v1.1}, for the contents of the directive file.
@end enumerate
The names of the files are important. The signature file must have the
same name as the file to be distributed, with an additional
@file{.sig} extension. The directive file must have the same name as
-the file to be distributed, with an additional @file{.directive.asc
-extension}. If you do not follow this naming convention, the upload
+the file to be distributed, with an additional @file{.directive.asc}
+extension. If you do not follow this naming convention, the upload
@emph{will not be processed}.
Since v1.1 of the upload script, it is also possible to upload a
-@dfn{directive file} on its own to perform certain operations on
-uploaded files. @xref{FTP Upload Directive File - v1.1}, for more
-information.
+clearsigned directive file on its own (no accompanying @file{.sig} or
+any other file) to perform certain operations on the server.
+@xref{FTP Upload Directive File - v1.1}, for more information.
Upload the file(s) via anonymous ftp to @code{ftp-upload.gnu.org}. If
the upload is destined for @code{ftp.gnu.org}, place the file(s) in
@code{alpha.gnu.org}, place the file(s) in the @file{/incoming/alpha}
directory.
-Uploads are processed every five minutes. Uploads that are in progress while
-the upload processing script is running are handled properly, so do not worry
-about the timing of your upload.
+Uploads are processed every five minutes. Uploads that are in
+progress while the upload processing script is running are handled
+properly, so do not worry about the timing of your upload. Uploaded
+files that belong to an incomplete triplet are deleted automatically
+after 24 hours.
Your designated upload email addresses (@pxref{Automated Upload Registration})
are sent a message if there are any problems processing an upload for your
package. You also receive a message when your upload has been successfully
processed.
-If you have difficulties processing an upload, email
+One automated way to create and transfer the necessary files is to use
+the @code{gnupload} script, which is available from the
+@file{build-aux/} directory of the @code{gnulib} project at
+@url{http://savannah.gnu.org/projects/gnulib}. @code{gnupload} can
+also remove uploaded files. Run @code{gnupload --help} for a
+description and examples.
+
+@code{gnupload} uses the @code{ncftpput} program to do the actual
+transfers; if you don't happen to have the @code{ncftp} package
+installed, the @code{ncftpput-ftp} script in the @file{build-aux/}
+directory of @code{gnulib} serves as a replacement which uses plain
+command line @code{ftp}.
+
+If you have difficulties with an upload, email
@email{ftp-upload@@gnu.org}.
of the directives @code{symlink}, @code{rmsymlink} or @code{archive},
in addition to the obligatory @code{directory} and @code{version}
directives. A @code{filename} directive is not allowed, and a
-@code{comment} directive is optional.
+@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:
version: 1.1
directory: bar/v1
archive: foo-1.1.tar.gz
-comment: archive an old file - it will not be available through FTP anymore
+comment: archive an old file; it will not be available through FTP anymore
+@end example
+
+@noindent
+Archive an old directory (with all contents), taking it offline:
+
+@example
+version: 1.1
+directory: bar/v1
+archive: foo
+comment: archive an old directory; it will not be available through FTP anymore
@end example
@noindent
@node Announcements
@section Announcing Releases
+@cindex announcements
+
+@cindex @code{info-gnu} mailing list
+When you have a new release, please make an announcement. For
+official new releases, including those made just to fix bugs, we
+strongly 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. On the other hand,
+please do not announce test releases on @code{info-gnu} unless it's a
+highly unusual situation.
+
+@cindex @url{http://planet.gnu.org}
+@cindex Savannah, news area
+Please also post release announcements in the news section of your
+Savannah project site. It is fine to also write news entries for test
+releases and any other newsworthy events. The news feeds from all GNU
+projects at savannah are aggregated at @url{http://planet.gnu.org}
+(GNU Planet). You can also post items directly, or arrange for feeds
+from other locations; see contact information on the GNU Planet web
+page.
+
+@cindex announcement mailing list, project-specific
+You can maintain your own mailing list (typically
+@email{info-@var{program}@@gnu.org}) for announcements as well if you
+like. For your own list, of course you decide as you see fit what
+events are worth announcing. (@xref{Mail}, for more suggestions on
+handling mail for your package.)
+
+@cindex contents of announcements
+When writing an announcement, please include the following:
-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}.
+@itemize @bullet
+@item
+A very brief description (a few sentences at most) of the general
+purpose of your package.
-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.
+@item
+Your package's web page (normally
+@indicateurl{http://www.gnu.org/software/@var{package}/}).
-@node Web Pages
-@chapter Web Pages
-@cindex web pages
+@item
+Your package's download location (normally
+@indicateurl{http://ftp.gnu.org/gnu/@var{package}/}). It is also
+useful to mention the FTP mirror list at
+@url{http://www.gnu.org/order/ftp.html}, and that
+@url{http://ftpmirror.gnu.org/@var{package/}} will automatically
+redirect to a nearby mirror.
-Please write pages about your package for installation on
-@code{www.gnu.org}. The pages should follow our usual standards for web
-pages (see @url{http://www.gnu.org/server}); we chose them in order to
-support a wide variety of browsers, to focus on information rather than
-flashy eye candy, and to keep the site simple and uniform.
+@item
+The NEWS (@pxref{NEWS File,,, standards, GNU Coding Standards}) for
+the present release.
+@end itemize
-The simplest way to maintain the web pages for your project is to
-register the project on @code{savannah.gnu.org}. Then you can edit
-the pages using CVS. You can keep the source files there too, but if
-you want to use @code{savannah.gnu.org} only for the web pages, simply
-register a ``web-only'' project.
-If you don't want to use that method, please talk with
-@email{webmasters@@gnu.org} about other possible methods. For
-instance, you can mail them pages to install, if necessary. But that
-is more work for them, so please use CVS if you can.
+@node Web Pages
+@chapter Web Pages
+@cindex web pages
+
+Please write web pages about your package for installation on
+@code{www.gnu.org}. They should follow our usual standards for web
+pages (see @url{http://www.gnu.org/server/fsf-html-style-sheet.html}).
+The overall goals are to support a wide variety of browsers, to focus
+on information rather than flashy eye candy, and to keep the site
+simple and uniform.
Some GNU packages have just simple web pages, but the more information
you provide, the better. So please write as much as you usefully can,
them up on whatever site is convenient for you, and make the pages on
@code{www.gnu.org} link to that site.
-Web pages for GNU packages should not include GIF images, since the GNU
-project avoids GIFs due to patent problems. @xref{Ethical and
-Philosophical Consideration}.
+@menu
+* Hosting for Web Pages::
+* Freedom for Web Pages::
+* Manuals on Web Pages::
+* CVS Keywords in Web Pages::
+@end menu
+
+@node Hosting for Web Pages
+@section Hosting for Web Pages
+
+The best way to maintain the web pages for your project is to register
+the project on @code{savannah.gnu.org}. Then you can edit the pages
+using CVS, using the separate ``web repository'' available on
+Savannah, which corresponds to
+@indicateurl{http://www.gnu.org/software/@var{package}/}. You can
+keep your source files there too (using any of a variety of version
+control systems), but you can use @code{savannah.gnu.org} only for
+your gnu.org web pages if you wish; simply register a ``web-only''
+project.
+
+If you don't want to use that method, please talk with
+@email{webmasters@@gnu.org} about other possible methods. For
+instance, you can mail them pages to install, if necessary. But that
+is more work for them, so please use Savannah if you can.
+
+If you use Savannah, you can use a special @file{.symlinks} file in
+order to create symbolic links, which are not supported in CVS. For
+details, see
+@url{http://www.gnu.org/server/standards/README.webmastering.html#symlinks}.
+
+
+@node Freedom for Web Pages
+@section Freedom for Web Pages
+
+If you use a site other than @code{www.gnu.org}, please make sure that
+the site runs on free software alone. (It is ok if the site uses
+unreleased custom software, since that is free in a trivial sense:
+there's only one user and it has the four freedoms.) If the web site
+for a GNU package runs on non-free software, the public will see this,
+and it will have the effect of granting legitimacy to the non-free
+program.
+
+If you use multiple sites, they should all follow that criterion.
+Please don't link to a site that is about your package, which the
+public might perceive as connected with it and reflecting the position
+of its developers, unless it follows that criterion.
+
+Historically, web pages for GNU packages did not include GIF images,
+because of patent problems (@pxref{Ethical and Philosophical
+Consideration}). Although the GIF patents expired in 2006, using GIF
+images is still not recommended, as the PNG and JPEG formats are
+generally superior. See @url{http://www.gnu.org/philosophy/gif.html}.
+
+
+@node Manuals on Web Pages
+@section Manuals on Web Pages
The web pages for the package should include its manuals, in HTML,
-DVI, Info, PostScript, PDF, plain ASCII, and Texinfo format (source). (All
-of these can be generated automatically from the Texinfo source using
-Makeinfo and other programs.) When there is only one manual, put it
-in a subdirectory called @file{manual}; the file
-@file{manual/index.html} should have a link to the manual in each of
-its forms.
+DVI, Info, PostScript, PDF, plain ASCII, and Texinfo format (source).
+All of these can be generated automatically from the Texinfo source
+using Makeinfo and other programs.
+
+When there is only one manual, put it in a subdirectory called
+@file{manual}; the file @file{manual/index.html} should have a link to
+the manual in each of its forms.
If the package has more than one manual, put each one in a
subdirectory of @file{manual}, set up @file{index.html} in each
See the section below for details on a script to make the job of
creating all these different formats and index pages easier.
-We would like to include links to all these manuals in the page
-@url{http://www.gnu.org/manual}. Just send mail to
-@code{webmasters@@gnu.org} telling them the name of your package and
-asking them to edit @url{http://www.gnu.org/manual}, and they will do
-so based on the contents of your @file{manual} directory.
+We would like to include links to all GNU manuals on the page
+@url{http://www.gnu.org/manual}, so if yours isn't listed, please send
+mail to @code{webmasters@@gnu.org} telling them the name of your
+package and asking them to edit @url{http://www.gnu.org/manual}, and
+they will do so based on the contents of your @file{manual} directory.
@menu
* Invoking gendocs.sh::
-* CVS Keywords in Web Pages::
@end menu
-@node Invoking gendocs.sh
-@section Invoking @command{gendocs.sh}
+
+@node Invoking gendocs.sh
+@subsection Invoking @command{gendocs.sh}
@pindex gendocs.sh
@cindex generating documentation output
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:
-@format
+
+@smallformat
@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}
-@end format
+@end smallformat
+
+There is also a minimalistic template, available from:
+
+@smallformat
+@uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min}
+@end smallformat
Invoke the script like this, in the directory containing the Texinfo
source:
-@example
-gendocs.sh @var{yourmanual} "GNU @var{yourmanual} manual"
-@end example
-@noindent where @var{yourmanual} is the short name for your package.
-The script processes the file @file{@var{yourmanual}.texinfo} (or
-@file{.texi} or @file{.txi}). For example:
+@smallexample
+gendocs.sh --email @var{yourbuglist} @var{yourmanual} "GNU @var{yourmanual} manual"
+@end smallexample
+
+@noindent where @var{yourmanual} is the short name for your package
+and @var{yourbuglist} is the email address for bug reports (typically
+@code{bug-@var{package}@@gnu.org}). The script processes the file
+@file{@var{yourmanual}.texinfo} (or @file{.texi} or @file{.txi}). For
+example:
-@example
+@smallexample
cd .../emacs/man
# download gendocs.sh and gendocs_template
-gendocs.sh emacs "GNU Emacs manual"
-@end example
+gendocs.sh --email bug-gnu-emacs@@gnu.org emacs "GNU Emacs manual"
+@end smallexample
@command{gendocs.sh} creates a subdirectory @file{manual/} containing
the manual generated in all the standard output formats: Info, HTML,
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:
-@example
+
+@smallexample
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"
-@end 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"
+@end 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.:
+
+@smallexample
+gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"
+@end smallexample
+
+The template files will automatically produce entries for additional
+HTML output generated by @command{texi2html} (i.e., split by sections
+and chapters).
You can set the environment variables @env{MAKEINFO}, @env{TEXI2DVI},
-and @env{DVIPS} to control the programs that get executed, and
-@env{GENDOCS_TEMPLATE_DIR} to control where the
+@env{TEXI2HTML} and @env{DVIPS} to control the programs that get
+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}.
@node CVS Keywords in Web Pages
@section CVS Keywords in Web Pages
-@cindex cvs keywords in web pages
-@cindex rcs keywords in web pages
+@cindex CVS keywords in web pages
+@cindex RCS keywords in web pages
@cindex $ keywords in web pages
-@cindex web pages, and cvs keywords
+@cindex web pages, and CVS keywords
Since @code{www.gnu.org} works through CVS, CVS keywords in your
manual, such as @code{@w{$}Log$}, need special treatment (even if you
output avoiding the literal keyword string.
-@node Ethical and Philosophical Consideration
+@node Ethical and Philosophical Consideration
@chapter Ethical and Philosophical Consideration
@cindex ethics
@cindex philosophy
-The GNU project takes a strong stand for software freedom. Many times,
-this means you'll need to avoid certain technologies when such
-technologies conflict with our ethics of software freedom.
+The GNU project takes a strong stand for software freedom. Many
+times, this means you'll need to avoid certain technologies when their
+use would conflict with our long-term goals.
Software patents threaten the advancement of free software and freedom
-to program. For our safety (which includes yours), we try to avoid
-using algorithms and techniques that we know are patented in the US or
-elsewhere, unless the patent looks so absurd that we doubt it will be
-enforced, or we have a suitable patent license allowing release of free
-software.
-
-Beyond that, sometimes the GNU project takes a strong stand against a
-particular patented technology in order to encourage everyone to reject
-it.
-
-For example, the GIF file format is covered by the LZW software patent
-in the USA. A patent holder has threatened lawsuits against not only
-developers of software to produce GIFs, but even web sites that
-contain them.
-
-For this reason, you should not include GIFs in the web pages for your
-package, nor in the distribution of the package itself. It is ok for
-a GNU package to support displaying GIFs which will come into play if
-a user asks it to operate on one. However, it is essential to provide
-equal or better support for the competing PNG and JPG
-formats---otherwise, the GNU package would be @emph{pressuring} users
-to use GIF format, and that it must not do. More about our stand on
-GIF is available at @uref{http://www.gnu.org/philosophy/gif.html}.
-
-Software patents are not the only matter for ethical concern. A GNU
-package should not recommend use of any non-free program, nor should it
-require a non-free program (such as a non-free compiler or IDE) to
-build. Thus, a GNU package cannot be written in a programming language
-that does not have a free software implementation. Now that GNU/Linux
-systems are widely available, all GNU packages should function
-completely with the GNU/Linux system and not require any non-free
-software to build or function.
+to program. There are so many software patents in the US that any
+large program probably implements hundreds of patented techniques,
+unknown to the program's developers. It would be futile and
+self-defeating to try to find and avoid all these patents. But there
+are some patents which we know are likely to be used to threaten free
+software, so we make an effort to avoid the patented techniques. If
+you are concerned about the danger of a patent and would like advice,
+write to @email{maintainers@@gnu.org}, and we will try to help you get
+advice from a lawyer.
+
+Sometimes the GNU project takes a strong stand against a particular
+patented technology in order to encourage society to reject it.
+
+For example, the MP3 audio format is covered by a software patent in
+the USA and some other countries. A patent holder has threatened
+lawsuits against the developers of free programs (these are not GNU
+programs) to produce and play MP3, and some GNU/Linux distributors are
+afraid to include them. Development of the programs continues, but we
+campaign for the rejection of MP3 format in favor of Ogg Vorbis format.
+
+A GNU package should not recommend use of any non-free program, nor
+should it require a non-free program (such as a non-free compiler or
+IDE) to build. Thus, a GNU package cannot be written in a programming
+language that does not have a free software implementation. Now that
+GNU/Linux systems are widely available, all GNU packages should
+provide full functionality on a 100% free GNU/Linux system, and should
+not require any non-free software to build or function.
+The GNU Coding Standards say a lot more about this issue.
A GNU package should not refer the user to any non-free documentation
for free software. The need for free documentation to come with free
pertain specifically to their package, stand with the rest of the GNU
project when such issues come up.
+
@node Terminology
@chapter Terminology Issues
@cindex terminology
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;
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
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.''
of the GNU kernel, please call it ``the Hurd'' or ``the GNU Hurd.''
Note that this uses a space, not a slash.
-@node Hosting
+
+@node Hosting
@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.
+@xref{Old Versions}, for more information about Savannah.
+
+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
on www.gnu.org for more information on how to contribute.
@end smallexample
+
@node Free Software Directory
@chapter Free Software Directory
@cindex Free Software Directory
+@cindex Directory, Free Software
+
+The Free Software Directory aims to be a complete list of free
+software packages, within certain criteria. Every GNU package should
+be listed there, so please see
+@url{http://www.gnu.org/help/directory.html#adding-entries} for
+information on how to write an entry for your package. Contact
+@email{bug-directory@@gnu.org} with any questions or suggestions for
+the Free Software Directory.
-The Free Software Directory aims to be a complete list of free software
-packages, within certain criteria. Every GNU package should be listed
-there, so please contact @email{bug-directory@@gnu.org} to ask for
-information on how to write an entry for your package.
@node Using the Proofreaders List
@chapter Using the Proofreaders List
Be sure to specify the random choice procedure;
otherwise people will probably use a mental procedure
that is not really random,
-such as "pick a part near the middle",
+such as ``pick a part near the middle'',
and you will not get even coverage.
You can either divide up the work physically, into 20 separate files,
For a job needing special skills, send an explanation of it,
and ask people to send you mail if they volunteer for the job.
When you get enough volunteers, send another message to the list saying
-"I have enough volunteers, no more please."
+``I have enough volunteers, no more please.''
@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
time-stamp-start: "@set lastupdate "
time-stamp-end: "$"
time-stamp-format: "%:b %:d, %:y"
-compile-command: "make just-maintain"
+compile-command: "make -C work.m"
End:
projects / gnulib.git / blobdiff