[bpt/emacs.git] / admin / README

Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
  Free Software Foundation, Inc.
See the end of the file for license conditions.


			 The admin directory

This directory contains scripts and other things useful for developing
and maintaining Emacs.  These files are not part of Emacs releases
because they are not deemed generally useful, and you have to know
what you do when using them.


* Instructions and scripts used to prepare an Emacs release.

** FOR-RELEASE

Living list of activities that must be completed before the next release.

** make-tarball.txt

Instructions to create pretest or release tarballs, annoucements, etc.

** admin.el

Utilities for setting version numbers and alike.

** make-announcement, make-changelog-diff

Scripts used to prepare release announcements.


* Scripts that can be used to build and test Emacs.

** build-configs

Build Emacs in various configurations.

** make-emacs

Build Emacs in various ways.

** quick-install-emacs

Install emacs quickly (`incrementally').

** alloc-color.c

A utility program that allocates a given number of colors on X.  Can
be used to debug Emacs with dense colormaps (PseudoColor).

** check-doc-strings

Check doc strings against documentation.

** cus-test.el

Tests for custom types and load problems.

** diff-tar-files

Show files added/removed between two tar files.

** revdiff

Get CVS diffs of files.


Brief description of sub-directories:

charsets		scripts for generating charset map files
			in ../etc/charsets
unidata			scripts for generating character property files
			in ../lisp/international

\f
This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
\f
Local variables:
mode: outline
paragraph-separate: "[ 	\f]*$"
end:

# arch-tag: 812b9461-bc0a-46a7-925e-24bd41118463
Commit	Line	Data
114f9c96	1	Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
2f969cd4 GM	2	Free Software Foundation, Inc.
	3	See the end of the file for license conditions.
	4
	5
2eabd04f KS	6	The admin directory
2eabd04f KS	7
1c71c0c3 GM	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.
	12
2eabd04f KS	13
	14	* Instructions and scripts used to prepare an Emacs release.
	15
	16	** FOR-RELEASE
	17
	18	Living list of activities that must be completed before the next release.
	19
	20	** make-tarball.txt
	21
	22	Instructions to create pretest or release tarballs, annoucements, etc.
	23
	24	** admin.el
	25
	26	Utilities for setting version numbers and alike.
	27
	28	** make-announcement, make-changelog-diff
	29
	30	Scripts used to prepare release announcements.
	31
	32
	33	* Scripts that can be used to build and test Emacs.
	34
	35	** build-configs
	36
	37	Build Emacs in various configurations.
	38
	39	** make-emacs
	40
	41	Build Emacs in various ways.
	42
	43	** quick-install-emacs
	44
	45	Install emacs quickly (`incrementally').
	46
	47	** alloc-color.c
	48
	49	A utility program that allocates a given number of colors on X. Can
	50	be used to debug Emacs with dense colormaps (PseudoColor).
	51
	52	** check-doc-strings
	53
	54	Check doc strings against documentation.
	55
	56	** cus-test.el
	57
	58	Tests for custom types and load problems.
	59
	60	** diff-tar-files
	61
	62	Show files added/removed between two tar files.
	63
	64	** revdiff
	65
	66	Get CVS diffs of files.
	67
	68
9ad5de0c GM	69	Brief description of sub-directories:
	70
	71	charsets scripts for generating charset map files
	72	in ../etc/charsets
	73	unidata scripts for generating character property files
	74	in ../lisp/international
	75
2f969cd4 GM	76	\f
	77	This file is part of GNU Emacs.
	78
9ad5de0c	79	GNU Emacs is free software: you can redistribute it and/or modify
2f969cd4	80	it under the terms of the GNU General Public License as published by
9ad5de0c GM	81	the Free Software Foundation, either version 3 of the License, or
9ad5de0c GM	82	(at your option) any later version.
2f969cd4 GM	83
	84	GNU Emacs is distributed in the hope that it will be useful,
	85	but WITHOUT ANY WARRANTY; without even the implied warranty of
	86	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	87	GNU General Public License for more details.
	88
	89	You should have received a copy of the GNU General Public License
9ad5de0c	90	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
2eabd04f KS	91	\f
	92	Local variables:
	93	mode: outline
	94	paragraph-separate: "[ \f]*$"
	95	end:
8f924df7	96
6b61353c	97	# arch-tag: 812b9461-bc0a-46a7-925e-24bd41118463