user/dev discussion of public-inbox itself
 help / color / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 5/5] examples/cgit-commit-filter.lua: some doc updates
Date: Wed, 24 Apr 2019 23:02:14 +0000
Message-ID: <20190424230214.2378-6-e@80x24.org> (raw)
In-Reply-To: <20190424230214.2378-1-e@80x24.org>

It's been a while since I wrote this, and it needs to be kept
up-to-date with some advances in our Perl code.
---
 examples/cgit-commit-filter.lua | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/examples/cgit-commit-filter.lua b/examples/cgit-commit-filter.lua
index a8f9e1d..1677253 100644
--- a/examples/cgit-commit-filter.lua
+++ b/examples/cgit-commit-filter.lua
@@ -13,6 +13,9 @@
 local urls = {}
 urls['public-inbox.git'] = 'https://public-inbox.org/meta/'
 -- additional URLs here...
+-- TODO we should be able to auto-generate this based on "coderepo"
+-- directives in the public-inbox config file; but keep in mind
+-- the mapping is M:N between inboxes and coderepos
 
 function filter_open(...)
 	lineno = 0
@@ -20,6 +23,9 @@ function filter_open(...)
 end
 
 function filter_close()
+	-- cgit opens and closes this filter for the commit subject
+	-- and body separately, and we only generate the link based
+	-- on the commit subject:
 	if lineno == 1 and string.find(buffer, "\n") == nil then
 		u = urls[os.getenv('CGIT_REPO_URL')]
 		if u == nil then
@@ -32,6 +38,9 @@ function filter_close()
 			html('</tt></a>')
 		end
 	else
+		-- pass the body-through as-is
+		-- TODO: optionally use WwwHighlight for linkification like
+		-- cgit-wwwhighlight-filter.lua
 		html(buffer)
 	end
 	return 0
-- 
EW


      parent reply index

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-24 23:02 [PATCH 0/5] cgit + WwwHighlight.pm integration Eric Wong
2019-04-24 23:02 ` [PATCH 1/5] wwwhighlight: do linkification, too Eric Wong
2019-04-24 23:02 ` [PATCH 2/5] examples/cgit-commit-filter: remove unused variable Eric Wong
2019-04-24 23:02 ` [PATCH 3/5] wwwhighlight: deal with no-op highlight Eric Wong
2019-04-24 23:02 ` [PATCH 4/5] examples: cgit filter for use with WwwHighlight Eric Wong
2019-04-25  3:19   ` [PATCH v2] " Eric Wong
2019-04-25  3:25     ` Eric Wong
2019-04-24 23:02 ` Eric Wong [this message]

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://public-inbox.org/README

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190424230214.2378-6-e@80x24.org \
    --to=e@80x24.org \
    --cc=meta@public-inbox.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror http://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.org/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/

AGPL code for this site: git clone https://public-inbox.org/ public-inbox