Update PUI to use ffi-curl
[sxemacs] / contrib / README
index 6c6925b..f68a4a6 100644 (file)
@@ -5,87 +5,22 @@ useful.
 
 File List:
 =========
-       10sendlog.................tla hook script
-       20mirror..................tla hook script
-       do_builds.sh..............automate builds
-       hook......................tla master hook script
-       make-pkg.sh...............bash script to create a SXEmacs tar package
-       pop3.el.patch.............SXEmacs native OpenSSL goodies
-       report-build-failure.sh...bash script to send a build report failure
-       show-tty-256-colors.pl....Perl script to test 256 color output on terminal 
-       smtpmail.el.patch.........SXEmacs native OpenSSL goodies
-       starttls.el.patch.........SXEmacs native OpenSSL goodies
-       tar-build-failure.sh......bash script w/ tar of build report failure
-       tty-colors.c..............C program to check the terminal color definitions
+       do_builds.sh..................automate builds
+       git-post-receive-hook.sample..git hook to send email automatically for merge requests
+       git-for-steve.sh..............setup a for-steve branch to send patches to the master branch
+       make-pkg.sh...................bash script to create a SXEmacs tar package 
+       pop3.el.patch.................SXEmacs native OpenSSL goodies 
+        report-build-failure.sh.......bash script to send a build report failure 
+        show-tty-256-colors.pl........Perl script to test 256 color output on terminal
+       smtpmail.el.patch.............SXEmacs native OpenSSL goodies
+       starttls.el.patch.............SXEmacs native OpenSSL goodies
+       tar-build-failure.sh..........bash script w/ tar of build report failure
+        tty-colors.c..................C program to check the terminal color definitions
+
 
 More Info:
 =========
 
-tla hook scripts (hook, 10sendlog, 20mirror):
---------------------------------------------
-These scripts let you automate parts of your tla'ing, leaving you more
-time for SXEmacs hacking. :-)
-
-This tla hook "system" is designed to work with multiple archives,
-categories, branches, versions, even revisions.  Allowing you to have
-different scripts run for each.  The master hook script makes the
-decisions as to which sub-scripts to run based on a directory
-hierarchy where the directory names match
-archive/category/branch/version/revision names.
-
-Installation and use of these scripts is fairly straight forward.
-First, put `hook' in ~/.arch-params directory.  Then create a
-~/.arch-hooks directory, under which you put the directory hierarchy
-where your "action" scripts go.  The scripts themselves go in
-directories named `=$ACTION' where $ACTION can be one of...
-
-  import, precommit, commit, tag, make-archive, make-category, make-branch,
-  make-version, find-pristine, make-pristine, make-tmp-pristine
-
-Here is an example of how my ~/.arch-hooks hierarchy is laid out...
-
-~/.arch-hooks/
-    |-/steve@emchat.org--2008/
-    |   |-/=commit/10mirror
-    |   |-/=precommit/10forcedefaults
-    |   |-/emchat/
-    |   |   |-/=commit/10sendlog
-    |   |   |-/emchat--main/
-    |   |       |-/=commit/10chglogweb
-    |   |       |-/=commit/20updftp
-    |   |-/emchat-web/
-    |   |   |-/=commit/10sendlog
-    |   |   |-/emchat-web--main/
-    |   |       |-/=commit/10updsite
-    |   |-/xetla/
-    |       |-/=commit/10sendlog
-    |       |-/xetla--main/
-    |           |-/=commit/10updftp
-    |-/steve@sxemacs.org--2008/
-        |-/=commit/10mirror
-        |-/=precommit/10forcedefaults
-        |-/digitxt/
-        |   |-/digitxt--main/
-        |       |-/=commit/10sendlog
-        |-/emoney/
-        |   |-/emoney--main/
-        |       |-/=commit/10updftp
-        |-/fresse/
-        |   |-/fresse--steve/
-        |       |-/=commit/10sendlog
-        |-/sxemacs/
-        |   |-/sxemacs--main/
-        |       |-/=commit/10sendlog
-        |       |-/=commit/20chglogweb
-        |       |-/=commit/30log2rss
-        |-/sxemacs-web/
-            |-/sxemacs-web--main/
-                |-/=commit/10sendlog
-                |-/=commit/20updsite
-                |-/=commit/30news2rss
-
-Steve Youngs <steve@sxemacs.org>
-
 do_builds.sh:
 ------------
 
@@ -112,6 +47,41 @@ To setup:
 
 Nelson Ferreira <njsf@sxemacs.org>
 
+
+git-post-receive-hook.sample
+----------------------------
+This hook is meant as git hook (ie to be placed in the hooks directory
+of your publicly accessible repository) as a way to automatically send
+emails when you want something to be merged to the master branch.
+
+It assumes you will use a for-steve branch, as git-to-steve.sh will do
+for you, so it will only send emails for changes to that branch.
+
+This script will not send an email on a "fast-forward" or "merge"
+commit, so that you won't bother Steve if you keep a long lived
+for-steve branch, and even share it accross machines...
+
+To use, just place it under the name post-receive in the hooks
+directory of your git public repository.
+
+You may wish to review it and make sure the branch(es) you want to
+send mail for are there and the location of the post-receive-email
+script which should come with your git install.
+
+Nelson Ferreira <njsf@sxemacs.org>
+
+
+git-for-steve.sh
+---------------
+
+This script will check your git configuration, give you some
+recommendations of changes and create a for-steve branch so that you
+use the same convention as the other SXEmacs developers to contribute
+to the SXEmacs project.
+
+Nelson Ferreira <njsf@sxemacs.org>
+
+
 make-pkg.sh:
 -------------
 This script conveniently creates a tar from your workspace for use
@@ -242,4 +212,4 @@ Invoke with:
        -bs     Force the use of both bold and standout codes
        -q      Try to query the color map from the terminal
 
-Nelson Ferreira <njsf@sxemacs.org>
\ No newline at end of file
+Nelson Ferreira <njsf@sxemacs.org>