From 27e368196ce65e109c027987c706a697356f7bc5 Mon Sep 17 00:00:00 2001
From: Linus Nordberg <linus@nordu.net>
Date: Thu, 17 Nov 2016 10:36:34 +0100
Subject: Add a bit of documentation.

---
 doc/merge.txt         | 6 +++---
 tools/merge_backup.py | 5 ++++-
 tools/merge_dist.py   | 5 ++++-
 tools/merge_fetch.py  | 5 ++++-
 tools/merge_sth.py    | 5 ++++-
 5 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/doc/merge.txt b/doc/merge.txt
index b2e2738..d12424f 100644
--- a/doc/merge.txt
+++ b/doc/merge.txt
@@ -3,9 +3,9 @@
 The merge process
 =================
 
-- merge-fetch maintains a single file 'fetched' referring to a given
-  entry in 'logorder', indicating which entries are fetched and
-  sequenced so far.
+- merge-fetch fetches new entries from all storage nodes. Maintains a
+  single file 'fetched' referring to a given entry in 'logorder',
+  indicating which entries are fetched and sequenced so far.
 
 - merge-backup reads 'fetched' and pushes these entries to secondary
   merge nodes, maintaining one file per secondary,
diff --git a/tools/merge_backup.py b/tools/merge_backup.py
index abe9f36..4f688c3 100755
--- a/tools/merge_backup.py
+++ b/tools/merge_backup.py
@@ -3,7 +3,10 @@
 #
 # Copyright (c) 2014-2015, NORDUnet A/S.
 # See LICENSE for licensing information.
-
+#
+# Copy entries indicated by file 'fetched' to all secondary merge nodes.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
 import sys
 import base64
 import select
diff --git a/tools/merge_dist.py b/tools/merge_dist.py
index 2af1d6c..a9b5c60 100755
--- a/tools/merge_dist.py
+++ b/tools/merge_dist.py
@@ -3,7 +3,10 @@
 #
 # Copyright (c) 2014-2015, NORDUnet A/S.
 # See LICENSE for licensing information.
-
+#
+# Distribute the 'sth' file and all missing entries to all frontend nodes.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
 import sys
 import json
 from time import sleep
diff --git a/tools/merge_fetch.py b/tools/merge_fetch.py
index 3028b30..db274a3 100755
--- a/tools/merge_fetch.py
+++ b/tools/merge_fetch.py
@@ -3,7 +3,10 @@
 #
 # Copyright (c) 2014-2015, NORDUnet A/S.
 # See LICENSE for licensing information.
-
+#
+# Fetch new entries from all storage nodes.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
 import sys
 import struct
 import subprocess
diff --git a/tools/merge_sth.py b/tools/merge_sth.py
index 28ad34f..f4aec53 100755
--- a/tools/merge_sth.py
+++ b/tools/merge_sth.py
@@ -3,7 +3,10 @@
 #
 # Copyright (c) 2014-2015, NORDUnet A/S.
 # See LICENSE for licensing information.
-
+#
+# Generate a new 'sth' file.
+# See catlfish/doc/merge.txt for more about the merge process.
+#
 import sys
 import json
 import urllib2
-- 
cgit v1.1