From: Eric Wong <e@80x24.org>
Date: Fri, 5 Apr 2019 20:04:29 +0000 (+0000)
Subject: viewdiff: document constants
X-Git-Tag: v1.2.0~330
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=33f5e614291025447dced2aca7258f64bb589d0b;p=public-inbox.git

viewdiff: document constants

We'll be building off of this for showing diffs in
the coderepo views.
---

diff --git a/lib/PublicInbox/ViewDiff.pm b/lib/PublicInbox/ViewDiff.pm
index a773e385..0cce952d 100644
--- a/lib/PublicInbox/ViewDiff.pm
+++ b/lib/PublicInbox/ViewDiff.pm
@@ -15,12 +15,16 @@ use URI::Escape qw(uri_escape_utf8);
 use PublicInbox::Hval qw(ascii_html to_attr from_attr);
 use PublicInbox::Git qw(git_unquote);
 
+# keep track of state so we can avoid redundant HTML tags for
+# identically-classed lines
 sub DSTATE_INIT () { 0 }
 sub DSTATE_STAT () { 1 }
 sub DSTATE_HEAD () { 2 } # /^diff --git /, /^index /, /^--- /, /^\+\+\+ /
 sub DSTATE_CTX () { 3 } # /^ /
 sub DSTATE_ADD () { 4 } # /^\+/
 sub DSTATE_DEL () { 5 } # /^\-/
+
+# maps the DSTATE_* to CSS class names compatible with what cgit uses:
 my @state2class = (
 	'', # init
 	'', # stat