Menu
▾
▴
CVS: htdocs/doc devguide.texi,1.25,1.26
|
From: Bill W. <wo...@us...> - 2003-02-03 21:38:59
|
Update of /cvsroot/mh-e/htdocs/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv25859/doc
Modified Files:
devguide.texi
Log Message:
(Updating the Tracker): Fixed URLs.
(Updating the Emacs Repository): Changes reflecting the new mh-e
directory in the Emacs repository. Added notes about announcement to
the emacs-devel mailing list.
(News): Updated notes about the News and mh-e-announce announcements.
Index: devguide.texi
===================================================================
RCS file: /cvsroot/mh-e/htdocs/doc/devguide.texi,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -d -r1.25 -r1.26
--- devguide.texi 3 Feb 2003 19:57:04 -0000 1.25
+++ devguide.texi 3 Feb 2003 21:38:53 -0000 1.26
@@ -1412,6 +1412,11 @@
@uref{http://mail.gnu.org/mailman/listinfo/emacs-devel, Mailman
interface} to subscribe.
+This procedure must be performed before any changes have been made to
+the MH-E source since the release. This can be easily accomplished in
+by checking out the module with a sticky tag and should be done in any
+case.
+
@cindex CVS, co
First, check out the Emacs source:
@@ -1420,6 +1425,12 @@
cvs -d :ext:$USER@@cvs.gnu.org:/cvsroot co emacs
@end example
+If the Emacs source has already been checked out, ensure that the MH-E
+source is not locally modified. This is essential for the next step to
+proceed accurately. If the install-emacs step described below had been
+performed during testing leading up to the release, remove the
+modified MH-E files and run @code{cvs update} again.
+
@cindex import-emacs
@cindex Makefile targets, import-emacs
@@ -1446,7 +1457,7 @@
@end example
The @code{install-emacs} target copies the lisp files to
-@file{$EMACS_HOME/lisp/mail} and copies @file{MH-E-NEWS} to
+@file{$EMACS_HOME/lisp/mh-e} and copies @file{MH-E-NEWS} to
@file{$EMACS_HOME/etc}.
@cindex EMACS_HOME
@@ -1465,20 +1476,11 @@
This target copies @file{mh-e.texi} to @file{$EMACS_HOME/man}.
-Update @code{$EMACS_HOME/lisp/ChangeLog},
-@code{$EMACS_HOME/etc/ChangeLog}, and
+Update @code{$EMACS_HOME/etc/ChangeLog} and
@code{$EMACS_HOME/man/ChangeLog}. Simply cite the MH-E release. For
example:
@example
- * mail/mh-comp.el, mail/mh-e.el, mail/mh-funcs.el,
- mail/mh-mime.el, mail/mh-pick.el, mail/mh-seq.el, mail/mh-utils.el,
- mail/mh-xemacs-compat.el: Upgraded to MH-E version 6.1.
-@end example
-
-and
-
-@example
* MH-E-NEWS: Upgraded to MH-E version 6.1.
@end example
@@ -1488,14 +1490,6 @@
* mh-e.texi: Upgraded to MH-E documentation version 1.3.
@end example
-Run
-
-@example
- cvs update
-@end example
-
-in the Emacs directory to see which files to list in these files.
-
Update @code{$EMACS_HOME/etc/NEWS} by adding text similar to the
following:
@@ -1515,19 +1509,33 @@
Then check in the files like this:
@example
- cvs ci -m"Upgraded to MH-E version 6.1."
+ cvs ci -m"Upgraded to MH-E version 6.1.
+ See etc/MH-E-NEWS and lisp/mh-e/ChangeLog for details."
@end example
@cindex emacs-devel
@cindex mailing lists, emacs-devel
-Send a note to @i{emacs-devel@@gnu.org} with the details.
+Send a note to @i{emacs-devel@@gnu.org} with the details. The first
+paragraph should include the first sentence from the description on
+the @uref{https://sourceforge.net/projects/mh-e/, Summary} page,
+Emacs-specific verbiage, and the text:
+
+@example
+ Read on for more details.
+@end example
+
+The second paragraph should contain:
+
+@example
+ Project home page at: http://mh-e.sourceforge.net/.
+@end example
+
+Finally, append the release notes.
After checking MH-E into Emacs, run @code{make import-emacs} a second
time to put the new code on the Emacs branch. This makes it possible
-to detect changes to MH-E that an Emacs developer may make later. Do
-this before any changes have been made to the MH-E CVS repository or
-check out the module with a sticky tag to minimize conflicts.
+to detect changes to MH-E that an Emacs developer may make later.
@node Updating the Debian Package, Updating the Online Documentation, Updating the Emacs Repository, File Releases
@section Updating the Debian Package
@@ -1650,17 +1658,23 @@
@chapter News
@cindex News
+
@cindex mh-e-announce
@cindex mailing lists, mh-e-announce
+@cindex emacs-devel
+@cindex mailing lists, emacs-devel
-Generally speaking, news items are submitted to both
-@uref{http://sourceforge.net/news/?group_id=13357, News} and
-@i{mh-e-announce@@lists.sourceforge.net}. The document
+Announcements about new releases are submitted
+@uref{http://sourceforge.net/news/?group_id=13357, at SourceForge}, to
+@i{mh-e-announce@@lists.sourceforge.net}, and to
+@i{emacs-devel@@gnu.org}.
+
+The document
@uref{https://sourceforge.net/docman/display_doc.php?docid=12834&group_id=1,
Using Project News with Step-by-Step Instructions} is helpful when
composing your news item.
-Specifically, use the following template for the subject:
+In all cases, use the following template for the subject:
@example
MH-E m.n.p released
@@ -1669,12 +1683,17 @@
@end example
As only the first paragraph is shown on the SourceForge front page, it
-should be written wisely. The first sentence should be the same as the
-first sentence in the description on the
+should be written wisely. Emulate the look and feel of previous news
+postings. The first sentence should be the same as the first sentence
+in the description on the
@uref{https://sourceforge.net/projects/mh-e/, Summary} page. The
-second sentence should briefly describe the benefit of the release or
-otherwise entice the reader to read further. Emulate the look and feel
-of previous news postings.
+following sentences are typically copied from the first paragraph of
+the release notes and should briefly describe the benefit of the
+release or otherwise entice the reader to read further. Add the text:
+
+@example
+ Read on for more details.
+@end example
Use the following for the second paragraph:
@@ -1686,6 +1705,20 @@
Note that your news posting may be shown on the SourceForge front
page, so discretion is advised.
+
+The announcement that is sent to the @i{mh-e-announce} mailing list
+doesn't have the same first-paragraph restrictions as does the
+SourceForge news item. Therefore, the announcement should contain the
+text:
+
+@example
+ Project home page at: http://mh-e.sourceforge.net/.
+@end example
+
+followed by the release notes.
+
+The Emacs announcement is described in @ref{Updating the Emacs
+Repository}.
@node Project Home Page, Surveys, News, Top
@chapter Project Home Page
|