declare smobs in alloc.c
[bpt/emacs.git] / admin / README
1 Copyright (C) 2001-2014 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
28 * Scripts that can be used to build and test Emacs.
29
30 ** build-configs
31
32 Build Emacs in various configurations.
33
34 ** make-emacs
35
36 Build Emacs in various ways.
37
38 ** quick-install-emacs
39
40 Install emacs quickly (`incrementally').
41
42 ** alloc-colors.c
43
44 A utility program that allocates a given number of colors on X. Can
45 be used to debug Emacs with dense colormaps (PseudoColor).
46
47 ** check-doc-strings
48
49 Check doc strings against documentation.
50
51 ** cus-test.el
52
53 Tests for custom types and load problems.
54
55 ** diff-tar-files
56
57 Show files added/removed between two tar files.
58
59
60 Brief description of sub-directories:
61
62 charsets scripts for generating charset map files
63 in ../etc/charsets
64 unidata scripts for generating character property files
65 in ../lisp/international
66
67 \f
68 This file is part of GNU Emacs.
69
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.
74
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.
79
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/>.
82 \f
83 Local variables:
84 mode: outline
85 paragraph-separate: "[ \f]*$"
86 end: