merge trunk
[bpt/emacs.git] / admin / README
1 Copyright (C) 2001-2012 Free Software Foundation, Inc.
2 See the end of the file for license conditions.
3
4
5 The admin directory
6
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.
11
12
13 * Instructions and scripts used to prepare an Emacs release.
14
15 ** FOR-RELEASE
16
17 Living list of activities that must be completed before the next release.
18
19 ** make-tarball.txt
20
21 Instructions to create pretest or release tarballs, announcements, etc.
22
23 ** admin.el
24
25 Utilities for setting version numbers and alike.
26
27 ** make-announcement, make-changelog-diff
28
29 Scripts used to prepare release announcements.
30
31
32 * Scripts that can be used to build and test Emacs.
33
34 ** build-configs
35
36 Build Emacs in various configurations.
37
38 ** make-emacs
39
40 Build Emacs in various ways.
41
42 ** quick-install-emacs
43
44 Install emacs quickly (`incrementally').
45
46 ** alloc-colors.c
47
48 A utility program that allocates a given number of colors on X. Can
49 be used to debug Emacs with dense colormaps (PseudoColor).
50
51 ** check-doc-strings
52
53 Check doc strings against documentation.
54
55 ** cus-test.el
56
57 Tests for custom types and load problems.
58
59 ** diff-tar-files
60
61 Show files added/removed between two tar files.
62
63
64 Brief description of sub-directories:
65
66 charsets scripts for generating charset map files
67 in ../etc/charsets
68 unidata scripts for generating character property files
69 in ../lisp/international
70
71 \f
72 This file is part of GNU Emacs.
73
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.
78
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.
83
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/>.
86 \f
87 Local variables:
88 mode: outline
89 paragraph-separate: "[ \f]*$"
90 end: