From 76fcbc186c0cc14ddf5447bbb96371c7b2f04b1a Mon Sep 17 00:00:00 2001
From: Ian Kelling <iank@fsf.org>
Date: Tue, 21 May 2019 15:50:59 -0400
Subject: [PATCH] readme and gitignore

---
 .gitignore | 11 ++++++++---
 README.FSF | 37 ++++++++++++++++++++++++++++++++-----
 2 files changed, 40 insertions(+), 8 deletions(-)

diff --git a/.gitignore b/.gitignore
index eada4b5..9a4930c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,14 +1,19 @@
+# files because this a home directory
 /.profile
 /.ssh
 /.viminfo
 /.lesshst
 /.bash*
+/.gitconfig
 /log
 /namazu
-# debug log file when "The \x22negative number\x22 problem occurred.\n" happens.
+
+# This is debug log file when "The \x22negative number\x22 problem occurred.\n" happens.
 # todo: we don't rotate this afaik, we should
 /NMZ.bug.info
-# files that arent helpful for our purposes to track in git
+
+# this exists in upstream, but tracking it in git would just be noise for us
 /doc
+
+# html archives
 /html/[^.]*
-/.gitconfig
diff --git a/README.FSF b/README.FSF
index 0511de5..b4e666d 100644
--- a/README.FSF
+++ b/README.FSF
@@ -1,8 +1,35 @@
-We do not use use read-mail to process spools and we don't list
-lists.def. We bypass that part of mhard and call web-archive instead.
+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, and missing cgi-bin/template/NMZ*dist. I dunno what those are
+about. TODO: figure out namazu integration.
 
-customize config.sh
-customize common.mrc
-email address obfuscation at end of /usr/lib/MHonArc/mhinit.pl (after ------)
 
+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).
+
+The lists.fsf branch should be rebased to any changes from master, like this:
+
+git checkout lists.fsf
+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
-- 
2.25.1