admin/README

   1 Copyright (C) 2001-2024 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 ** release-process
  16
  17 The release process used by GNU Emacs.
  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 ** run-codespell
  43
  44 Run the codespell tool on the Emacs sources.  Requires codespell to be
  45 installed first.
  46
  47 ** alloc-colors.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
  65 * Brief description of sub-directories.
  66
  67 charsets                scripts for generating charset map files
  68                         in ../etc/charsets
  69 coccinelle              semantic patches for use with the static code
  70                         analyzer coccinelle.  Since they apply a few
  71                         minor changes in Emacs internals in multiple
  72                         places, they are trivial for copyright
  73                         purposes.
  74 codespell               supporting files for the run-codespell script.
  75 grammars                wisent and bovine grammars, used to produce
  76                         files in lisp/cedet/.
  77 notes                   miscellaneous notes related to administrative
  78                         tasks.
  79 nt                      support files for administrative tasks related
  80                         to building MS-Windows distributions.
  81 unidata                 scripts for generating character property files
  82                         in ../lisp/international/.
  83
  84 \f
  85 This file is part of GNU Emacs.
  86
  87 GNU Emacs is free software: you can redistribute it and/or modify
  88 it under the terms of the GNU General Public License as published by
  89 the Free Software Foundation, either version 3 of the License, or
  90 (at your option) any later version.
  91
  92 GNU Emacs is distributed in the hope that it will be useful,
  93 but WITHOUT ANY WARRANTY; without even the implied warranty of
  94 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  95 GNU General Public License for more details.
  96
  97 You should have received a copy of the GNU General Public License
  98 along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
  99 \f
 100 Local variables:
 101 mode: outline
 102 paragraph-separate: "[  \f]*$"
 103 end: