aboutsummaryrefslogtreecommitdiffstats
path: root/admin/release-process
diff options
context:
space:
mode:
Diffstat (limited to 'admin/release-process')
-rw-r--r--admin/release-process22
1 files changed, 13 insertions, 9 deletions
diff --git a/admin/release-process b/admin/release-process
index d66bc48f70d..7240ff10a29 100644
--- a/admin/release-process
+++ b/admin/release-process
@@ -90,7 +90,8 @@ documentation (or decide no updates are necessary) for those that aren't.
90 90
91** Try to reorder NEWS: most important things first, related items together. 91** Try to reorder NEWS: most important things first, related items together.
92 92
93** For a major release, add a "New in Emacs XX" section to faq.texi. 93** For a major release, add a "New in Emacs XX" section to efaq.texi.
94This should highlight some of the more significant changes.
94 95
95** cusver-check from admin.el can help find new defcustoms missing 96** cusver-check from admin.el can help find new defcustoms missing
96:version tags. This asks for new and old Lisp directories; use the one 97:version tags. This asks for new and old Lisp directories; use the one
@@ -113,14 +114,14 @@ Check for node names using problematic characters:
113Sadly makeinfo does not warn about such characters. 114Sadly makeinfo does not warn about such characters.
114 115
115Check for major new features added since the last release (e.g. new 116Check for major new features added since the last release (e.g. new
116lisp files), and add the relevant authors to the Acknowledgments in 117Lisp files), and add the relevant authors to the Acknowledgments in
117doc/emacs/ack.texi and emacs.texi. To find new files, you could run a 118doc/emacs/ack.texi and emacs.texi. To find new files, you could run a
118command such as this: 119command such as this:
119 120
120 $ diff -rq emacs-NN.MM emacs-XX.YY | grep "^Only in emacs-XX" 121 $ git diff --name-status emacs-NN emacs-XX | grep -E "^A"
121 122
122where NN.MM is the previous Emacs version, and XX.YY is the new version. 123where emacs-NN is the previous Emacs release branch, and emacs-XX is the
123This assumes you have the source trees of both versions available. 124new one.
124 125
125For major releases, rewrite the "Antinews" appendix of the User Manual 126For major releases, rewrite the "Antinews" appendix of the User Manual
126(doc/emacs/anti.texi) to describe features lost by downgrading to the 127(doc/emacs/anti.texi) to describe features lost by downgrading to the
@@ -129,10 +130,6 @@ significant changes and new features in the upcoming release, then
129describe the "benefits" from losing those features. Be funny, use 130describe the "benefits" from losing those features. Be funny, use
130humor. The text written for the previous releases can serve as an example. 131humor. The text written for the previous releases can serve as an example.
131 132
132The Emacs FAQ (doc/misc/efaq.texi) also has a "What's new" section;
133for major releases a new section should be added listing the
134significant changes.
135
136Check cross-references between the manuals (e.g. from emacs to elisp) 133Check cross-references between the manuals (e.g. from emacs to elisp)
137are correct. You can use something like the following in the info 134are correct. You can use something like the following in the info
138directory in the Emacs build tree: 135directory in the Emacs build tree:
@@ -225,6 +222,13 @@ https://publicsuffix.org/list/public_suffix_list.dat
225- leim/SKK-DIC/SKK-JISYO.L 222- leim/SKK-DIC/SKK-JISYO.L
226https://raw.githubusercontent.com/skk-dev/dict/master/SKK-JISYO.L 223https://raw.githubusercontent.com/skk-dev/dict/master/SKK-JISYO.L
227 224
225** Check for mistakes in man pages.
226
227The below script checks for any mistakes in the source text of
228manual pages. Fix any errors and re-run the script to verify.
229
230 ./admin/check-man-pages
231
228* BUGS 232* BUGS
229 233
230** Check for modes which bind M-s that conflicts with a new global binding M-s 234** Check for modes which bind M-s that conflicts with a new global binding M-s