1 \input texinfo.tex @c -*-texinfo-*-
3 @setfilename maintain.info
4 @settitle Information for Maintainers of GNU Software
5 @c For double-sided printing, uncomment:
6 @c @setchapternewpage odd
7 @c This date is automagically updated when you save this file:
8 @set lastupdate December 23, 2011
11 @dircategory GNU organization
13 * Maintaining: (maintain). Maintaining GNU software.
16 @setchapternewpage off
18 @c Put everything in one index (arbitrarily chosen to be the concept index).
23 Information for maintainers of GNU software, last updated @value{lastupdate}.
25 Copyright @copyright{} 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
26 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
27 2010, 2011 Free Software Foundation, Inc.
30 Permission is granted to copy, distribute and/or modify this document
31 under the terms of the GNU Free Documentation License, Version 1.3 or
32 any later version published by the Free Software Foundation; with no
33 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
34 Texts. A copy of the license is included in the section entitled
35 ``GNU Free Documentation License''.
40 @title Information for Maintainers of GNU Software
41 @author Richard Stallman
42 @author last updated @value{lastupdate}
44 @vskip 0pt plus 1filll
60 * Getting a GNU Account::
62 * Recruiting Developers::
70 * Ethical and Philosophical Consideration::
74 * Free Software Directory::
75 * Using the Proofreaders List::
76 * GNU Free Documentation License::
82 @chapter About This Document
84 This file contains guidelines and advice for someone who is the
85 maintainer of a GNU program on behalf of the GNU Project. Everyone is
86 entitled to change and redistribute GNU software; you need not pay
87 attention to this file to get permission. But if you want to maintain
88 a version for widespread distribution, we suggest you follow these
89 guidelines. If you are or would like to be a GNU maintainer, then it
90 is essential to follow these guidelines.
92 In addition to this document, please read and follow the GNU Coding
93 Standards (@pxref{Top, , Contents, standards, GNU Coding Standards}).
95 @cindex @code{bug-standards@@gnu.org} email address
96 @cindex Savannah repository for @code{gnustandards}
97 @cindex @code{gnustandards} project repository
98 Please send corrections or suggestions for this document to
99 @email{bug-standards@@gnu.org}. If you make a suggestion, please
100 include suggested new wording if you can. We prefer a context diff to
101 the Texinfo source, but if that's difficult for you, you can make a
102 diff for some other version of this document, or propose it in any way
103 that makes it clear. The source repository for this document can be
104 found at @url{http://savannah.gnu.org/projects/gnustandards}.
106 @cindex @code{gnustandards-commit@@gnu.org} mailing list
107 If you want to receive diffs for every change to these GNU documents,
108 join the mailing list @code{gnustandards-commit@@gnu.org}, for
109 instance via the web interface at
110 @url{http://lists.gnu.org/mailman/listinfo/gnustandards-commit}.
111 Archives are also available there.
113 @cindex Piercy, Marge
114 This document uses the gender-neutral third-person pronouns ``person'',
115 ``per'', ``pers'' and ``perself'' which were promoted, and perhaps
116 invented, by Marge Piercy in @cite{Woman on the Edge of Time}. They are
117 used just like ``she'', ``her'', ``hers'' and ``herself'', except that
118 they apply equally to males and females. For example, ``Person placed
119 per new program under the GNU GPL, to let the public benefit from per
120 work, and to enable per to feel person has done the right thing.''
122 This release of the GNU Maintainer Information was last updated
127 @chapter Getting Help
128 @cindex help, getting
130 @cindex @code{mentors@@gnu.org} mailing list
131 If you have any general questions or encounter a situation where it
132 isn't clear how to get something done or who to ask, you (as a GNU
133 contributor) can always write to @email{mentors@@gnu.org}, which is a
134 list of a few experienced GNU folks who have volunteered to answer
135 questions. Any GNU-related question is fair game for the
138 @cindex advisory committee
139 The GNU Advisory Committee helps to coordinate activities in the GNU
140 project on behalf of RMS (Richard Stallman, the Chief GNUisance). If
141 you have any organizational questions or concerns you can contact the
142 committee at @email{gnu-advisory@@gnu.org}. See
143 @url{http://www.gnu.org/contact/gnu-advisory.html} for the current
144 committee members. Additional information is in
145 @file{/gd/gnuorg/advisory}.
147 @cindex down, when GNU machines are
148 @cindex outage, of GNU machines
149 @cindex @url{http://identi.ca/group/fsfstatus}
150 If you find that any GNU computer systems (@code{fencepost.gnu.org},
151 @code{ftp.gnu.org}, @code{www.gnu.org}, @code{savannah.gnu.org},
152 @dots{}) seem to be down, you can check the current status at
153 @url{http://identi.ca/group/fsfstatus}. Most likely the problem, if
154 it can be alleviated at the FSF end, is already being worked on.
156 @cindex sysadmin, FSF
157 @cindex FSF system administrators
158 @cindex GNU system administrators
159 The FSF system administrators are responsible for the network and GNU
160 hardware. You can email them at @email{sysadmin@@fsf.org}, but please
161 try not to burden them unnecessarily.
164 @node Getting a GNU Account
165 @chapter Getting a GNU Account
166 @cindex shell account, on fencepost
167 @cindex @code{fencepost.gnu.org} GNU machine
169 @c We want to repeat this text later, so define a macro.
171 The directory @file{/gd/gnuorg} mentioned throughout this document is
172 available on the general GNU server, currently
173 @code{fencepost.gnu.org}. If you are the maintainer of a GNU package,
174 you should have an account there. If you don't have one already,
175 @url{http://www.gnu.org/software/README.accounts.html}. You can also
176 ask for accounts for people who significantly help you in working on
184 @chapter Stepping Down
185 @cindex stepping down as maintainer
186 @cindex resigning as maintainer
188 With good fortune, you will continue maintaining your package for many
189 decades. But sometimes for various reasons maintainers decide to step
192 If you're the official maintainer of a GNU package and you decide to
193 step down, please inform the GNU Project (@email{maintainers@@gnu.org}).
194 We need to know that the package no longer has a maintainer, so we can
195 look for and appoint a new maintainer.
197 @cindex @email{maintainers@@gnu.org}
198 If you have an idea for who should take over, please tell
199 @email{maintainers@@gnu.org} your suggestion. The appointment of a new
200 maintainer needs the GNU Project's confirmation, but your judgment that
201 a person is capable of doing the job will carry a lot of weight.
203 As your final act as maintainer, it would be helpful to set up or
204 update the package under @code{savannah.gnu.org} (@pxref{Old
205 Versions}). This will make it much easier for the new maintainer to
206 pick up where you left off and will ensure that the source tree is not
207 misplaced if it takes us a while to find a new maintainer.
210 @node Recruiting Developers
211 @chapter Recruiting Developers
213 Unless your package is a fairly small, you probably won't do all the
214 work on it yourself. Most maintainers recruit other developers to help.
216 Sometimes people will offer to help. Some of them will be capable,
217 while others will not. It's up to you to determine who provides useful
218 help, and encourage those people to participate more.
220 Some of the people who offer to help will support the GNU Project, while
221 others may be interested for other reasons. Some will support the goals
222 of the Free Software Movement, but some may not. They are all welcome
223 to help with the work---we don't ask people's views or motivations
224 before they contribute to GNU packages.
226 As a consequence, you cannot expect all contributors to support the GNU
227 Project, or to have a concern for its policies and standards. So part
228 of your job as maintainer is to exercise your authority on these points
229 when they arise. No matter how much of the work other people do, you
230 are in charge of what goes in the release. When a crucial point arises,
231 you should calmly state your decision and stick to it.
233 Sometimes a package has several co-maintainers who share the role of
234 maintainer. Unlike developers who help, co-maintainers have actually
235 been appointed jointly as the maintainers of the package, and they carry
236 out the maintainer's functions together. If you would like to propose
237 some of your developers as co-maintainers, please contact
238 @email{maintainers@@gnu.org}.
240 We're happy to acknowledge all major contributors to GNU packages on
241 the @url{http://www.gnu.org/people/people.html} web page. Please send
242 an entry for yourself to @email{webmasters@@gnu.org}, and feel free to
243 suggest it to other significant developers on your package.
247 @chapter Legal Matters
248 @cindex legal matters
250 This chapter describes procedures you should follow for legal reasons
251 as you maintain the program, to avoid legal difficulties.
255 * Legally Significant::
256 * Recording Contributors::
257 * Copying from Other Packages::
258 * Copyright Notices::
260 * External Libraries::
263 @node Copyright Papers
264 @section Copyright Papers
265 @cindex copyright papers
267 If you maintain an FSF-copyrighted package
268 certain legal procedures are required when incorporating legally significant
269 changes written by other people. This ensures that the FSF has the
270 legal right to distribute the package, and the standing to defend its
271 GPL-covered status in court if necessary.
273 @strong{Before} incorporating significant changes, make sure that the
274 person who wrote the changes has signed copyright papers and that the
275 Free Software Foundation has received and signed them. We may also need
276 an employer's disclaimer from the person's employer.
278 @cindex data base of GNU copyright assignments
279 To check whether papers have been received, look in
280 @file{/gd/gnuorg/copyright.list}. If you can't look there directly,
281 @email{fsf-records@@gnu.org} can check for you. Our clerk can also
282 check for papers that are waiting to be entered and inform you when
283 expected papers arrive.
285 @cindex @file{/gd/gnuorg} directory
286 @c This paragraph intentionally duplicates information given
287 @c near the beginning of the file--to make sure people don't miss it.
290 In order for the contributor to know person should sign papers, you need
291 to ask per for the necessary papers. If you don't know per well, and you
292 don't know that person is used to our ways of handling copyright papers,
293 then it might be a good idea to raise the subject with a message like
297 Would you be willing to assign the copyright to the Free Software
298 Foundation, so that we could install it in @var{package}?
305 Would you be willing to sign a copyright disclaimer to put this change
306 in the public domain, so that we can install it in @var{package}?
309 If the contributor then wants more information, you can send per the file
310 @file{/gd/gnuorg/conditions.text}, which explains per options (assign
311 vs.@: disclaim) and their consequences.
313 Once the conversation is under way and the contributor is ready for
314 more details, you should send one of the templates that are found in
315 the directory @file{/gd/gnuorg/Copyright/}; they are also available
316 from the @file{doc/Copyright/} directory of the @code{gnulib} project
317 at @url{http://savannah.gnu.org/projects/gnulib}. This section
318 explains which templates you should use in which circumstances.
319 @strong{Please don't use any of the templates except for those listed
320 here, and please don't change the wording.}
322 Once the conversation is under way, you can send the contributor the
323 precise wording and instructions by email. Before you do this, make
324 sure to get the current version of the template you will use! We change
325 these templates occasionally---don't keep using an old version.
327 For large changes, ask the contributor for an assignment. Send per a
328 copy of the file @file{request-assign.changes}. (Like all the
329 @samp{request-} files, it is in @file{/gd/gnuorg/Copyright} and in
332 For medium to small changes, request a personal disclaimer by sending
333 per the file @file{request-disclaim.changes}.
335 If the contributor is likely to keep making changes, person might want
336 to sign an assignment for all per future changes to the program. So it
337 is useful to offer per that alternative. If person wants to do it that
338 way, send per the @file{request-assign.future}.
340 When you send a @file{request-} file, you don't need to fill in anything
341 before sending it. Just send the file verbatim to the contributor. The
342 file gives per instructions for how to ask the FSF to mail per the
343 papers to sign. The @file{request-} file also raises the issue of
344 getting an employer's disclaimer from the contributor's employer.
346 When the contributor emails the form to the FSF, the FSF sends per an
347 electronic (usually PDF) copy of the assignment. All contributors
348 then print the assignment and sign it. Contributors residing outside
349 the U.S. must mail the signed form to the FSF via the post.
350 Contributors located in the U.S. can then email or fax a scanned copy
351 back to the FSF (or use postal mail, if they prefer). (To emphasize,
352 the necessary distinction is between US residents and non-residents,
353 citizenship does not matter.)
355 For less common cases, we have template files you should send to the
356 contributor. Be sure to fill in the name of the person and the name
357 of the program in these templates, where it says @samp{NAME OF PERSON}
358 and @samp{NAME OF PROGRAM}, before sending; otherwise person might
359 sign without noticing them, and the papers would be useless. Note
360 that in some templates there is more than one place to put the name of
361 the program or the name of the person; be sure to change all of them.
362 All the templates raise the issue of an employer's disclaimer as well.
364 @cindex legal papers for changes in manuals
365 You do not need to ask for separate papers for a manual that is
366 distributed only in the software package it describes. But if we
367 sometimes distribute the manual separately (for instance, if we publish
368 it as a book), then we need separate legal papers for changes in the
369 manual. For smaller changes, use
370 @file{disclaim.changes.manual}; for larger ones, use
371 @file{assign.changes.manual}. To cover both past and future
372 changes to a manual, you can use @file{assign.future.manual}.
373 For a translation of a manual, use @file{assign.translation.manual}.
375 For translations of program strings (as used by GNU Gettext, for
376 example; @pxref{Internationalization,,, standards, GNU Coding
377 Standards}), use @file{disclaim.translation}. If you make use of the
378 Translation Project (@url{http://translationproject.org}) facilities,
379 please check with the TP coordinators that they have sent the
380 contributor the papers; if they haven't, then you should send the
381 papers. In any case, you should wait for the confirmation from the
382 FSF that the signed papers have been received and accepted before
383 integrating the new contributor's material, as usual.
385 If a contributor is reluctant to sign an assignment for a large change,
386 and is willing to sign a disclaimer instead, that is acceptable, so you
387 should offer this alternative if it helps you reach agreement. We
388 prefer an assignment for a larger change, so that we can enforce the GNU
389 GPL for the new text, but a disclaimer is enough to let us use the text.
391 If you maintain a collection of programs, occasionally someone will
392 contribute an entire separate program or manual that should be added to
393 the collection. Then you can use the files
394 @file{request-assign.program}, @file{disclaim.program},
395 @file{assign.manual}, and @file{disclaim.manual}. We very much prefer
396 an assignment for a new separate program or manual, unless it is quite
397 small, but a disclaimer is acceptable if the contributor insists on
398 handling the matter that way.
400 If a contributor wants the FSF to publish only a pseudonym, that is
401 ok. The contributor should say this, and state the desired pseudonym,
402 when answering the @file{request-} form. The actual legal papers will
403 use the real name, but the FSF will publish only the pseudonym. When
404 using one of the other forms, fill in the real name but ask the
405 contributor to discuss the use of a pseudonym with
406 @email{assign@@gnu.org} before sending back the signed form.
408 @strong{Although there are other templates besides the ones listed here,
409 they are for special circumstances; please do not use them without
410 getting advice from @email{assign@@gnu.org}.}
412 If you are not sure what to do, then please ask @email{assign@@gnu.org} for
413 advice; if the contributor asks you questions about the meaning and
414 consequences of the legal papers, and you don't know the answers, you
415 can forward them to @email{assign@@gnu.org} and we will answer.
417 @strong{Please do not try changing the wording of a template yourself.
418 If you think a change is needed, please talk with @email{assign@@gnu.org},
419 and we will work with a lawyer to decide what to do.}
421 @node Legally Significant
422 @section Legally Significant Changes
424 If a person contributes more than around 15 lines of code and/or text
425 that is legally significant for copyright purposes, we
426 need copyright papers for that contribution, as described above.
428 A change of just a few lines (less than 15 or so) is not legally
429 significant for copyright. A regular series of repeated changes, such
430 as renaming a symbol, is not legally significant even if the symbol
431 has to be renamed in many places. Keep in mind, however, that a
432 series of minor changes by the same person can add up to a significant
433 contribution. What counts is the total contribution of the person; it
434 is irrelevant which parts of it were contributed when.
436 Copyright does not cover ideas. If someone contributes ideas but no
437 text, these ideas may be morally significant as contributions, and
438 worth giving credit for, but they are not significant for copyright
439 purposes. Likewise, bug reports do not count for copyright purposes.
441 When giving credit to people whose contributions are not legally
442 significant for copyright purposes, be careful to make that fact
443 clear. The credit should clearly say they did not contribute
444 significant code or text.
446 When people's contributions are not legally significant because they
447 did not write code, do this by stating clearly what their contribution
448 was. For instance, you could write this:
453 * Richard Mlynarik <mly@@adoc.xerox.com> (1997)
454 * Masatake Yamato <masata-y@@is.aist-nara.ac.jp> (1999)
459 @code{Ideas by:} makes it clear that Mlynarik and Yamato here
460 contributed only ideas, not code. Without the @code{Ideas by:} note,
461 several years from now we would find it hard to be sure whether they
462 had contributed code, and we might have to track them down and ask
465 When you record a small patch in a change log file, first search for
466 previous changes by the same person, and see if per past
467 contributions, plus the new one, add up to something legally
468 significant. If so, you should get copyright papers for all per
469 changes before you install the new change.
471 If that is not so, you can install the small patch. Write @samp{(tiny
472 change)} after the patch author's name, like this:
475 2002-11-04 Robert Fenk <Robert.Fenk@@gmx.de> (tiny change)
478 @node Recording Contributors
479 @section Recording Contributors
480 @cindex recording contributors
482 @strong{Keep correct records of which portions were written by whom.}
483 This is very important. These records should say which files or
484 parts of files were written by each person, and which files or
485 parts of files were revised by each person. This should include
486 installation scripts as well as manuals and documentation
489 These records don't need to be as detailed as a change log. They
490 don't need to distinguish work done at different times, only different
491 people. They don't need describe changes in more detail than which
492 files or parts of a file were changed. And they don't need to say
493 anything about the function or purpose of a file or change---the
494 Register of Copyrights doesn't care what the text does, just who wrote
495 or contributed to which parts.
497 The list should also mention if certain files distributed in the same
498 package are really a separate program.
500 Only the contributions that are legally significant for copyright
501 purposes (@pxref{Legally Significant}) need to be listed. Small
502 contributions, bug reports, ideas, etc., can be omitted.
504 For example, this would describe an early version of GAS:
507 Dean Elsner first version of all files except gdb-lines.c and m68k.c.
508 Jay Fenlason entire files gdb-lines.c and m68k.c, most of app.c,
509 plus extensive changes in messages.c, input-file.c, write.c
510 and revisions elsewhere.
512 Note: GAS is distributed with the files obstack.c and obstack.h, but
513 they are considered a separate package, not part of GAS proper.
516 @cindex @file{AUTHORS} file
517 Please keep these records in a file named @file{AUTHORS} in the source
518 directory for the program itself.
520 You can use the change log as the basis for these records, if you
521 wish. Just make sure to record the correct author for each change
522 (the person who wrote the change, @emph{not} the person who installed
523 it), and add @samp{(tiny change)} for those changes that are too
524 trivial to matter for copyright purposes. Later on you can update the
525 @file{AUTHORS} file from the change log. This can even be done
526 automatically, if you are careful about the formatting of the change
529 It is ok to include other email addresses, names, and program
530 information in @file{AUTHORS}, such as bug-reporting information.
531 @xref{Standard Mailing Lists}.
534 @node Copying from Other Packages
535 @section Copying from Other Packages
537 When you copy legally significant code from another free software
538 package with a GPL-compatible license, you should look in the
539 package's records to find out the authors of the part you are copying,
540 and list them as the contributors of the code that you copied. If all
541 you did was copy it, not write it, then for copyright purposes you are
542 @emph{not} one of the contributors of @emph{this} code.
544 Especially when code has been released into the public domain, authors
545 sometimes fail to write a license statement in each file. In this
546 case, please first be sure that all the authors of the code have
547 disclaimed copyright interest. Then, when copying the new files into
548 your project, add a brief note at the beginning of the files recording
549 the authors, the public domain status, and anything else relevant.
551 On the other hand, when merging some public domain code into an
552 existing file covered by the GPL (or LGPL or other free software
553 license), there is no reason to indicate the pieces which are public
554 domain. The notice saying that the whole file is under the GPL (or
555 other license) is legally sufficient.
557 Using code that is released under a GPL-compatible free license,
558 rather than being in the public domain, may require preserving
559 copyright notices or other steps. Of course, you should do what is
562 If you are maintaining an FSF-copyrighted package, please verify we
563 have papers for the code you are copying, @emph{before} copying it.
564 If you are copying from another FSF-copyrighted package, then we
565 presumably have papers for that package's own code, but you must check
566 whether the code you are copying is part of an external library; if
567 that is the case, we don't have papers for it, so you should not copy
568 it. It can't hurt in any case to double-check with the developer of
571 When you are copying code for which we do not already have papers, you
572 need to get papers for it. It may be difficult to get the papers if
573 the code was not written as a contribution to your package, but that
574 doesn't mean it is ok to do without them. If you cannot get papers
575 for the code, you can only use it as an external library
576 (@pxref{External Libraries}).
579 @node Copyright Notices
580 @section Copyright Notices
581 @cindex copyright notices in program files
583 You should maintain a proper copyright notice and a license
584 notice in each nontrivial file in the package. (Any file more than ten
585 lines long is nontrivial for this purpose.) This includes header files
586 and interface definitions for
587 building or running the program, documentation files, and any supporting
588 files. If a file has been explicitly placed in the public domain, then
589 instead of a copyright notice, it should have a notice saying explicitly
590 that it is in the public domain.
592 Even image files and sound files should contain copyright notices and
593 license notices, if their format permits. Some formats do not have
594 room for textual annotations; for these files, state the copyright and
595 copying permissions in a @file{README} file in the same directory.
597 Change log files should have a copyright notice and license notice at
598 the end, since new material is added at the beginning but the end
601 When a file is automatically generated from some other file in the
602 distribution, it is useful for the automatic procedure to copy the
603 copyright notice and permission notice of the file it is generated
604 from, if possible. Alternatively, put a notice at the beginning saying
605 which file it is generated from.
607 A copyright notice looks like this:
610 Copyright (C) @var{year1}, @var{year2}, @var{year3} @var{copyright-holder}
613 The word @samp{Copyright} must always be in English, by international
616 The @var{copyright-holder} may be the Free Software Foundation, Inc., or
617 someone else; you should know who is the copyright holder for your
620 Replace the @samp{(C)} with a C-in-a-circle symbol if it is available.
621 For example, use @samp{@@copyright@{@}} in a Texinfo file. However,
622 stick with parenthesized @samp{C} unless you know that C-in-a-circle
623 will work. For example, a program's standard @option{--version}
624 message should use parenthesized @samp{C} by default, though message
625 translations may use C-in-a-circle in locales where that symbol is
626 known to work. Alternatively, the @samp{(C)} or C-in-a-circle can be
627 omitted entirely; the word @samp{Copyright} suffices.
629 To update the list of year numbers, add each year in which you have
630 made nontrivial changes to the package. (Here we assume you're using
631 a publicly accessible revision control server, so that every revision
632 installed is also immediately and automatically published.) When you
633 add the new year, it is not required to keep track of which files have
634 seen significant changes in the new year and which have not. It is
635 recommended and simpler to add the new year to all files in the
636 package, and be done with it for the rest of the year.
638 Don't delete old year numbers, though; they are significant since they
639 indicate when older versions might theoretically go into the public
640 domain, if the movie companies don't continue buying laws to further
641 extend copyright. If you copy a file into the package from some other
642 program, keep the copyright years that come with the file.
644 You can use a range (@samp{2008-2010}) instead of listing individual
645 years (@samp{2008, 2009, 2010}) if and only if: 1)@tie{}every year in
646 the range, inclusive, really is a ``copyrightable'' year that would be
647 listed individually; @emph{and} 2)@tie{}you make an explicit statement
648 in a @file{README} file about this usage.
650 For files which are regularly copied from another project (such as
651 @samp{gnulib}), leave the copyright notice as it is in the original.
653 The copyright statement may be split across multiple lines, both in
654 source files and in any generated output. This often happens for
655 files with a long history, having many different years of
658 For an FSF-copyrighted package, if you have followed the procedures to
659 obtain legal papers, each file should have just one copyright holder:
660 the Free Software Foundation, Inc. You should edit the file's
661 copyright notice to list that name and only that name.
663 But if contributors are not all assigning their copyrights to a single
664 copyright holder, it can easily happen that one file has several
665 copyright holders. Each contributor of nontrivial text is a copyright
668 In that case, you should always include a copyright notice in the name
669 of main copyright holder of the file. You can also include copyright
670 notices for other copyright holders as well, and this is a good idea
671 for those who have contributed a large amount and for those who
672 specifically ask for notices in their names. (Sometimes the license
673 on code that you copy in may require preserving certain copyright
674 notices.) But you don't have to include a notice for everyone who
675 contributed to the file (which would be rather inconvenient).
677 Sometimes a program has an overall copyright notice that refers to the
678 whole program. It might be in the @file{README} file, or it might be
679 displayed when the program starts up. This copyright notice should
680 mention the year of completion of the most recent major version; it
681 can mention years of completion of previous major versions, but that
685 @node License Notices
686 @section License Notices
687 @cindex license notices in program files
689 Every nontrivial file needs a license notice as well as the copyright
690 notice. (Without a license notice giving permission to copy and
691 change the file, the file is non-free.)
693 The package itself should contain a full copy of GPL in plain text
694 (conventionally in a file named @file{COPYING}) and the GNU Free
695 Documentation License (included within your documentation, so there is
696 no need for a separate plain text version). If the package contains
697 any files distributed under the Lesser GPL, it should contain a full
698 copy of its plain text version also (conventionally in a file named
699 @file{COPYING.LESSER}).
701 If you have questions about licensing issues for your GNU package,
702 please write @email{licensing@@gnu.org}.
705 * Which: Licensing of GNU Packages.
706 * Canonical: Canonical License Sources.
707 * Code: License Notices for Code.
708 * Documentation: License Notices for Documentation.
709 * Other: License Notices for Other Files.
713 @node Licensing of GNU Packages
714 @subsection Licensing of GNU Packages
716 Normally, GNU packages should use the latest version of the GNU GPL,
717 with the ``or any later version'' formulation. @xref{License Notices
718 for Code}, for the exact wording of the license notice.
720 Occasionally, a GNU library may provide functionality which is already
721 widely available to proprietary programs through alternative
722 implementations; for example, the GNU C Library. In such cases, the
723 Lesser GPL should be used (again, for the notice wording,
724 @pxref{License Notices for Code}). If a GNU library provides unique
725 functionality, however, the GNU GPL should be used.
726 @url{http://www.gnu.org/licenses/why-not-lgpl.html} discusses this
729 Some of these libraries need to work with programs released under
730 GPLv2-only; that is, which allow the GNU GPL version 2 but not later
731 versions. In this case, the GNU package should be released under a
732 dual license: GNU GPL version 2 (or any later version) and the GNU
733 Lesser GPL version 3 (or any later version). Here is the notice for
737 This file is part of GNU @var{package}.
739 GNU @var{package} is free software: you can redistribute it and/or
740 modify it under the terms of either:
742 * the GNU Lesser General Public License as published by the Free
743 Software Foundation; either version 3 of the License, or (at your
744 option) any later version.
748 * the GNU General Public License as published by the Free
749 Software Foundation; either version 2 of the License, or (at your
750 option) any later version.
752 or both in parallel, as here.
754 GNU @var{package} is distributed in the hope that it will be useful,
755 but WITHOUT ANY WARRANTY; without even the implied warranty of
756 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
757 General Public License for more details.
759 You should have received copies of the GNU General Public License and
760 the GNU Lesser General Public License along with this program. If
761 not, see @url{http://www.gnu.org/licenses/}.
764 For small packages, you can use ``This program'' instead of ``GNU
768 @node Canonical License Sources
769 @subsection Canonical License Sources
771 You can get the official versions of these files from several places.
772 You can use whichever is the most convenient for you.
776 @uref{http://www.gnu.org/licenses/}.
779 The @code{gnulib} project on @code{savannah.gnu.org}, which you
780 can access via anonymous Git or CVS. See
781 @uref{http://savannah.gnu.org/projects/gnulib}.
785 The official Texinfo sources for the licenses are also available in
786 those same places, so you can include them in your documentation. A
787 GFDL-covered manual should include the GFDL in this way. @xref{GNU
788 Sample Texts,,, texinfo, Texinfo}, for a full example in a Texinfo
792 @node License Notices for Code
793 @subsection License Notices for Code
795 Typically the license notice for program files (including build scripts,
796 configure files and makefiles) should cite the GPL, like this:
799 This file is part of GNU @var{package}.
801 GNU @var{package} is free software: you can redistribute it and/or
802 modify it under the terms of the GNU General Public License as
803 published by the Free Software Foundation, either version 3 of the
804 License, or (at your option) any later version.
806 GNU @var{package} is distributed in the hope that it will be useful,
807 but WITHOUT ANY WARRANTY; without even the implied warranty of
808 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
809 GNU General Public License for more details.
811 You should have received a copy of the GNU General Public License
812 along with this program. If not, see @url{http://www.gnu.org/licenses/}.
815 But in a small program which is just a few files, you can use
819 This program is free software: you can redistribute it and/or modify
820 it under the terms of the GNU General Public License as published by
821 the Free Software Foundation; either version 3 of the License, or
822 (at your option) any later version.
824 This program is distributed in the hope that it will be useful,
825 but WITHOUT ANY WARRANTY; without even the implied warranty of
826 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
827 GNU General Public License for more details.
829 You should have received a copy of the GNU General Public License
830 along with this program. If not, see @url{http://www.gnu.org/licenses/}.
833 In either case, for those few packages which use the Lesser GPL
834 (@pxref{Licensing of GNU Packages}), insert the word ``Lesser'' before
835 ``General'' in @emph{all three} places.
836 @url{http://@/www.gnu.org/@/licenses/@/gpl-howto.html} discusses application
837 the GPL in more detail.
840 @node License Notices for Documentation
841 @subsection License Notices for Documentation
843 Documentation files should have license notices also. Manuals should
844 use the GNU Free Documentation License. Following is an example of the
845 license notice to use after the copyright line(s) using all the
846 features of the GFDL.
849 Permission is granted to copy, distribute and/or modify this document
850 under the terms of the GNU Free Documentation License, Version 1.3 or
851 any later version published by the Free Software Foundation; with the
852 Invariant Sections being ``GNU General Public License'', with the
853 Front-Cover Texts being ``A GNU Manual'', and with the Back-Cover Texts
854 as in (a) below. A copy of the license is included in the section
855 entitled ``GNU Free Documentation License''.
857 (a) The FSF's Back-Cover Text is: ``You have the freedom to
858 copy and modify this GNU manual. Buying copies from the FSF
859 supports it in developing GNU and promoting software freedom.''
862 If the FSF does not publish this manual on paper, then omit the last
863 sentence in (a) that talks about copies from GNU Press. If the FSF is
864 not the copyright holder, then replace @samp{FSF} with the appropriate
867 Please adjust the list of invariant sections as appropriate for your
868 manual. If there are none, then say ``with no Invariant Sections''.
869 If your manual is not published by the FSF, and under 400 pages, you
870 can omit both cover texts.
872 @xref{GNU Sample Texts,,, texinfo, Texinfo}, for a full example in a
873 Texinfo manual, and see
874 @url{http://www.gnu.org/licenses/fdl-howto.html} for more advice about
875 how to use the GNU FDL.
877 If you write a manual that people might want to buy on paper, please
878 write to @email{maintainers@@gnu.org} to tell the FSF about it. We
879 might want to publish it.
881 If the manual is over 400 pages, or if the FSF thinks it might be a
882 good choice for publishing on paper, then please include the GNU GPL,
883 as in the notice above. Please also include our standard invariant
884 section which explains the importance of free documentation. Write to
885 @email{assign@@gnu.org} to get a copy of this section.
887 When you distribute several manuals together in one software package,
888 their on-line forms can share a single copy of the GFDL (see
889 section@tie{}6). However, the printed (@samp{.dvi}, @samp{.pdf},
890 @dots{}) forms should each contain a copy of the GFDL, unless they are
891 set up to be printed and published only together. Therefore, it is
892 usually simplest to include the GFDL in each manual.
895 @node License Notices for Other Files
896 @subsection License Notices for Other Files
898 Small supporting files, short manuals (under 300 lines long) and rough
899 documentation (@file{README} files, @file{INSTALL} files, etc.)@: can
900 use a simple all-permissive license like this one:
903 Copying and distribution of this file, with or without modification,
904 are permitted in any medium without royalty provided the copyright
905 notice and this notice are preserved. This file is offered as-is,
906 without any warranty.
909 Older versions of this license did not have the second sentence with
910 the express warranty disclaimer. There is no urgent need to update
911 existing files, but new files should use the new text.
913 If your package distributes Autoconf macros that are intended to be
914 used (hence distributed) by third-party packages under possibly
915 incompatible licenses, you may also use the above all-permissive
916 license for these macros.
919 @node External Libraries
920 @section External Libraries
922 When maintaining an FSF-copyrighted GNU package, you may occasionally
923 want to use a general-purpose free software module which offers a
924 useful functionality, as a ``library'' facility (though the module is
925 not always packaged technically as a library).
927 In a case like this, it would be unreasonable to ask the author of that
928 module to assign the copyright to the FSF. After all, person did not
929 write it specifically as a contribution to your package, so it would be
930 impertinent to ask per, out of the blue, ``Please give the FSF your
933 So the thing to do in this case is to make your program use the module,
934 but not consider it a part of your program. There are two reasonable
935 methods of doing this:
939 Assume the module is already installed on the system, and use it when
940 linking your program. This is only reasonable if the module really has
941 the form of a library.
944 Include the module in your package, putting the source in a separate
945 subdirectory whose @file{README} file says, ``This is not part of the
946 GNU FOO program, but is used with GNU FOO.'' Then set up your makefiles
947 to build this module and link it into the executable.
949 For this method, it is not necessary to treat the module as a library
950 and make a @samp{.a} file from it. You can link with the @samp{.o}
951 files directly in the usual manner.
954 Both of these methods create an irregularity, and our lawyers have told
955 us to minimize the amount of such irregularity. So consider using these
956 methods only for general-purpose modules that were written for other
957 programs and released separately for general use. For anything that was
958 written as a contribution to your package, please get papers signed.
962 @chapter Cleaning Up Changes
963 @cindex contributions, accepting
964 @cindex quality of changes suggested by others
966 Don't feel obligated to include every change that someone asks you to
967 include. You must judge which changes are improvements---partly based
968 on what you think the users will like, and partly based on your own
969 judgment of what is better. If you think a change is not good, you
972 If someone sends you changes which are useful, but written in an ugly
973 way or hard to understand and maintain in the future, don't hesitate to
974 ask per to clean up their changes before you merge them. Since the
975 amount of work we can do is limited, the more we convince others to help
976 us work efficiently, the faster GNU will advance.
978 If the contributor will not or can not make the changes clean enough,
979 then it is legitimate to say ``I can't install this in its present form;
980 I can only do so if you clean it up.'' Invite per to distribute per
981 changes another way, or to find other people to make them clean enough
982 for you to install and maintain.
984 The only reason to do these cleanups yourself is if (1) it is easy, less
985 work than telling the author what to clean up, or (2) the change is an
986 important one, important enough to be worth the work of cleaning it up.
988 The GNU Coding Standards are a good thing to send people when you ask
989 them to clean up changes (@pxref{Top, , Contents, standards, GNU Coding
990 Standards}). The Emacs Lisp manual contains an appendix that gives
991 coding standards for Emacs Lisp programs; it is good to urge Lisp authors to
992 read it (@pxref{Tips, , Tips and Conventions, elisp, The GNU Emacs Lisp
997 @chapter Platforms to Support
999 Most GNU packages run on a wide range of platforms. These platforms are
1000 not equally important.
1002 The most important platforms for a GNU package to support are GNU and
1003 GNU/Linux. Developing the GNU operating system is the whole point of
1004 the GNU Project; a GNU package exists to make the whole GNU system more
1005 powerful. So please keep that goal in mind and let it shape your work.
1006 For instance, every new feature you add should work on GNU, and
1007 GNU/Linux if possible too. If a new feature only runs on GNU and
1008 GNU/Linux, it could still be acceptable. However, a feature that runs
1009 only on other systems and not on GNU or GNU/Linux makes no sense in a
1012 You will naturally want to keep the program running on all the platforms
1013 it supports. But you personally will not have access to most of these
1014 platforms---so how should you do it?
1016 Don't worry about trying to get access to all of these platforms. Even
1017 if you did have access to all the platforms, it would be inefficient for
1018 you to test the program on each platform yourself. Instead, you should
1019 test the program on a few platforms, including GNU or GNU/Linux, and let
1020 the users test it on the other platforms. You can do this through a
1021 pretest phase before the real release; when there is no reason to expect
1022 problems, in a package that is mostly portable, you can just make a
1023 release and let the users tell you if anything unportable was
1026 It is important to test the program personally on GNU or GNU/Linux,
1027 because these are the most important platforms for a GNU package. If
1028 you don't have access to one of these platforms, as a GNU maintainer
1029 you can get access to the general GNU login machine; see
1030 @url{http://www.gnu.org/software/README.accounts.html}.
1032 Supporting other platforms is optional---we do it when that seems like
1033 a good idea, but we don't consider it obligatory. If the users don't
1034 take care of a certain platform, you may have to desupport it unless
1035 and until users come forward to help. Conversely, if a user offers
1036 changes to support an additional platform, you will probably want to
1037 install them, but you don't have to. If you feel the changes are
1038 complex and ugly, if you think that they will increase the burden of
1039 future maintenance, you can and should reject them. This includes
1040 both free or mainly-free platforms such as OpenBSD, FreeBSD, and
1041 NetBSD, and non-free platforms such as Windows.
1045 @chapter Dealing With Mail
1048 This chapter describes setting up mailing lists for your package, and
1049 gives advice on how to handle bug reports and random requests once you
1053 * Standard Mailing Lists:: @samp{bug-pkg@@gnu.org} and other standard names.
1054 * Creating Mailing Lists:: The best way is to use Savannah.
1055 * Replying to Mail:: Advice on replying to incoming mail.
1059 @node Standard Mailing Lists
1060 @section Standard Mailing Lists
1062 @cindex standard mailing lists
1063 @cindex mailing lists, standard names of
1065 @cindex mailing list for bug reports
1066 Once a program is in use, you will get bug reports for it. Most GNU
1067 programs have their own special lists for sending bug reports. The
1068 advertised bug-reporting email address should always be
1069 @samp{bug-@var{package}@@gnu.org}, to help show users that the program
1070 is a GNU package, but it is ok to set up that list to forward to another
1073 @cindex @email{bug-gnu-utils@@gnu.org}
1074 We also have a catch-all list, @email{bug-gnu-utils@@gnu.org}, which is
1075 used for all GNU programs that don't have their own specific lists. But
1076 nowadays we want to give each program its own bug-reporting list and
1077 move away from using @email{bug-gnu-utils}.
1079 @xref{Replying to Mail}, for more about handling and tracking bug
1082 @cindex help for users, mailing list for
1083 Some GNU programs with many users have another mailing list,
1084 @samp{help-@var{package}.org}, for people to ask other users for help.
1085 If your program has many users, you should create such a list for it.
1086 For a fairly new program, which doesn't have a large user base yet, it
1087 is better not to bother with this.
1089 @cindex announcements, mailing list for
1090 If you wish, you can also have a mailing list
1091 @samp{info-@var{package}} for announcements (@pxref{Announcements}).
1092 Any other mailing lists you find useful can also be created.
1094 The package distribution should state the name of all the package's
1095 mailing lists in a prominent place, and ask users to help us by
1096 reporting bugs appropriately. The top-level @file{README} file and/or
1097 @file{AUTHORS} file are good places. Mailing list information should
1098 also be included in the manual and the package web pages (@pxref{Web
1103 @node Creating Mailing Lists
1104 @section Creating Mailing Lists
1106 @cindex creating mailing lists
1107 @cindex mailing lists, creating
1109 Using the web interface on @code{savannah.gnu.org} is by far the
1110 easiest way to create normal mailing lists, managed through Mailman on
1111 the GNU mail server. Once you register your package on Savannah, you
1112 can create (and remove) lists yourself through the `Mailing Lists'
1113 menu, without needing to wait for intervention by anyone else.
1114 Furthermore, lists created through Savannah will have a reasonable
1115 default configuration for antispam purposes (see below).
1117 To create and maintain simple aliases and unmanaged lists, you can
1118 edit @file{/com/mailer/aliases} on the main GNU server. If you don't
1119 have an account there, please read
1120 @url{http://www.gnu.org/software/README.accounts.html} (@pxref{Getting
1123 But if you don't want to learn how to do those things, you can
1124 alternatively ask @email{alias-file@@gnu.org} to add you to the
1125 bug-reporting list for your program. To set up a new list, contact
1126 @email{new-mailing-list@@gnu.org}. You can subscribe to a list managed
1127 by Mailman by sending mail to the corresponding @samp{-request} address.
1129 @cindex spam prevention
1130 You should moderate postings from non-subscribed addresses on your
1131 mailing lists, to prevent propagation of unwanted messages (``spam'')
1132 to subscribers and to the list archives. For lists controlled by
1133 Mailman, you can do this by setting @code{Privacy Options - Sender
1134 Filter - generic_nonmember_action} to @code{Hold}, and then
1135 periodically (daily is best) reviewing the held messages, accepting
1136 the real ones and discarding the junk.
1138 Lists created through Savannah will have this setting, and a number of
1139 others, such that spam will be automatically deleted (after a short
1140 delay). The Savannah mailing list page describes all the details.
1141 You should still review the held messages in order to approve any that
1145 @node Replying to Mail
1146 @section Replying to Mail
1148 @cindex responding to bug reports
1149 @cindex bug reports, handling
1150 @cindex help requests, handling
1152 When you receive bug reports, keep in mind that bug reports are crucial
1153 for your work. If you don't know about problems, you cannot fix them.
1154 So always thank each person who sends a bug report.
1156 You don't have an obligation to give more response than that, though.
1157 The main purpose of bug reports is to help you contribute to the
1158 community by improving the next version of the program. Many of the
1159 people who report bugs don't realize this---they think that the point is
1160 for you to help them individually. Some will ask you to focus on that
1161 @emph{instead of} on making the program better. If you comply with
1162 their wishes, you will have been distracted from the job of maintaining
1165 For example, people sometimes report a bug in a vague (and therefore
1166 useless) way, and when you ask for more information, they say, ``I just
1167 wanted to see if you already knew the solution'' (in which case the bug
1168 report would do nothing to help improve the program). When this
1169 happens, you should explain to them the real purpose of bug reports. (A
1170 canned explanation will make this more efficient.)
1172 When people ask you to put your time into helping them use the program,
1173 it may seem ``helpful'' to do what they ask. But it is much @emph{less}
1174 helpful than improving the program, which is the maintainer's real job.
1176 By all means help individual users when you feel like it, if you feel
1177 you have the time available. But be careful to limit the amount of time
1178 you spend doing this---don't let it eat away the time you need to
1179 maintain the program! Know how to say no; when you are pressed for
1180 time, just ``thanks for the bug report---I will fix it'' is enough
1183 Some GNU packages, such as Emacs and GCC, come with advice about how
1184 to make bug reports useful. Copying and adapting that could be very
1185 useful for your package.
1187 @cindex @url{http://bugs.gnu.org}
1188 @cindex bug reports, email tracker for
1189 @cindex bug reports, web tracker for
1190 If you would like to use an email-based bug tracking system, see
1191 @url{http://bugs.gnu.org}; this can be connected with the regular
1192 bug-reporting address. Alternatively, if you would like to use a
1193 web-based bug tracking system, Savannah supports this (@pxref{Old
1194 Versions}), but please don't fail to accept bugs by regular email as
1195 well---we don't want to put up unnecessary barriers against users
1200 @chapter Recording Old Versions
1201 @cindex version control
1203 It is very important to keep backup files of all source files of GNU.
1204 You can do this using a source control system (such as Bazaar, RCS,
1205 CVS, Git, Subversion, @dots{}) if you like. An easy way to use
1206 many such systems is via the Version Control library in Emacs
1207 (@pxref{Introduction to VC,, Introduction to Version Control, emacs,
1208 The GNU Emacs Manual}).
1210 The history of previous revisions and log entries is very important for
1211 future maintainers of the package, so even if you do not make it
1212 publicly accessible, be careful not to put anything in the repository or
1213 change log that you would not want to hand over to another maintainer
1216 @cindex @code{savannah-hackers@@gnu.org}
1217 The GNU Project provides a server that GNU packages can use
1218 for source control and other package needs: @code{savannah.gnu.org}.
1219 Savannah is managed by @email{savannah-hackers@@gnu.org}. For more
1220 details on using and contributing to Savannah, see
1221 @url{http://savannah.gnu.org/maintenance}.
1223 It's not an absolute requirement, but all GNU maintainers are strongly
1224 encouraged to take advantage of Savannah, as sharing such a central
1225 point can serve to foster a sense of community among GNU developers as
1226 well as help in keeping up with project management. Please don't mark
1227 Savannah projects for GNU packages as private; that defeats a large
1228 part of the purpose of using Savannah in the first place.
1230 @cindex @code{savannah-announce@@gnu.org} mailing list
1231 If you do use Savannah, please subscribe to the
1232 @email{savannah-announce@@gnu.org} mailing list
1233 (@url{http://lists.gnu.org/mailman/listinfo/savannah-announce}). This
1234 is a very low-volume list to keep Savannah users informed of system
1235 upgrades, problems, and the like.
1239 @chapter Distributions
1241 It is important to follow the GNU conventions when making GNU software
1245 * Distribution tar Files::
1246 * Distribution Patches::
1247 * Distribution on ftp.gnu.org::
1249 * Automated FTP Uploads::
1253 @node Distribution tar Files
1254 @section Distribution tar Files
1255 @cindex distribution, tar files
1257 The tar file for version @var{m}.@var{n} of program @code{foo} should be
1258 named @file{foo-@var{m}.@var{n}.tar}. It should unpack into a
1259 subdirectory named @file{foo-@var{m}.@var{n}}. Tar files should not
1260 unpack into files in the current directory, because this is inconvenient
1261 if the user happens to unpack into a directory with other files in it.
1263 Here is how the @file{Makefile} for Bison creates the tar file.
1264 This method is good for other programs.
1268 echo bison-`sed -e '/version_string/!d' \
1269 -e 's/[^0-9.]*\([0-9.]*\).*/\1/' -e q version.c` > .fname
1270 -rm -rf `cat .fname`
1272 dst=`cat .fname`; for f in $(DISTFILES); do \
1273 ln $(srcdir)/$$f $$dst/$$f || @{ echo copying $$f; \
1274 cp -p $(srcdir)/$$f $$dst/$$f ; @} \
1276 tar --gzip -chf `cat .fname`.tar.gz `cat .fname`
1277 -rm -rf `cat .fname` .fname
1280 Source files that are symbolic links to other file systems cannot be
1281 installed in the temporary directory using @code{ln}, so use @code{cp}
1285 Using Automake is a good way to take care of writing the @code{dist}
1288 @node Distribution Patches
1289 @section Distribution Patches
1290 @cindex patches, against previous releases
1292 If the program is large, it is useful to make a set of diffs for each
1293 release, against the previous important release.
1295 At the front of the set of diffs, put a short explanation of which
1296 version this is for and which previous version it is relative to.
1297 Also explain what else people need to do to update the sources
1298 properly (for example, delete or rename certain files before
1299 installing the diffs).
1301 The purpose of having diffs is that they are small. To keep them
1302 small, exclude files that the user can easily update. For example,
1303 exclude info files, DVI files, tags tables, output files of Bison or
1304 Flex. In Emacs diffs, we exclude compiled Lisp files, leaving it up
1305 to the installer to recompile the patched sources.
1307 When you make the diffs, each version should be in a directory suitably
1308 named---for example, @file{gcc-2.3.2} and @file{gcc-2.3.3}. This way,
1309 it will be very clear from the diffs themselves which version is which.
1313 @cindex time stamp in diffs
1314 If you use GNU @code{diff} to make the patch, use the options
1315 @samp{-rc2P}. That will put any new files into the output as ``entirely
1316 different''. Also, the patch's context diff headers should have dates
1317 and times in Universal Time using traditional Unix format, so that patch
1318 recipients can use GNU @code{patch}'s @samp{-Z} option. For example,
1319 you could use the following Bourne shell command to create the patch:
1322 LC_ALL=C TZ=UTC0 diff -rc2P gcc-2.3.2 gcc-2.3.3 | \
1323 gzip -9 >gcc-2.3.2-2.3.3.patch.gz
1326 If the distribution has subdirectories in it, then the diffs probably
1327 include some files in the subdirectories. To help users install such
1328 patches reliably, give them precise directions for how to run patch.
1329 For example, say this:
1332 To apply these patches, cd to the main directory of the program
1333 and then use `patch -p1'. `-p1' avoids guesswork in choosing
1334 which subdirectory to find each file in.
1337 It's wise to test your patch by applying it to a copy of the old
1338 version, and checking that the result exactly matches the new version.
1340 @node Distribution on ftp.gnu.org
1341 @section Distribution on @code{ftp.gnu.org}
1342 @cindex GNU ftp site
1343 @cindex @code{ftp.gnu.org}, the GNU release site
1345 GNU packages are distributed through the directory @file{/gnu} on
1346 @code{ftp.gnu.org}, via both HTTP and FTP. Each package should have a
1347 subdirectory named after the package, and all the distribution files
1348 for the package should go in that subdirectory.
1350 @xref{Automated FTP Uploads}, for procedural details of putting new
1351 versions on @code{ftp.gnu.org}.
1354 @section Test Releases
1355 @cindex test releases
1356 @cindex beta releases
1357 @cindex pretest releases
1359 @cindex @code{alpha.gnu.org}, test release site
1360 When you release a greatly changed new major version of a program, you
1361 might want to do so as a pretest. This means that you make a tar file,
1362 but send it only to a group of volunteers that you have recruited. (Use
1363 a suitable GNU mailing list/newsgroup to recruit them.)
1365 We normally use the server @code{alpha.gnu.org} for pretests and
1366 prerelease versions. @xref{Automated FTP Uploads}, for procedural details
1367 of putting new versions on @code{alpha.gnu.org}.
1369 Once a program gets to be widely used and people expect it to work
1370 solidly, it is a good idea to do pretest releases before each ``real''
1373 There are two ways of handling version numbers for pretest versions.
1374 One method is to treat them as versions preceding the release you are going
1377 In this method, if you are about to release version 4.6 but you want
1378 to do a pretest first, call it 4.5.90. If you need a second pretest,
1379 call it 4.5.91, and so on. If you are really unlucky and ten pretests
1380 are not enough, after 4.5.99 you could advance to 4.5.990 and so on.
1381 (You could also use 4.5.100, but 990 has the advantage of sorting in
1384 The other method is to attach a date to the release number that is
1385 coming. For a pretest for version 4.6, made on Dec 10, 2002, this
1386 would be 4.6.20021210. A second pretest made the same day could be
1389 For development snapshots that are not formal pretests, using just
1390 the date without the version numbers is ok too.
1392 One thing that you should never do is to release a pretest with the same
1393 version number as the planned real release. Many people will look only
1394 at the version number (in the tar file name, in the directory name that
1395 it unpacks into, or wherever they can find it) to determine whether a
1396 tar file is the latest version. People might look at the test release
1397 in this way and mistake it for the real release. Therefore, always
1398 change the number when you release changed code.
1401 @node Automated FTP Uploads
1402 @section Automated FTP Uploads
1404 @cindex ftp uploads, automated
1405 In order to upload new releases to @code{ftp.gnu.org} or
1406 @code{alpha.gnu.org}, you first need to register the necessary
1407 information. Then, you can perform uploads yourself, with no
1408 intervention needed by the system administrators.
1410 The general idea is that releases should be crytographically signed
1411 before they are made publicly available.
1414 * Automated Upload Registration::
1415 * Automated Upload Procedure::
1416 * FTP Upload Directive File - v1.1::
1417 * FTP Upload Directive File - v1.0::
1421 @node Automated Upload Registration
1422 @subsection Automated Upload Registration
1424 @cindex registration for uploads
1425 @cindex uploads, registration for
1427 Here is how to register your information so you can perform uploads
1428 for your GNU package:
1433 Create an account for yourself at @url{http://savannah.gnu.org}, if
1434 you don't already have one. By the way, this is also needed to
1435 maintain the web pages at @url{http://www.gnu.org} for your project
1436 (@pxref{Web Pages}).
1439 In the @samp{My Account Conf} page on @code{savannah}, upload the GPG
1440 key you will use to sign your packages. If you haven't created one
1441 before, you can do so with the command @code{gpg --gen-key} (you can
1442 accept all the default answers to its questions).
1444 Optional but recommended: Send your key to a GPG public key server:
1445 @code{gpg --keyserver keys.gnupg.net --send-keys @var{keyid}}, where
1446 @var{keyid} is the eight hex digits reported by @code{gpg
1447 --list-public-keys} on the @code{pub} line before the date. For full
1448 information about GPG, see @url{http://www.gnu.org/software/gpg}.
1451 Compose a message with the following items in some @var{msgfile}.
1452 Then GPG-sign it by running @code{gpg --clearsign @var{msgfile}}, and
1453 finally email the resulting @file{@var{msgfile}.asc} to
1454 @email{ftp-upload@@gnu.org}.
1458 Name of package(s) that you are the maintainer for, your
1459 preferred email address, and your Savannah username.
1462 An ASCII armored copy of your GPG key, as an attachment. (@samp{gpg
1463 --export -a @var{your_key_id} >mykey.asc} should give you this.)
1466 A list of names and preferred email addresses of other individuals you
1467 authorize to make releases for which packages, if any (in the case that you
1468 don't make all releases yourself).
1471 ASCII armored copies of GPG keys for any individuals listed in (3).
1475 The administrators will acknowledge your message when they have added
1476 the proper GPG keys as authorized to upload files for the
1477 corresponding packages.
1479 The upload system will email receipts to the given email addresses
1480 when an upload is made, either successfully or unsuccessfully.
1483 @node Automated Upload Procedure
1484 @subsection Automated Upload Procedure
1488 Once you have registered your information as described in the previous
1489 section, you will be able to do ftp uploads for yourself using the
1490 following procedure.
1492 For each upload destined for @code{ftp.gnu.org} or
1493 @code{alpha.gnu.org}, three files (a @dfn{triplet}) need to be
1494 uploaded via ftp to the host @code{ftp-upload.gnu.org}.
1498 The file to be distributed; for example, @file{foo.tar.gz}.
1501 Detached GPG binary signature file for (1); for example,
1502 @file{foo.tar.gz.sig}. Make this with @samp{gpg -b foo.tar.gz}.
1505 A clearsigned @dfn{directive file}; for example,
1506 @file{foo.tar.gz.directive.asc}. Make this by preparing the plain
1507 text file @file{foo.tar.gz.directive} and then run @samp{gpg
1508 --clearsign foo.tar.gz.directive}. @xref{FTP Upload Directive File -
1509 v1.1}, for the contents of the directive file.
1512 The names of the files are important. The signature file must have the
1513 same name as the file to be distributed, with an additional
1514 @file{.sig} extension. The directive file must have the same name as
1515 the file to be distributed, with an additional @file{.directive.asc}
1516 extension. If you do not follow this naming convention, the upload
1517 @emph{will not be processed}.
1519 Since v1.1 of the upload script, it is also possible to upload a
1520 clearsigned directive file on its own (no accompanying @file{.sig} or
1521 any other file) to perform certain operations on the server.
1522 @xref{FTP Upload Directive File - v1.1}, for more information.
1524 Upload the file(s) via anonymous ftp to @code{ftp-upload.gnu.org}. If
1525 the upload is destined for @code{ftp.gnu.org}, place the file(s) in
1526 the @file{/incoming/ftp} directory. If the upload is destined for
1527 @code{alpha.gnu.org}, place the file(s) in the @file{/incoming/alpha}
1530 Uploads are processed every five minutes. Uploads that are in
1531 progress while the upload processing script is running are handled
1532 properly, so do not worry about the timing of your upload. Uploaded
1533 files that belong to an incomplete triplet are deleted automatically
1536 Your designated upload email addresses (@pxref{Automated Upload Registration})
1537 are sent a message if there are any problems processing an upload for your
1538 package. You also receive a message when your upload has been successfully
1541 One automated way to create and transfer the necessary files is to use
1542 the @code{gnupload} script, which is available from the
1543 @file{build-aux/} directory of the @code{gnulib} project at
1544 @url{http://savannah.gnu.org/projects/gnulib}. @code{gnupload} can
1545 also remove uploaded files. Run @code{gnupload --help} for a
1546 description and examples.
1548 @code{gnupload} uses the @code{ncftpput} program to do the actual
1549 transfers; if you don't happen to have the @code{ncftp} package
1550 installed, the @code{ncftpput-ftp} script in the @file{build-aux/}
1551 directory of @code{gnulib} serves as a replacement which uses plain
1552 command line @code{ftp}.
1554 If you have difficulties with an upload, email
1555 @email{ftp-upload@@gnu.org}. You can check the archive of uploads
1557 @url{https://lists.gnu.org/archive/html/ftp-upload-report}.
1560 @node FTP Upload Directive File - v1.1
1561 @subsection FTP Upload Directive File - v1.1
1563 The directive file name must end in @file{directive.asc}.
1565 When part of a triplet, the directive file must always contain the
1566 directives @code{version}, @code{directory} and @code{filename}, as
1567 described. In addition, a 'comment' directive is allowed.
1569 The @code{version} directive must always have the value @samp{1.1}.
1571 The @code{directory} directive specifies the final destination
1572 directory where the uploaded file and its @file{.sig} companion are to
1575 The @code{filename} directive must contain the name of the file to be
1576 distributed (item@tie{}(1) above).
1578 For example, as part of an uploaded triplet, a
1579 @file{foo.tar.gz.directive.asc} file might contain these lines (before
1580 being gpg clearsigned):
1585 filename: foo.tar.gz
1586 comment: hello world!
1589 This directory line indicates that @file{foo.tar.gz} and
1590 @file{foo.tar.gz.sig} are part of package @code{bar}. If you uploaded
1591 this triplet to @file{/incoming/ftp} and the system positively
1592 authenticates the signatures, the files @file{foo.tar.gz} and
1593 @file{foo.tar.gz.sig} will be placed in the directory
1594 @file{gnu/bar/v1} of the @code{ftp.gnu.org} site.
1596 The directive file can be used to create currently non-existent
1597 directory trees, as long as they are under the package directory for
1598 your package (in the example above, that is @code{bar}).
1600 If you upload a file that already exists in the FTP directory, the
1601 original will simply be archived and replaced with the new upload.
1603 @subheading Standalone directives
1605 When uploaded by itself, the directive file must contain one or more
1606 of the directives @code{symlink}, @code{rmsymlink} or @code{archive},
1607 in addition to the obligatory @code{directory} and @code{version}
1608 directives. A @code{filename} directive is not allowed, and a
1609 @code{comment} directive remains optional.
1611 If you use more than one directive, the directives are executed in the
1612 sequence they are specified in. If a directive results in an error,
1613 further execution of the upload is aborted.
1615 Removing a symbolic link (with @code{rmsymlink}) which does not exist
1616 results in an error. However, attempting to create a symbolic link
1617 that already exists (with @code{symlink}) is not an error. In this
1618 case @code{symlink} behaves like the command @command{ln -s -f}: any
1619 existing symlink is removed before creating the link. (But an
1620 existing regular file or directory is not removed.)
1622 Here are a few examples. The first removes a symlink:
1627 rmsymlink: foo-latest.tgz
1628 comment: remove a symlink
1632 Archive an old file, taking it offline:
1637 archive: foo-1.1.tar.gz
1638 comment: archive an old file; it will not be
1639 comment: available through FTP any more.
1643 Archive an old directory (with all contents), taking it offline:
1649 comment: archive an old directory; it and its entire
1650 comment: contents will not be available through FTP anymore
1654 Create a new symlink:
1659 symlink: foo-1.2.tar.gz foo-latest.tgz
1660 comment: create a new symlink
1664 Do everything at once:
1669 rmsymlink: foo-latest.tgz
1670 symlink: foo-1.2.tar.gz foo-latest.tgz
1671 archive: foo-1.1.tar.gz
1672 comment: now do everything at once
1676 @node FTP Upload Directive File - v1.0
1677 @subsection FTP Upload Directive File - v1.0
1679 @dfn{As of June 2006, the upload script is running in compatibility
1680 mode, allowing uploads with either version@tie{}1.1 or
1681 version@tie{}1.0 of the directive file syntax. Support for v1.0
1682 uploads will be phased out by the end of 2006, so please upgrade
1685 The directive file should contain one line, excluding the clearsigned
1686 data GPG that inserts, which specifies the final destination directory
1687 where items (1) and (2) are to be placed.
1689 For example, the @file{foo.tar.gz.directive.asc} file might contain the
1696 This directory line indicates that @file{foo.tar.gz} and
1697 @file{foo.tar.gz.sig} are part of package @code{bar}. If you were to
1698 upload the triplet to @file{/incoming/ftp}, and the system can
1699 positively authenticate the signatures, then the files
1700 @file{foo.tar.gz} and @file{foo.tar.gz.sig} will be placed in the
1701 directory @file{gnu/bar/v1} of the @code{ftp.gnu.org} site.
1703 The directive file can be used to create currently non-existent
1704 directory trees, as long as they are under the package directory for
1705 your package (in the example above, that is @code{bar}).
1709 @section Announcing Releases
1710 @cindex announcements
1712 @cindex @code{info-gnu} mailing list
1713 When you have a new release, please make an announcement. For
1714 official new releases, including those made just to fix bugs, we
1715 strongly recommend using the (moderated) general GNU announcements
1716 list, @email{info-gnu@@gnu.org}. Doing so makes it easier for users
1717 and developers to find the latest GNU releases. On the other hand,
1718 please do not announce test releases on @code{info-gnu} unless it's a
1719 highly unusual situation.
1721 @cindex @url{http://planet.gnu.org}
1722 @cindex Savannah, news area
1723 Please also post release announcements in the news section of your
1724 Savannah project site. Here, it is fine to also write news entries
1725 for test releases and any other newsworthy events. The news feeds
1726 from all GNU projects at savannah are aggregated at
1727 @url{http://planet.gnu.org} (GNU Planet). You can also post items
1728 directly, or arrange for feeds from other locations; see information
1729 on the GNU Planet web page.
1731 @cindex announcement mailing list, project-specific
1732 You can maintain your own mailing list (typically
1733 @email{info-@var{package}@@gnu.org}) for announcements as well if you
1734 like. For your own list, of course you decide as you see fit what
1735 events are worth announcing. (@xref{Mail}, for setting this up, and
1736 more suggestions on handling mail for your package.)
1738 @cindex contents of announcements
1739 When writing an announcement, please include the following:
1743 A very brief description (a few sentences at most) of the general
1744 purpose of your package.
1747 Your package's web page (normally
1748 @indicateurl{http://www.gnu.org/software/@var{package}/}).
1751 Your package's download location (normally
1752 @indicateurl{http://ftp.gnu.org/gnu/@var{package}/}). It is also
1753 useful to mention the mirror list at
1754 @url{http://www.gnu.org/order/ftp.html}, and that
1755 @url{http://ftpmirror.gnu.org/@var{package/}} will automatically
1756 redirect to a nearby mirror.
1759 The @t{NEWS} (@pxref{NEWS File,,, standards, GNU Coding Standards}) for
1760 the present release.
1768 Please write web pages about your package, and install them on
1769 @code{www.gnu.org}. They should follow our usual standards for web
1770 pages (see @url{http://www.gnu.org/server/@/fsf-html-style-sheet.html}).
1771 The overall goals are to support a wide variety of browsers, to focus
1772 on information rather than flashy eye candy, and to keep the site
1775 We encourage you to use the standard @code{www.gnu.org} template as
1776 the basis for your pages:
1777 @url{http://www.gnu.org/server/@/standards/@/boilerplate-source.html}.
1779 Some GNU packages have just simple web pages, but the more information
1780 you provide, the better. So please write as much as you usefully can,
1781 and put all of it on @code{www.gnu.org}. However, pages that access
1782 databases (including mail archives and bug tracking) are an exception;
1783 set them up on whatever site is convenient for you, and make the pages
1784 on @code{www.gnu.org} link to that site.
1787 * Hosting for Web Pages::
1788 * Freedom for Web Pages::
1789 * Manuals on Web Pages::
1790 * CVS Keywords in Web Pages::
1794 @node Hosting for Web Pages
1795 @section Hosting for Web Pages
1797 The best way to maintain the web pages for your project is to register
1798 the project on @code{savannah.gnu.org}. Then you can edit the pages
1799 using CVS, using the separate ``web repository'' available on
1800 Savannah, which corresponds to
1801 @indicateurl{http://www.gnu.org/software/@var{package}/}. You can
1802 keep your source files there too (using any of a variety of version
1803 control systems), but you can use @code{savannah.gnu.org} only for
1804 your gnu.org web pages if you wish; simply register a ``web-only''
1807 If you don't want to use that method, please talk with
1808 @email{webmasters@@gnu.org} about other possible methods. For
1809 instance, you can mail them pages to install, if necessary. But that
1810 is more work for them, so please use Savannah if you can.
1812 If you use Savannah, you can use a special file named @file{.symlinks}
1813 in order to create symbolic links, which are not supported in CVS.
1815 @url{http://www.gnu.org/server/standards/README.webmastering.html#symlinks}.
1818 @node Freedom for Web Pages
1819 @section Freedom for Web Pages
1821 If you use a site other than @code{www.gnu.org}, please make sure that
1822 the site runs on free software alone. (It is ok if the site uses
1823 unreleased custom software, since that is free in a trivial sense:
1824 there's only one user and it has the four freedoms.) If the web site
1825 for a GNU package runs on non-free software, the public will see this,
1826 and it will have the effect of granting legitimacy to the non-free
1829 If you use multiple sites, they should all follow that criterion.
1830 Please don't link to a site that is about your package, which the
1831 public might perceive as connected with it and reflecting the position
1832 of its developers, unless it follows that criterion.
1834 Historically, web pages for GNU packages did not include GIF images,
1835 because of patent problems (@pxref{Ethical and Philosophical
1836 Consideration}). Although the GIF patents expired in 2006, using GIF
1837 images is still not recommended, as the PNG and JPEG formats are
1838 generally superior. See @url{http://www.gnu.org/philosophy/gif.html}.
1841 @node Manuals on Web Pages
1842 @section Manuals on Web Pages
1844 The web pages for the package should include its manuals, in HTML,
1845 DVI, Info, PostScript, PDF, plain ASCII, and Texinfo format (source).
1846 All of these can be generated automatically from the Texinfo source
1847 using Makeinfo and other programs.
1849 When there is only one manual, put it in a subdirectory called
1850 @file{manual}; the file @file{manual/index.html} should have a link to
1851 the manual in each of its forms.
1853 If the package has more than one manual, put each one in a
1854 subdirectory of @file{manual}, set up @file{index.html} in each
1855 subdirectory to link to that manual in all its forms, and make
1856 @file{manual/index.html} link to each manual through its subdirectory.
1858 See the section below for details on a script to make the job of
1859 creating all these different formats and index pages easier.
1861 We would like to list all GNU manuals on the page
1862 @url{http://www.gnu.org/manual}, so if yours isn't there, please send
1863 mail to @code{webmasters@@gnu.org}, asking them to add yours, and they
1864 will do so based on the contents of your @file{manual} directory.
1867 * Invoking gendocs.sh::
1871 @node Invoking gendocs.sh
1872 @subsection Invoking @command{gendocs.sh}
1874 @cindex generating documentation output
1876 The script @command{gendocs.sh} eases the task of generating the
1877 Texinfo documentation output for your web pages
1878 section above. It has a companion template file, used as the basis
1879 for the HTML index pages. Both are available from the Texinfo CVS
1883 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh}
1884 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template}
1887 There is also a minimalistic template, available from:
1890 @uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template_min}
1893 Invoke the script like this, in the directory containing the Texinfo
1897 gendocs.sh --email @var{yourbuglist} @var{yourmanual} "GNU @var{yourmanual} manual"
1900 @noindent where @var{yourmanual} is the short name for your package
1901 and @var{yourbuglist} is the email address for bug reports (which
1902 should be @code{bug-@var{package}@@gnu.org}). The script processes
1903 the file @file{@var{yourmanual}.texinfo} (or @file{.texi} or
1904 @file{.txi}). For example:
1908 # download gendocs.sh and gendocs_template
1909 gendocs.sh --email bug-texinfo@@gnu.org texinfo "GNU Texinfo manual"
1912 @command{gendocs.sh} creates a subdirectory @file{manual/} containing
1913 the manual generated in all the standard output formats: Info, HTML,
1914 DVI, and so on, as well as the Texinfo source. You then need to move
1915 all those files, retaining the subdirectories, into the web pages for
1918 You can specify the option @option{-o @var{outdir}} to override the
1919 name @file{manual}. Any previous contents of @var{outdir} will be deleted.
1921 The second argument, with the description, is included as part of the
1922 HTML @code{<title>} of the overall @file{manual/index.html} file. It
1923 should include the name of the package being documented, as shown.
1924 @file{manual/index.html} is created by substitution from the file
1925 @file{gendocs_template}. (Feel free to modify the generic template
1926 for your own purposes.)
1928 If you have several manuals, you'll need to run this script several
1929 times with different arguments, specifying a different output
1930 directory with @option{-o} each time, and moving all the output to
1931 your web page. Then write (by hand) an overall index.html with links
1932 to them all. For example:
1936 gendocs.sh --email bug-texinfo@@gnu.org -o texinfo texinfo "GNU Texinfo manual"
1937 gendocs.sh --email bug-texinfo@@gnu.org -o info info "GNU Info manual"
1938 gendocs.sh --email bug-texinfo@@gnu.org -o info-stnd info-stnd "GNU info-stnd manual"
1941 By default, the script uses @command{makeinfo} for generating
1942 @acronym{HTML} output. If you prefer to use @command{texi2html}, use
1943 the @option{--texi2html} command line option, e.g.:
1946 gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"
1949 The template files will automatically produce entries for additional
1950 HTML output generated by @command{texi2html} (i.e., split by sections
1953 You can set the environment variables @env{MAKEINFO}, @env{TEXI2DVI},
1954 @env{TEXI2HTML} and @env{DVIPS} to control the programs that get
1955 executed, and @env{GENDOCS_TEMPLATE_DIR} to control where the
1956 @file{gendocs_template} file is found.
1958 As usual, run @samp{gendocs.sh --help} for a description of all the
1959 options, environment variables, and more information.
1961 Please email bug reports, enhancement requests, or other
1962 correspondence to @email{bug-texinfo@@gnu.org}.
1965 @node CVS Keywords in Web Pages
1966 @section CVS Keywords in Web Pages
1967 @cindex CVS keywords in web pages
1968 @cindex RCS keywords in web pages
1969 @cindex $ keywords in web pages
1970 @cindex web pages, and CVS keywords
1972 Since @code{www.gnu.org} works through CVS, CVS keywords in your
1973 manual, such as @code{@w{$}Log$}, need special treatment (even if you
1974 don't happen to maintain your manual in CVS).
1976 If these keywords end up in the generated output as literal strings,
1977 they will be expanded. The most robust way to handle this is to turn
1978 off keyword expansion for such generated files. For existing files,
1982 cvs admin -ko @var{file1} @var{file2} ...
1989 cvs add -ko @var{file1} @var{file2} ...
1992 @c The CVS manual is now built with numeric references and no nonsplit
1993 @c form, so it's not worth trying to give a direct link.
1994 See the ``Keyword Substitution'' section in the CVS manual, available
1995 at @url{http://ximbiot.com/cvs/manual}.
1997 In Texinfo source, the recommended way to literally specify a
1998 ``dollar'' keyword is:
2004 The @code{@@w} prevents keyword expansion in the Texinfo source
2005 itself. Also, @code{makeinfo} notices the @code{@@w} and generates
2006 output avoiding the literal keyword string.
2009 @node Ethical and Philosophical Consideration
2010 @chapter Ethical and Philosophical Consideration
2014 The GNU project takes a strong stand for software freedom. Many
2015 times, this means you'll need to avoid certain technologies when their
2016 use would conflict with our long-term goals.
2018 Software patents threaten the advancement of free software and freedom
2019 to program. There are so many software patents in the US that any
2020 large program probably implements hundreds of patented techniques,
2021 unknown to the program's developers. It would be futile and
2022 self-defeating to try to find and avoid all these patents. But there
2023 are some patents which we know are likely to be used to threaten free
2024 software, so we make an effort to avoid the patented techniques. If
2025 you are concerned about the danger of a patent and would like advice,
2026 write to @email{licensing@@gnu.org}, and we will try to help you get
2027 advice from a lawyer.
2029 Sometimes the GNU project takes a strong stand against a particular
2030 patented technology in order to encourage society to reject it.
2032 For example, the MP3 audio format is covered by a software patent in
2033 the USA and some other countries. A patent holder has threatened
2034 lawsuits against the developers of free programs (these are not GNU
2035 programs) to produce and play MP3, and some GNU/Linux distributors are
2036 afraid to include them. Development of the programs continues, but we
2037 campaign for the rejection of MP3 format in favor of Ogg Vorbis format.
2039 A GNU package should not recommend use of any non-free program, nor
2040 should it require a non-free program (such as a non-free compiler or
2041 IDE) to build. Thus, a GNU package cannot be written in a programming
2042 language that does not have a free software implementation. Now that
2043 GNU/Linux systems are widely available, all GNU packages should
2044 provide full functionality on a 100% free GNU/Linux system, and should
2045 not require any non-free software to build or function.
2046 The GNU Coding Standards say a lot more about this issue.
2048 A GNU package should not refer the user to any non-free documentation
2049 for free software. The need for free documentation to come with free
2050 software is now a major focus of the GNU project; to show that we are
2051 serious about the need for free documentation, we must not contradict
2052 our position by recommending use of documentation that isn't free.
2054 Finally, new issues concerning the ethics of software freedom come up
2055 frequently. We ask that GNU maintainers, at least on matters that
2056 pertain specifically to their package, stand with the rest of the GNU
2057 project when such issues come up.
2061 @chapter Terminology Issues
2064 This chapter explains a couple of issues of terminology which are
2065 important for correcting two widespread and important misunderstandings
2069 * Free Software and Open Source::
2073 @node Free Software and Open Source
2074 @section Free Software and Open Source
2075 @cindex free software movement
2077 @cindex movement, free software
2078 @cindex development method, open source
2080 The terms ``free software'' and ``open source'', while describing
2081 almost the same category of software, stand for views based on
2082 fundamentally different values. The free software movement is
2083 idealistic, and raises issues of freedom, ethics, principle and what
2084 makes for a good society. The term open source, initiated in 1998, is
2085 associated with a philosophy which studiously avoids such questions.
2086 For a detailed explanation, see
2087 @url{http://www.gnu.org/philosophy/open-source-misses-the-point.html}.
2089 The GNU Project is aligned with the free software movement. This
2090 doesn't mean that all GNU contributors and maintainers have to agree;
2091 your views on these issues are up to you, and you're entitled to express
2092 them when speaking for yourself.
2094 However, due to the much greater publicity that the term ``open source''
2095 receives, the GNU Project needs to overcome a widespread
2096 mistaken impression that GNU is @emph{and always was} an ``open
2097 source'' activity. For this reason, please use the term ``free
2098 software'', not ``open source'', in GNU software releases, GNU
2099 documentation, and announcements and articles that you publish in your
2100 role as the maintainer of a GNU package. A reference to the URL given
2101 above, to explain the difference, is a useful thing to include as
2106 @section GNU and Linux
2110 The GNU Project was formed to develop a free Unix-like operating system,
2111 GNU. The existence of this system is our major accomplishment.
2112 However, the widely used version of the GNU system, in which Linux is
2113 used as the kernel, is often called simply ``Linux''. As a result, most
2114 users don't know about the GNU Project's major accomplishment---or more
2115 precisely, they know about it, but don't realize it is the GNU Project's
2116 accomplishment and reason for existence. Even people who believe they
2117 know the real history often believe that the goal of GNU was to develop
2118 ``tools'' or ``utilities''.
2120 To correct this confusion, we have made a years-long effort to
2121 distinguish between Linux, the kernel that Linus Torvalds wrote, and
2122 GNU/Linux, the operating system that is the combination of GNU and
2123 Linux. The resulting increased awareness of what the GNU Project has
2124 already done helps every activity of the GNU Project recruit more
2125 support and contributors.
2127 Please make this distinction consistently in GNU software releases, GNU
2128 documentation, and announcements and articles that you publish in your
2129 role as the maintainer of a GNU package. If you want to explain the
2130 terminology and its reasons, you can refer to the URL
2131 @url{http://www.gnu.org/gnu/linux-and-gnu.html}.
2133 To make it clear that Linux is a kernel, not an operating system,
2134 please take care to avoid using the term ``Linux system'' in those
2135 materials. If you want to have occasion to make a statement about
2136 systems in which the kernel is Linux, write ``systems in which the
2137 kernel is Linux'' or ``systems with Linux as the kernel.'' That
2138 explicitly contrasts the system and the kernel, and will help readers
2139 understand the difference between the two. Please avoid simplified
2140 forms such as ``Linux-based systems'' because those fail to highlight
2141 the difference between the kernel and the system, and could encourage
2142 readers to overlook the distinction.
2144 To contrast the GNU system properly with respect to GNU/Linux, you can
2145 call it ``GNU/Hurd'' or ``the GNU/Hurd system''. However, when that
2146 contrast is not specifically the focus, please call it just ``GNU'' or
2149 When referring to the collection of servers that is the higher level
2150 of the GNU kernel, please call it ``the Hurd'' or ``the GNU Hurd''.
2151 Note that this uses a space, not a slash.
2156 @cindex CVS repository
2158 @cindex source repository
2159 @cindex version control system
2161 @cindex release site
2164 We recommend using @code{savannah.gnu.org} for the source code
2165 repository for your package, but that's not required. @xref{Old
2166 Versions}, for more information about Savannah.
2168 We strongly urge you to use @code{ftp.gnu.org} as the standard
2169 distribution site for releases. Doing so makes it easier for
2170 developers and users to find the latest GNU releases. However, it is
2171 ok to use another server if you wish, provided it allows access from
2172 the general public without limitation (for instance, without excluding
2175 If you use a company's machine to hold the repository for your
2176 program, or as its release distribution site, please put this
2177 statement in a prominent place on the site, so as to prevent people
2178 from getting the wrong idea about the relationship between the package
2182 The programs <list of them> hosted here are free software packages
2183 of the GNU Project, not products of <company name>. We call them
2184 "free software" because you are free to copy and redistribute them,
2185 following the rules stated in the license of each package. For more
2186 information, see http://www.gnu.org/philosophy/free-sw.html.
2188 If you are looking for service or support for GNU software, see
2189 http://www.gnu.org/gethelp/ for suggestions of where to ask.
2191 If you would like to contribute to the development of one of these
2192 packages, contact the package maintainer or the bug-reporting address
2193 of the package (which should be listed in the package itself), or look
2194 on www.gnu.org for more information on how to contribute.
2200 @cindex Donations, for packages
2201 @cindex Money, donated to packages
2203 As a maintainer, you might want to accept donations for your work,
2204 especially if you pay for any of your own hosting/development
2205 infrastructure. Following is some text you can adapt to your own
2206 situation, and use on your package's web site, @file{README}, or
2207 in wherever way you find it useful:
2210 We appreciate contributions of any size -- donations enable us to spend
2211 more time working on the project, and help cover our infrastructure
2214 If you'd like to make a small donation, please visit @var{url1} and do
2215 it through @var{payment-service}. Since our project isn't a
2216 tax-exempt organization, we can't offer you a tax deduction, but for
2217 all donations over @var{amount1}, we'd be happy to recognize your
2218 contribution on @var{url2}.
2220 We are also happy to consider making particular improvements or
2221 changes, or giving specific technical assistance, in return for a
2222 substantial donation over @var{amount2}. If you would like to discuss
2223 this possibility, write to us at @var{address}.
2225 Another possibility is to pay a software maintenance fee. Again,
2226 write to us about this at @var{address} to discuss how much you want
2227 to pay and how much maintenance we can offer in return. If you pay
2228 more than @var{amount1}, we can give you a document for your records.
2230 Thanks for your support!
2233 We don't recommend any specific payment service. However, GNU
2234 developers should not use a service that requires them to sign a
2235 proprietary software license, such as Google's payment service.
2237 Of course, it is also good to encourage people to join or contribute
2238 to the FSF (@url{http://www.fsf.org}), either instead of or as well as
2239 package-specific donations.
2242 @node Free Software Directory
2243 @chapter Free Software Directory
2244 @cindex Free Software Directory
2245 @cindex Directory, Free Software
2247 The Free Software Directory aims to be a complete list of free
2248 software packages, within certain criteria. Every GNU package should
2249 be listed there, so please see
2250 @url{http://www.gnu.org/help/directory.html#adding-entries} for
2251 information on how to write an entry for your package. Contact
2252 @email{bug-directory@@gnu.org} with any questions or suggestions for
2253 the Free Software Directory.
2256 @node Using the Proofreaders List
2257 @chapter Using the Proofreaders List
2258 @cindex proofreading
2260 If you want help finding errors in documentation,
2261 or help improving the quality of writing,
2262 or if you are not a native speaker of English
2263 and want help producing good English documentation,
2264 you can use the GNU proofreaders mailing list:
2265 @email{proofreaders@@gnu.org}.
2267 But be careful when you use the list,
2268 because there are over 200 people on it.
2269 If you simply ask everyone on the list to read your work,
2270 there will probably be tremendous duplication of effort
2271 by the proofreaders,
2272 and you will probably get the same errors reported 100 times.
2273 This must be avoided.
2275 Also, the people on the list do not want to get
2276 a large amount of mail from it.
2277 So do not ever ask people on the list to send mail to the list!
2279 Here are a few methods that seem reasonable to use:
2283 For something small, mail it to the list,
2284 and ask people to pick a random number from 1 to 20,
2285 and read it if the number comes out as 10.
2286 This way, assuming 50% response, some 5 people will read the piece.
2289 For a larger work, divide your work into around 20 equal-sized parts,
2290 tell people where to get it,
2291 and ask each person to pick randomly which part to read.
2293 Be sure to specify the random choice procedure;
2294 otherwise people will probably use a mental procedure
2295 that is not really random,
2296 such as ``pick a part near the middle'',
2297 and you will not get even coverage.
2299 You can either divide up the work physically, into 20 separate files,
2300 or describe a virtual division, such as by sections
2301 (if your work has approximately 20 sections).
2302 If you do the latter, be sure to be precise about it---for example,
2303 do you want the material before the first section heading
2304 to count as a section, or not?
2307 For a job needing special skills, send an explanation of it,
2308 and ask people to send you mail if they volunteer for the job.
2309 When you get enough volunteers, send another message to the list saying
2310 ``I have enough volunteers, no more please.''
2314 @node GNU Free Documentation License
2315 @appendix GNU Free Documentation License
2317 @cindex FDL, GNU Free Documentation License
2328 eval: (add-hook 'write-file-hooks 'time-stamp)
2329 time-stamp-start: "@set lastupdate "
2330 time-stamp-start: "@set lastupdate "
2332 time-stamp-format: "%:b %:d, %:y"
2333 compile-command: "make -C work.m"