unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 3/3] doc: avoid [<directory>] arg for git-clone(1)
Date: Wed, 16 Oct 2019 11:14:51 +0000	[thread overview]
Message-ID: <20191016111451.32255-4-e@80x24.org> (raw)
In-Reply-To: <20191016111451.32255-1-e@80x24.org>

While it is possible to host source code from the root of a URL
using git-http-backend(1), the lack of pathname in the URL can
also be confusing to users.  So just add the path name of the
project into the URL itself so users can invoke "git clone"
with one command-line argument instead of two.

Of course, previously documented URLs continue to work as normal.

---
 AUTHORS                             | 2 +-
 Documentation/dc-dlvr-spam-flow.txt | 2 +-
 README                              | 4 ++--
 lib/PublicInbox/WwwStream.pm        | 5 ++---
 4 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/AUTHORS b/AUTHORS
index 1ad02cd8..46ca20cc 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,6 +1,6 @@
 This list only includes major contributors.
 
-See history in git (via `git clone https://public-inbox.org/public-inbox')
+See history in git (via `git clone https://public-inbox.org/public-inbox.git')
 for a full history of the project.
 
 * Eric Wong <e@80x24.org> (BDFL)
diff --git a/Documentation/dc-dlvr-spam-flow.txt b/Documentation/dc-dlvr-spam-flow.txt
index 81aba766..d151d272 100644
--- a/Documentation/dc-dlvr-spam-flow.txt
+++ b/Documentation/dc-dlvr-spam-flow.txt
@@ -45,4 +45,4 @@ delivery path as well as removing the message from the git tree.
 * spamc / spamd - SpamAssassin: http://spamassassin.apache.org/
 
 * report-spam / dc-dlvr - distributed with public-inbox in the scripts/
-  directory: git clone https://public-inbox.org/ public-inbox
+  directory: git clone https://public-inbox.org/public-inbox.git
diff --git a/README b/README
index ffd433d8..f62a7e40 100644
--- a/README
+++ b/README
@@ -91,8 +91,8 @@ Hacking
 
 AGPL source code is available via git:
 
-	git clone https://public-inbox.org/ public-inbox
-	git clone git://repo.or.cz/public-inbox
+	git clone https://public-inbox.org/public-inbox.git
+	git clone https://repo.or.cz/public-inbox.git
 	torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
 
 See below for contact info.
diff --git a/lib/PublicInbox/WwwStream.pm b/lib/PublicInbox/WwwStream.pm
index f5338c39..06c8f7d2 100644
--- a/lib/PublicInbox/WwwStream.pm
+++ b/lib/PublicInbox/WwwStream.pm
@@ -11,8 +11,7 @@ use strict;
 use warnings;
 use PublicInbox::Hval qw(ascii_html);
 our $TOR_URL = 'https://www.torproject.org/';
-our $CODE_URL = 'https://public-inbox.org/';
-our $PROJECT = 'public-inbox';
+our $CODE_URL = 'https://public-inbox.org/public-inbox.git';
 
 # noop for HTTP.pm (and any other PSGI servers)
 sub close {}
@@ -80,7 +79,7 @@ sub _html_top ($) {
 sub code_footer ($) {
 	my ($env) = @_;
 	my $u = PublicInbox::Hval::prurl($env, $CODE_URL);
-	qq(AGPL code for this site: git clone <a\nhref="$u">$u</a> $PROJECT)
+	qq(AGPL code for this site: git clone <a\nhref="$u">$u</a>)
 }
 
 sub _html_end {

      parent reply	other threads:[~2019-10-16 11:14 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-16 11:14 [PATCH 0/3] another round of doc updates Eric Wong
2019-10-16 11:14 ` [PATCH 1/3] doc: check-man: use COLUMNS env for width Eric Wong
2019-10-16 11:14 ` [PATCH 2/3] doc: update public-inbox-overview(7) for v2 Eric Wong
2019-10-17  7:42   ` Eric Wong
2019-10-16 11:14 ` 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=20191016111451.32255-4-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.
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).