diff --git a/admin/README b/admin/README index e5116fcbaa3..008717bcee5 100644 --- a/admin/README +++ b/admin/README @@ -1,21 +1,71 @@ + 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. -Brief description of scripts found here: -admin.el utilities for setting version numbers and alike -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). -build-configs build Emacs in various configurations -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 -make-emacs build Emacs in various ways -make-tarball.txt instructions to create pretest or release tarballs -quick-install-emacs install emacs quickly (`incrementally') -revdiff get CVS diffs of files +* 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. + + + + +Local variables: +mode: outline +paragraph-separate: "[ ]*$" +end: # arch-tag: 812b9461-bc0a-46a7-925e-24bd41118463