Mercurial > repos > borgend / changeset

--- a/borgend.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,4 +1,7 @@
 #!/usr/local/bin/python3
+#
+# Borgend by Tuomo Valkonen, 2018
+#
 
 # Common modules
 import os

--- a/borgend/__init__.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/__init__.py	Mon Jan 29 09:38:53 2018 +0000
@@ -0,0 +1,5 @@
+#
+# Borgend by Tuomo Valkonen, 2018
+#
+
+pass

--- a/borgend/backup.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/backup.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,8 @@
 #
-# Borgend Backup instance
+# Borgend by Tuomo Valkonen, 2018
+#
+# This file implements the scheduling, running, and borg output processing
+# for a specific configured backup.
 #
 
 import logging

--- a/borgend/branding.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/branding.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,10 @@
 #
-# Branding
+# Borgend by Tuomo Valkonen, 2018
+#
+# This file implements branding of the program; besides renaming the executables,
+# installation locations, tarballs, and other similar actions, distributors who
+# provide obsolete and modified software should also modify this file to
+# disassociate their offering form the original authors.
 #
 
 appname="borgend"

--- a/borgend/config.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/config.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,7 +1,10 @@
 #!/usr/local/bin/python3
 #
-# Borgend configuration loader
+# Borgend by Tuomo Valkonen, 2018
 #
+# This file implements basic configuration processing
+#
+
 
 import yaml
 import io

--- a/borgend/dreamtime.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/dreamtime.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# Wake/sleep detection for scheduling adjustments
+# Borgend by Tuomo Valkonen, 2018
+#
+# This file implements system wake/sleep detection for scheduling adjustments.
 #
 
 import Foundation

--- a/borgend/fifolog.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/fifolog.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# FIFO memory logger
+# Borgend by Tuomo Valkonen, 2018
+#
+# This is a simple limited memory FIFO log for the logging module
 #
 
 from logging.handlers import BufferingHandler

--- a/borgend/instance.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/instance.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# Borgend borg launcher / processor
+# Borgend by Tuomo Valkonen, 2018
+#
+# This file implements a Borg launching interface.
 #
 
 import os

--- a/borgend/locations.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/locations.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# Locations
+# Borgend by Tuomo Valkonen, 2018
+#
+# Detection of configuration file and log file locations.
 #
 
 import os

--- a/borgend/loggers.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/loggers.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# Loggers
+# Borgend by Tuomo Valkonen, 2018
+#
+# This file configures the logging module for Borgend
 #
 
 import os

--- a/borgend/repository.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/repository.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# Repository abstraction for queuing
+# Borgend by Tuomo Valkonen, 2018
+#
+# Repository abstraction for queuing.
 #
 
 import weakref

--- a/borgend/scheduler.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/scheduler.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,7 +1,9 @@
 #
-# Scheduler for Borgend
+# Borgend by Tuomo Valkonen, 2018
 #
-# This module simply provide a way for other threads to until a given time
+# This file is the scheduler: it provides e a way for other threads to
+# wait until a given time; which may be "dreamtime" that discounts system
+# sleep periods
 #
 
 import time

--- a/borgend/ui.py	Mon Jan 29 09:21:07 2018 +0000
+++ b/borgend/ui.py	Mon Jan 29 09:38:53 2018 +0000
@@ -1,5 +1,7 @@
 #
-# Borgend MacOS UI
+# Borgend by Tuomo Valkonen, 2018
+#
+# Borgend MacOS tray icon UI
 #
 
 import rumps