Merge.
[emacs.git] / admin / README
blob4dd1705fe74b603e995334ee6abb204358e70429
1 Copyright (C) 2001-2011  Free Software Foundation, Inc.
2 See the end of the file for license conditions.
5                          The admin directory
7 This directory contains scripts and other things useful for developing
8 and maintaining Emacs.  These files are not part of Emacs releases
9 because they are not deemed generally useful, and you have to know
10 what you do when using them.
13 * Instructions and scripts used to prepare an Emacs release.
15 ** FOR-RELEASE
17 Living list of activities that must be completed before the next release.
19 ** make-tarball.txt
21 Instructions to create pretest or release tarballs, annoucements, etc.
23 ** admin.el
25 Utilities for setting version numbers and alike.
27 ** make-announcement, make-changelog-diff
29 Scripts used to prepare release announcements.
32 * Scripts that can be used to build and test Emacs.
34 ** build-configs
36 Build Emacs in various configurations.
38 ** make-emacs
40 Build Emacs in various ways.
42 ** quick-install-emacs
44 Install emacs quickly (`incrementally').
46 ** alloc-colors.c
48 A utility program that allocates a given number of colors on X.  Can
49 be used to debug Emacs with dense colormaps (PseudoColor).
51 ** check-doc-strings
53 Check doc strings against documentation.
55 ** cus-test.el
57 Tests for custom types and load problems.
59 ** diff-tar-files
61 Show files added/removed between two tar files.
64 Brief description of sub-directories:
66 charsets                scripts for generating charset map files
67                         in ../etc/charsets
68 unidata                 scripts for generating character property files
69                         in ../lisp/international
72 This file is part of GNU Emacs.
74 GNU Emacs is free software: you can redistribute it and/or modify
75 it under the terms of the GNU General Public License as published by
76 the Free Software Foundation, either version 3 of the License, or
77 (at your option) any later version.
79 GNU Emacs is distributed in the hope that it will be useful,
80 but WITHOUT ANY WARRANTY; without even the implied warranty of
81 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
82 GNU General Public License for more details.
84 You should have received a copy of the GNU General Public License
85 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
87 Local variables:
88 mode: outline
89 paragraph-separate: "[  \f]*$"
90 end: