Below are three examples of commit email notifications from CVS
and SVN, provided in order to gather feedback on what users would
like to see in these mails from the OpenSolaris SCMs.

The intention is to use the same hook script for all SCM systems
(SVN and Mercurial) and to have the email format be the same, or
as similar as possible, for all consolidations.

My personal preferences are:
- Subject contains "<SCM identifer> <Repository>/<Module> <Author>"
  eg: "SVN commit: jds/spec-files dermot".  Possibly add
  Revision/Transaction Id, but nothing else.
- Body contains normal header stuff: Repository, Module, Branch,
  Author, Date, Revision Id
- Body also contains lists of files modified, added and deleted.
  I'd prefer separate lists of each category with a header
  ("Files added:") rather than a list of all changed files with a
  flag indicating what action occurred ("U  Makefile").  Files
  could also be grouped by directory
  ("patches/   patch01, patch02, patch03").
- The Log Message than accompanied the commit should follow the
  file lists, possibly with some formatting to remove excessive
  white-space?
- Commit mails should *not* contain diffs of modified files -
  too much detail.
- A Standard sig. that gives an email address to contact, eg how
  to remove your address from mailing list.


This is the format we have used internally on CVS for a long time.
It's based on the standard GNOME CVS notifications:
==================<CVS Start>===================
Subject: JDS CVS: spec-files tom

CVSROOT:        /sgnome/cvsroots/jds
Module name:    spec-files
Changes by:     tom     06/04/05 17:55:37

Modified files:
        .              : ChangeLog rhythmbox.spec
        patches        : pygtk2-01-uninstalled.pc.diff
Added files:
        .              : pygobject.spec
        patches        : pygobject-01-uninstalled.pc.diff

Log message:
2006-04-05  Tom Smith <[EMAIL PROTECTED]>
* rhythmbox.spec: Remove --with-ipod option as gtkpod is not in build.
* pygobject.spec: Added. pygobject is no longer in pygtk2.
* patches/pygobject-01-uninstalled.pc.diff: Added.
* patches/pygtk2-01-uninstalled.pc.diff: Remove references to pygobject.

----------
Commit mails for 'spec-files' are sent to '[EMAIL PROTECTED]'
Contact [EMAIL PROTECTED] to change.
===================<CVS End>====================


This is output from the standard commit-email.pl Perl script that
is bundled with Subversion 1.2.3 source code.
=================<SVN #1 Start>=================
Subject: r8082 - in jds-spec-files/trunk: . patches

Author: tom
Date: 2006-04-28 01:20:39 +0100 (Fri, 28 Apr 2006)
New Revision: 8082

Added:
   jds-spec-files/trunk/patches/gnome-menus-03-application-submenu-rename.diff
Modified:
   jds-spec-files/trunk/ChangeLog
   jds-spec-files/trunk/gnome-menus.spec
Log:
2006-04-28  Tom Smith  <[EMAIL PROTECTED]>

        * gnome-menus.spec: Update.
        * patches/gnome-menus-03-application-submenu-rename.diff: New
        patch to rename a few submenus to Universal Access and
        Developer Tools.


Modified: jds-spec-files/trunk/ChangeLog
===================================================================
--- jds-spec-files/trunk/ChangeLog      2006-04-28 00:19:37 UTC (rev 8081)
+++ jds-spec-files/trunk/ChangeLog      2006-04-28 00:20:39 UTC (rev 8082)
@@ -1,5 +1,12 @@
 2006-04-28  Tom Smith  <[EMAIL PROTECTED]>

+       * gnome-menus.spec: Update.
+       * patches/gnome-menus-03-application-submenu-rename.diff: New
+       patch to rename a few submenus to Universal Access and
+       Developer Tools.
+
+2006-04-28  Tom Smith  <[EMAIL PROTECTED]>
+
        * totem.spec: Update.
        * patches/totem-03-menu-entry.diff: New patch to call it
        'Totem Movie Player'.

Modified: jds-spec-files/trunk/gnome-menus.spec
===================================================================
--- jds-spec-files/trunk/gnome-menus.spec       2006-04-28 00:19:37 UTC (rev 
8081)
+++ jds-spec-files/trunk/gnome-menus.spec       2006-04-28 00:20:39 UTC (rev 
8082)
@@ -9,13 +9,14 @@
 License:               LGPL
 Group:                 System/GUI/GNOME
 Version:               2.14.0
-Release:               2
+Release:               3
 Distribution:          Java Desktop System
 Vendor:                        Sun Microsystems, Inc.
 Summary:               Implementation of Desktop Menu Specification for GNOME
 Source:                        
http://ftp.gnome.org/pub/GNOME/sources/%{name}/2.14/%{name}-%{version}.tar.bz2
 Patch1:                 gnome-menus-01-alacarte-nodisplay-terminal.diff
 Patch2:                 gnome-menus-02-quickstart.diff
+Patch3:                 gnome-menus-03-application-submenu-rename.diff
 URL:                   http://www.gnome.org
 BuildRoot:             %{_tmppath}/%{name}-%{version}-build
 Docdir:                        %{_defaultdocdir}/%{name}
@@ -53,6 +54,7 @@
 %setup -q
 %patch1 -p1
 %patch2 -p1
+%patch3 -p1

 %build
 %ifos linux
@@ -125,6 +127,10 @@

 %changelog
 * Fri Apr 28 2006 - [EMAIL PROTECTED]
+- Add patch to rename some submenus, like
+  Universal Access, and Developer Tools.
+
+* Fri Apr 28 2006 - [EMAIL PROTECTED]
 - Add quickstart.menu, along with ability to edit
   in the simple menu editor.
==================<SVN #1 End>==================



This is output from another Subversion hook script being used
internally at the moment:
=================<SVN #2 Start>=================
Subject: Subversion notification (post-commit)

Author:     tom
Repository: svn+ssh://YYYYY.XXXX.COM//zzzzz/xxxxx-repo
Revision:   60
Log:
Modified manifests to use scm-proxy scripts during development

Changed:
U   Makefile
U   path/to/file2
U   path/to/file3
U   path/to/file4
U   path/to/file5
==================<SVN #2 End>==================
 
 
This message posted from opensolaris.org
_______________________________________________
tools-discuss mailing list
[email protected]

Reply via email to