Add comment about irc logging format

barnowl · Aug 16, 2017 · 3f0c209 · 3f0c209
1 parent 8f91a70
commit 3f0c209
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/perl/modules/IRC/lib/BarnOwl/Message/IRC.pm b/perl/modules/IRC/lib/BarnOwl/Message/IRC.pm
@@ -97,6 +97,10 @@ sub log_filenames {
     die "IRC should not be handling non-IRC messages" if lc($m->type) ne "irc";
     BarnOwl::error("IRC message without a network") if !defined($m->network) || $m->network eq '';
     my $filename = lc($m->network);
+    # Note: Channel names generally start with '#', which
+    # disambiguates channels from individuals; for example, personals
+    # will look like, e.g., "~/zlog/irc/freenode:john-doe", whereas
+    # channels will look like, e.g., "~/zlog/irc/freenode:#barnowl"
     if ($m->is_personal) {
         if ($m->is_incoming) {
             $filename .= ":" . $m->sender;