gnu.emacs/admin

Copyright (C) 2001-2026 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.

** release-process

The release process used by GNU Emacs.

** make-tarball.txt

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

** admin.el

Utilities for setting version numbers and alike.


* 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").

** run-codespell

Run the codespell tool on the Emacs sources.  Requires codespell to be
installed first.

** alloc-colors.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.

** cl-lib-deps-report.el

Audit Lisp files for cl-lib usage and missing requires.

** cus-test.el

Tests for custom types and load problems.

** diff-tar-files

Show files added/removed between two tar files.


* Brief description of sub-directories.

charsets		scripts for generating charset map files
			in ../etc/charsets
coccinelle		semantic patches for use with the static code
			analyzer coccinelle.  Since they apply a few
			minor changes in Emacs internals in multiple
			places, they are trivial for copyright
			purposes.
codespell		supporting files for the run-codespell script.
grammars		wisent and bovine grammars, used to produce
			files in lisp/cedet/.
notes			miscellaneous notes related to administrative
			tasks.
nt			support files for administrative tasks related
			to building MS-Windows distributions.
unidata			scripts for generating character property files
			in ../lisp/international/.


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 <https://www.gnu.org/licenses/>.

Local variables:
mode: outline
paragraph-separate: "[ 	]*$"
end: