[Commit-womb] gnumaint gnumaint maintfileupgrade README

[Karl Berry]

CVSROOT:        /sources/womb
Module name:    gnumaint
Changes by:     Karl Berry <karl>       06/12/28 19:34:21

Modified files:
        .              : gnumaint maintfileupgrade 
Added files:
        .              : README 

Log message:
        beginnings of README from Jose, use relative filenames in script for now

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnumaint/gnumaint?cvsroot=womb&r1=1.7&r2=1.8
http://cvs.savannah.gnu.org/viewcvs/gnumaint/maintfileupgrade?cvsroot=womb&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnumaint/README?cvsroot=womb&rev=1.1

Patches:
Index: gnumaint
===================================================================
RCS file: /sources/womb/gnumaint/gnumaint,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -b -r1.7 -r1.8
--- gnumaint    14 Dec 2006 22:14:26 -0000      1.7
+++ gnumaint    28 Dec 2006 19:34:21 -0000      1.8
@@ -1,25 +1,37 @@
-#!/usr/bin/tclsh
+#!/usr/bin/env tclsh
 #
-# gnumaint - GNU maintainers maintenance script
+# gnumaint - GNU maintainers file maintenance (/gd/gnuorg/maintainers)
 #
-# Copyrigth (C) 2006 Free Software Foundation Inc.
+# Copyright (C) 2006 Free Software Foundation Inc.
+# 
+# This program 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 2, or (at your option)
+# any later version.
+#
+# This program 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 this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 
USA.
+#
+# Originally written by Jose Marchesi.
 
 ##
 ## Global variables (configuration section)
 ##
 
-variable maintainers_file "/home/jemarch/gnu/src/gnumaint/maintainers.new"
-variable mail_activity    
"/home/jemarch/gnu/src/gnumaint/mailtestforactivity.txt"
+variable maintainers_file "maintainers.new"
+variable mail_activity    "mailtestforactivity.txt"
 variable formail          "/usr/bin/formail"
 variable sendmail         "/usr/sbin/sendmail"
 variable logfile          "/tmp/gnumaint.log"
 variable email_originator "address@hidden"
 variable email_reply      "address@hidden"
 variable lockfile_command "/usr/bin/lockfile"
-variable activity_account_file "/tmp/mail-activity"
-
-### Please, dont touch the code behind this line unless you really know
-### what you are doing
 
 # Maintainers database structure:
 #

Index: maintfileupgrade
===================================================================
RCS file: /sources/womb/gnumaint/maintfileupgrade,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- maintfileupgrade    28 Dec 2006 19:27:58 -0000      1.1
+++ maintfileupgrade    28 Dec 2006 19:34:21 -0000      1.2
@@ -1,4 +1,4 @@
-#!/usr/bin/tclsh
+#!/usr/bin/env tclsh
 #
 # maintfileupgrade - GNU maintainers file upgrade to new format
 #

Index: README
===================================================================
RCS file: README
diff -N README
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ README      28 Dec 2006 19:34:21 -0000      1.1
@@ -0,0 +1,87 @@
+gnumaint is a manager for the /gd/gnuorg/maintainers file, the
+official list of GNU packages and maintainers.
+
+You can get listings (see ./gnumaint help list),
+send the contact emails (./gnumaint help sendemail),
+and receive the answers from the maintainers (./gnumaint help recemail).
+
+gnumaint suppor the `sendemail' operation, where you should specify
+which kind of email you want to send to all the maintainers. Now there
+is only one type of email: `activity'.
+So you want to run gnumaint as:
+
+    gnumaint sendemail activity
+
+Before to run the script (from a crontab job or by hand) you need to
+setup several variables in the Global variables section of the script:
+
+   mail_activity
+
+       This is the place where the template for activity checking
+       emails is stored. See below for how to write an email
+       template. 
+
+   formail
+  
+       This is the location of the `formail' executable, used by
+       gnumaint to format emails.
+
+   sendmail
+
+       This is the location of the sendmail-compatible executable,
+       used by gnumaint to actually send the emails.
+
+
+There is an example of template file (i used this one for testing
+purposes):
+
+--- begin of template file ---
+%PACKAGE_NAME maintenance activity test
+
+Dear %MAINTAINER_NAME
+
+Please answer this email in order we can make sure you
+are still actively maintaining %PACKAGE_NAME blah blah blah
+
+Sinceresly,
+GNU Project Spamming Section
+--- end of template file ---
+
+The first line of the template is the subject line. The rest of the
+file is the body of the email. Note the substitution keywords
+%PACKAGE_NAME and %MAINTAINER_NAME.
+
+Ok. An example email generated by that template follows.
+
+---begin of email ---
+Reply-To: address@hidden
+From: address@hidden
+To: address@hidden
+Subject: Gnulib maintenance activity test
+
+Dear Karl Berry
+
+Please answer this email in order we can make sure you
+are still actively maintaining Gnulib blah blah blah
+
+Sinceresly,
+GNU Project Spamming Section
+
+-- Please make sure to include the following line in the body of your reply --
+    $package:Gnulib$
+--- end of email---
+
+Please note the last two lines. There is an informative comment and
+then a "control line" with `$package:package-name$'. The maintainer
+should include that control line in the body answer (she can simply
+reply and yank the entire message).
+
+The maintainer should write the reply subject. It should be the string
+`ACT'. No more no less (this is to avoid autoreply messages such as
+richard's one). 
+
+So, for testing purposes, write a dummy maintainers file with several
+email addresses and packages. Make sure all the variables has correct
+values in the top of `gnumaint'. Then, run `gnumaint':
+
+     gnumaint sendemail activity