* info/dir: Start descriptions in column 32, per Texinfo convention.
[emacs.git] / admin / README
blob694f206baaf92aca8f04722203d2a5ea230d8cfc
1 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2   2010  Free Software Foundation, Inc.
3 See the end of the file for license conditions.
6                          The admin directory
8 This directory contains scripts and other things useful for developing
9 and maintaining Emacs.  These files are not part of Emacs releases
10 because they are not deemed generally useful, and you have to know
11 what you do when using them.
14 * Instructions and scripts used to prepare an Emacs release.
16 ** FOR-RELEASE
18 Living list of activities that must be completed before the next release.
20 ** make-tarball.txt
22 Instructions to create pretest or release tarballs, annoucements, etc.
24 ** admin.el
26 Utilities for setting version numbers and alike.
28 ** make-announcement, make-changelog-diff
30 Scripts used to prepare release announcements.
33 * Scripts that can be used to build and test Emacs.
35 ** build-configs
37 Build Emacs in various configurations.
39 ** make-emacs
41 Build Emacs in various ways.
43 ** quick-install-emacs
45 Install emacs quickly (`incrementally').
47 ** alloc-colors.c
49 A utility program that allocates a given number of colors on X.  Can
50 be used to debug Emacs with dense colormaps (PseudoColor).
52 ** check-doc-strings
54 Check doc strings against documentation.
56 ** cus-test.el
58 Tests for custom types and load problems.
60 ** diff-tar-files
62 Show files added/removed between two tar files.
65 Brief description of sub-directories:
67 charsets                scripts for generating charset map files
68                         in ../etc/charsets
69 unidata                 scripts for generating character property files
70                         in ../lisp/international
73 This file is part of GNU Emacs.
75 GNU Emacs is free software: you can redistribute it and/or modify
76 it under the terms of the GNU General Public License as published by
77 the Free Software Foundation, either version 3 of the License, or
78 (at your option) any later version.
80 GNU Emacs is distributed in the hope that it will be useful,
81 but WITHOUT ANY WARRANTY; without even the implied warranty of
82 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
83 GNU General Public License for more details.
85 You should have received a copy of the GNU General Public License
86 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
88 Local variables:
89 mode: outline
90 paragraph-separate: "[  \f]*$"
91 end:
93 # arch-tag: 812b9461-bc0a-46a7-925e-24bd41118463