update docs

2 files changed, 28 insertions, 12 deletions

diff --git a/src/librefetch/librefetch b/src/librefetch/librefetch
index e91e58a..bc9d57d 100755
--- a/src/librefetch/librefetch
+++ b/src/librefetch/librefetch
@@ -65,7 +65,7 @@ usage() {
   prose "In create mode, it either looks at a build script and uses that
          to create the source tarball, or it uses GPG to create a
          signature (if OUTPUT_FILE ends with \`.sig\` or \`.sig.part\`).
-         If it is using GPG to create a signature, but the file that it is
+         If it is using GPG to create a signature, but the file which it is
          trying to sign doesn't exist yet, it recurses on itself to first
          create that file.  SOURCE_URL is ignored, except that it is used
          to set the default value of OUTPUT_FILE, and that it may be used
@@ -80,18 +80,17 @@ usage() {
   print "Example usage:"
   print '  $ %s https://repo.parabola.nu/other/mypackage/mypackage-1.0.tar.gz' "$cmd"
   echo
-  print "Options:"
-  flag 'Settings:' \
-       "-C"               "Force create mode (don't download)" \
-       "-D"               "Force download mode (don't create)" \
+  flag 'Options (behavior):'                                               \
+       "-C"               "Force create mode (don't download)"             \
+       "-D"               "Force download mode (don't create)"             \
        "-p <$(_ FILE)>"   "Use an alternate build script (instead of
                            'PKGBUILD').  If an SRCBUILD exists in the same
-                           directory, it is used instead" \
-       'Alternate modes:' \
-       "-g, --geninteg"   "Generate integrity checks for source files" \
-       "-S, --srcbuild"   "Print the effective build script (SRCBUILD)" \
+                           directory, it is used instead"
+  flag 'Options (reports):'                                                \
+       "-g, --geninteg"   "Generate integrity checks for source files"     \
+       "-S, --srcbuild"   "Print the effective build script (SRCBUILD)"    \
        "-M, --makepkg"    "Generate and print the location of the
-                           effective makepkg script" \
+                           effective makepkg script"                       \
        "-h, --help"       "Show this message"
 }
 
@@ -399,7 +398,6 @@ create_signature() {
 
   gpg --detach-sign --use-agent "${SIGNWITHKEY[@]}" --no-armor "$filename" &>/dev/null || ret=$EXIT_FAILURE
 
-
   if (( ! ret )); then
     msg2 "Created signature file %s." "$filename.sig"
   else
diff --git a/src/librefetch/librefetch-install b/src/librefetch/librefetch-install
index 5f4fd82..a582b43 100755
--- a/src/librefetch/librefetch-install
+++ b/src/librefetch/librefetch-install
@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
-# lirefetch-install: (un)install librefetch to /etc/makepkg.conf
+#
+# lirefetch-install: uninstall librefetch from /etc/makepkg.conf
 #
 # Copyright (C) 2013-2015, 2017 Luke Shumaker <lukeshu@parabola.nu>
 #
@@ -19,6 +20,23 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with Parabola. If not, see <http://www.gnu.org/licenses/>.
+#
+#
+# NOTE: primarily, this is called by the libretools.install hooks
+#
+# NOTE: this script originally accepted an 'install' option to munge makepkg.conf in place
+#         by the libretools.install hooks
+#       that behavior was replaced by the runtime script: /etc/makepkg.d/librefetch.conf
+#         (source: libretools::src/librefetch/makepkg-librefetch.conf.in),
+#         which must be sourced by makepkg.conf in order to enable mksource() handling
+#         (see `man librefetch`)
+#
+#       note that this is not the 'librefetch.conf' sourced by librefetch and librestage
+#         (see `man 5 librefetch.conf`)
+#       that one is: /etc/libretools.d/librefetch.conf
+#         (source: libretools::src/librefetch/librefetch.conf)
+#       TODO: one of those should be renamed, to avoid the name collision/confusion
+
 
 
 set -ueE