etc/TODO small updates
[emacs.git] / admin / README
blobd696a14176ee8680608f2ae635fc604b457a0697
1 Copyright (C) 2001-2013 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, announcements, etc.
23 ** admin.el
25 Utilities for setting version numbers and alike.
28 * Scripts that can be used to build and test Emacs.
30 ** build-configs
32 Build Emacs in various configurations.
34 ** make-emacs
36 Build Emacs in various ways.
38 ** quick-install-emacs
40 Install emacs quickly (`incrementally').
42 ** alloc-colors.c
44 A utility program that allocates a given number of colors on X.  Can
45 be used to debug Emacs with dense colormaps (PseudoColor).
47 ** check-doc-strings
49 Check doc strings against documentation.
51 ** cus-test.el
53 Tests for custom types and load problems.
55 ** diff-tar-files
57 Show files added/removed between two tar files.
60 Brief description of sub-directories:
62 charsets                scripts for generating charset map files
63                         in ../etc/charsets
64 unidata                 scripts for generating character property files
65                         in ../lisp/international
68 This file is part of GNU Emacs.
70 GNU Emacs is free software: you can redistribute it and/or modify
71 it under the terms of the GNU General Public License as published by
72 the Free Software Foundation, either version 3 of the License, or
73 (at your option) any later version.
75 GNU Emacs is distributed in the hope that it will be useful,
76 but WITHOUT ANY WARRANTY; without even the implied warranty of
77 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
78 GNU General Public License for more details.
80 You should have received a copy of the GNU General Public License
81 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
83 Local variables:
84 mode: outline
85 paragraph-separate: "[  \f]*$"
86 end: