user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 11/11] viewvcs: improve tree glossary view
Date: Tue, 24 Jan 2023 09:49:40 +0000	[thread overview]
Message-ID: <20230124094940.572017-12-e@80x24.org> (raw)
In-Reply-To: <20230124094940.572017-1-e@80x24.org>

Adding an <hr> helps delineate the glossary, note that
submodules are rare, and avoid needlessly defining the
commits-in-trees case since the extra information is likely
to overwhelm new users.
---
 lib/PublicInbox/ViewVCS.pm | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/lib/PublicInbox/ViewVCS.pm b/lib/PublicInbox/ViewVCS.pm
index 99f5e24f..5fd46610 100644
--- a/lib/PublicInbox/ViewVCS.pm
+++ b/lib/PublicInbox/ViewVCS.pm
@@ -409,7 +409,7 @@ EOM
 		$pfx = '';
 		$$bref .= qq[  (<a href=#path>path</a> unknown)\n];
 	}
-	my ($x, $m, $t, $oid, $sz, $f, $n);
+	my ($x, $m, $t, $oid, $sz, $f, $n, $gitlink);
 	$$bref .= "\n	size	name";
 	for (@ent) {
 		($x, $f) = split(/\t/, $_, 2);
@@ -420,6 +420,7 @@ EOM
 		$n = ascii_html($f);
 		if ($m eq 'g') { # gitlink submodule commit
 			$$bref .= "\ng\t\t$n @ <a\nhref=#g>commit</a>$oid";
+			$gitlink = 1;
 			next;
 		}
 		my $q = 'b='.ascii_html(uri_escape_path($pfx.$f));
@@ -430,17 +431,20 @@ EOM
 	}
 	$$bref .= dbg_log($ctx);
 	$$bref .= <<EOM;
-<pre>glossary
+<hr><pre>glossary
 --------
 <dfn
 id=tree>Tree</dfn> objects belong to commits or other tree objects.  Trees may
-reference blobs, sub-trees, or commits of submodules.
+reference blobs, sub-trees, or (rarely) commits of submodules.
 
 <dfn
 id=path>Path</dfn> names are stored in tree objects, but trees do not know
 their own path name.  A tree's path name comes from their parent tree,
 or it is the root tree referenced by a commit object.  Thus, this web UI
 relies on the `b=' URI parameter as a hint to display the path name.
+EOM
+
+	$$bref .= <<EOM if $gitlink;
 
 <dfn title="submodule commit"
 id=g>Commit</dfn> objects may be stored in trees to reference submodules.</pre>

      parent reply	other threads:[~2023-01-24  9:50 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-24  9:49 [PATCH 00/11] www_coderepo: subjective web stuffs Eric Wong
2023-01-24  9:49 ` [PATCH 01/11] qspawn: drop lineno from command failure warning Eric Wong
2023-01-24  9:49 ` [PATCH 02/11] viewvcs: add path name hint based on `b=' query param Eric Wong
2023-01-24  9:49 ` [PATCH 03/11] viewvcs: prepopulate search bar with dfpost + dfn Eric Wong
2023-01-24  9:49 ` [PATCH 04/11] www_coderepo: show /$INBOX/?t=$DATE link for commits Eric Wong
2023-01-24  9:49 ` [PATCH 05/11] www_coderepo: eliminate debug log footer Eric Wong
2023-01-24  9:49 ` [PATCH 06/11] http: reuse STDIN if it's already /dev/null Eric Wong
2023-01-24  9:49 ` [PATCH 07/11] viewvcs: expand on path names being "non-authoritative" Eric Wong
2023-01-24  9:49 ` [PATCH 08/11] viewvcs: show message for 404||500 errors Eric Wong
2023-01-24  9:49 ` [PATCH 09/11] solver_git: remove extraneous leading `-' Eric Wong
2023-01-24  9:49 ` [PATCH 10/11] www_coderepo: remove some needless return statements Eric Wong
2023-01-24  9:49 ` Eric Wong [this message]

Reply instructions:

You may reply publicly 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: https://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=20230124094940.572017-12-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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).