emacs/admin/README

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

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

** 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		patches to make coccinelle work with
			the latest Emacs version.  Since they
			apply a few minor changes in Emacs internals
			in multiple places, they are trivial for
			copyright purposes.
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:
-												; Add 2022 to copyright years.

											
										
										
											2022-01-01 07:45:51 +00:00
+								Copyright (C) 2001-2022 Free Software Foundation, Inc.
-												Add copyright and license notices.

											
										
										
											2007-02-11 00:47:36 +00:00
+								See the end of the file for license conditions.
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
+											 The admin directory
-												*** empty log message ***

											
										
										
											2001-08-20 10:02:30 +00:00
+								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.
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
 								* Instructions and scripts used to prepare an Emacs release.
-												Backport: Document the release process

* admin/notes/versioning: Add information about RC releases.
* admin/release-process: Document the release process.
* admin/authors.el (authors-ignored-files):
* admin/README: Change FOR-RELEASE to release-process.
* CONTRIBUTE:
* admin/notes/bugtracker: Don't mention FOR-RELEASE.

(cherry picked from commit 9a4aa0f5945a03611ae29c516025dbd353bd26ab)

											
										
										
											2015-11-15 01:35:50 +00:00
+								** release-process
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
-												Backport: Document the release process

* admin/notes/versioning: Add information about RC releases.
* admin/release-process: Document the release process.
* admin/authors.el (authors-ignored-files):
* admin/README: Change FOR-RELEASE to release-process.
* CONTRIBUTE:
* admin/notes/bugtracker: Don't mention FOR-RELEASE.

(cherry picked from commit 9a4aa0f5945a03611ae29c516025dbd353bd26ab)

											
										
										
											2015-11-15 01:35:50 +00:00
+								The release process used by GNU Emacs.
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
 								** make-tarball.txt
-												Spelling fixes.

											
										
										
											2011-11-14 23:59:56 +00:00
+								Instructions to create pretest or release tarballs, announcements, etc.
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
 								** 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
-												Prefer straight quoting in some text files

Mostly this just changes ` to ' in static text.  Some exceptions:
* INSTALL.REPO: Use curved quotes, as the diagnostic in question
typically does that now.
* admin/quick-install-emacs (TRY, top level):
Use straight quoting in diagnostics.
* src/README: Fix working-directory confusion.

											
										
										
											2015-09-11 18:04:24 +00:00
+								Install emacs quickly ("incrementally").
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
-												* README: Minor fixes.

											
										
										
											2010-02-18 09:11:18 +00:00
+								** alloc-colors.c
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
 								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.
-												Switch to recommended form of GPLv3 permissions notice.

											
										
										
											2008-05-09 23:48:10 +00:00
+								Brief description of sub-directories:
 								charsets		scripts for generating charset map files
 											in ../etc/charsets
-												; * admin/README: Add descriptions of more subdirectories.

											
										
										
											2021-09-08 08:26:17 +00:00
+								coccinelle		patches to make coccinelle work with
 											the latest Emacs version.  Since they
 											apply a few minor changes in Emacs internals
 											in multiple places, they are trivial for
 											copyright purposes.
 								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.
-												Switch to recommended form of GPLv3 permissions notice.

											
										
										
											2008-05-09 23:48:10 +00:00
+								unidata			scripts for generating character property files
-												; * admin/README: Add descriptions of more subdirectories.

											
										
										
											2021-09-08 08:26:17 +00:00
+											in ../lisp/international/.
-												Switch to recommended form of GPLv3 permissions notice.

											
										
										
											2008-05-09 23:48:10 +00:00
-												Add copyright and license notices.

											
										
										
											2007-02-11 00:47:36 +00:00
 								This file is part of GNU Emacs.
-												Switch to recommended form of GPLv3 permissions notice.

											
										
										
											2008-05-09 23:48:10 +00:00
+								GNU Emacs is free software: you can redistribute it and/or modify
-												Add copyright and license notices.

											
										
										
											2007-02-11 00:47:36 +00:00
+								it under the terms of the GNU General Public License as published by
-												Switch to recommended form of GPLv3 permissions notice.

											
										
										
											2008-05-09 23:48:10 +00:00
+								the Free Software Foundation, either version 3 of the License, or
 								(at your option) any later version.
-												Add copyright and license notices.

											
										
										
											2007-02-11 00:47:36 +00:00
 								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
-												Prefer HTTPS to FTP and HTTP in documentation

Most of this change is to boilerplate commentary such as license URLs.
This change was prompted by ftp://ftp.gnu.org's going-away party,
planned for November.  Change these FTP URLs to https://ftp.gnu.org
instead.  Make similar changes for URLs to other organizations moving
away from FTP.  Also, change HTTP to HTTPS for URLs to gnu.org and
fsf.org when this works, as this will further help defend against
man-in-the-middle attacks (for this part I omitted the MS-DOS and
MS-Windows sources and the test tarballs to keep the workload down).
HTTPS is not fully working to lists.gnu.org so I left those URLs alone
for now.

											
										
										
											2017-09-13 22:52:52 +00:00
+								along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
-												Use outline format.  Add FOR-RELEASE.

											
										
										
											2006-07-08 23:45:09 +00:00
 								Local variables:
 								mode: outline
 								paragraph-separate: "[ 	]*$"
 								end: