From: Eric Wong <e@80x24.org>
Date: Sat, 19 Sep 2020 09:37:12 +0000 (+0000)
Subject: gcf2*: more descriptive package descriptions
X-Git-Tag: v1.7.0~1729
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=3750b2e2952e55fe4a04c73fc78f25c5e07d0525;p=public-inbox.git

gcf2*: more descriptive package descriptions

Hopefully this allows others to more quickly figure out what's
going on.
---

diff --git a/lib/PublicInbox/Gcf2.pm b/lib/PublicInbox/Gcf2.pm
index 6ac3aa18..fe76b1fd 100644
--- a/lib/PublicInbox/Gcf2.pm
+++ b/lib/PublicInbox/Gcf2.pm
@@ -1,7 +1,8 @@
 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
-#
-# git-cat-file based on libgit2
+
+# backend for public-inbox-gcf2(1) (git-cat-file based on libgit2,
+# other libgit2 stuff may go here, too)
 package PublicInbox::Gcf2;
 use strict;
 use PublicInbox::Spawn qw(which popen_rd);
diff --git a/lib/PublicInbox/Gcf2Client.pm b/lib/PublicInbox/Gcf2Client.pm
index 5120698f..a048cd1a 100644
--- a/lib/PublicInbox/Gcf2Client.pm
+++ b/lib/PublicInbox/Gcf2Client.pm
@@ -1,5 +1,7 @@
 # Copyright (C) 2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+
+# connects public-inbox processes to public-inbox-gcf2(1)
 package PublicInbox::Gcf2Client;
 use strict;
 use parent 'PublicInbox::Git';