document branches better
[mharc.git] / README.FSF
index 9c2b556..5bd71b5 100644 (file)
@@ -1,4 +1,57 @@
-customize config.sh
-customize common.mrc
-email address obfuscation at end of /usr/lib/MHonArc/mhinit.pl (after ------)
+Note: This repo is prone to being force pushed because, commits are
+meant as documentation of whats changed from upstream and whats been
+deployed for significant periods, so sometimes its better to edit them
+as they are developed.
 
+We do not use use the provided read-mail to process spools and we don't
+use lists.def. We bypass that part of mharc and call web-archive
+instead.
+
+This repo is based on mharc 0.7.3 release. The .dist files are all the
+upstream except changing path names of standard utilities to match the
+distro. I dunno what those are about.
+
+The .dist files should never be changed except when upgrading to new
+upstream version (and there does exist a non-release snapshot we should
+upgrade to).
+
+Any file with a correspond .in version should never be manually edited,
+instead generated from the .in file by running make configure. Note,
+make configure must be run from /home/mharc (checkout into that
+directory on your local system).
+
+Ansible pulls a branch with the name of the current hostname, so lists.gnu.org
+is an alias to master, and lists.dev.fsf.org is an alias to lists.fsf.org.
+This was achieved by doing for example:
+
+vcs.fsf.org $
+sudo -i -u git
+cd /home/git/repositories/mharc.git
+git symbolic-ref refs/heads/lists.dev.fsf.org refs/heads/lists.fsf.org
+
+The lists.fsf.org branch should be rebased to any changes from master, like this:
+
+git checkout lists.fsf.org
+git rebase master
+# if there are merge conflicts, manually merge any .in files, then
+make configure
+git add .
+git rebase --continue
+git push -f
+
+Then on lists.fsf.org:
+
+su mharc
+cd
+git fetch
+git reset --hard origin/lists.fsf.org
+
+
+To update existing lists headers, the only way namazu supports is to
+rebuild the index, but that takes about 3 days. Instead, I put a random
+unique string into the header where the list name goes, copied it to
+/tmp, su mharc, cd to the html dir, then ran this:
+
+for x in */NMZ.head; do sed "s/gachJefyeonJoa/${x%/*}/g" /tmp/NMZ.head>$x || { echo failed on $x; break; } ; done
+
+This process can be repeated for more changes.