diff mbox series

[1/2] doc: recommend lore.kernel.org over public-inbox.org

Message ID 20191127125343.GA27983@sigill.intra.peff.net (mailing list archive)
State New, archived
Headers show
Series [1/2] doc: recommend lore.kernel.org over public-inbox.org | expand

Commit Message

Jeff King Nov. 27, 2019, 12:53 p.m. UTC
Since lore.kernel.org now has the same archive as public-inbox.org and
may have more longevity going forward[1], let's recommend people use it
for finding or referencing messages.

[1] https://public-inbox.org/git/20191120195556.GA25189@dcvr/
      or if you like:
    https://lore.kernel.org/git/20191120195556.GA25189@dcvr/

Signed-off-by: Jeff King <peff@peff.net>
---
And it's one character shorter. Think of all of the bytes saved!

 Documentation/MyFirstContribution.txt | 2 +-
 Documentation/git.txt                 | 2 +-
 README.md                             | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

Comments

Eric Wong Nov. 27, 2019, 12:59 p.m. UTC | #1
Jeff King <peff@peff.net> wrote:
> Since lore.kernel.org now has the same archive as public-inbox.org and
> may have more longevity going forward[1], let's recommend people use it
> for finding or referencing messages.
> 
> [1] https://public-inbox.org/git/20191120195556.GA25189@dcvr/
>       or if you like:
>     https://lore.kernel.org/git/20191120195556.GA25189@dcvr/
> 
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> And it's one character shorter. Think of all of the bytes saved!

:>  URL length has always bothered me.
peff.net/git/$MESSAGE_ID/ would be nice to have, as well :)

Anyways, consider this series:

Acked-by: Eric Wong <e@80x24.org>

(and I doubt I'll keep paying for 80x24.org, either...)
Johannes Schindelin Nov. 27, 2019, 8 p.m. UTC | #2
Hi,

On Wed, 27 Nov 2019, Eric Wong wrote:

> Jeff King <peff@peff.net> wrote:
> > Since lore.kernel.org now has the same archive as public-inbox.org and
> > may have more longevity going forward[1], let's recommend people use it
> > for finding or referencing messages.
> >
> > [1] https://public-inbox.org/git/20191120195556.GA25189@dcvr/
> >       or if you like:
> >     https://lore.kernel.org/git/20191120195556.GA25189@dcvr/

One of the things I appreciate most about https://public-inbox.org/git is
that you can clone it. I just tried this with
https://lore.kernel.org/git/...

$ git clone https://lore.kernel.org/git/  lore-git
Cloning into 'lore-git'...
warning: You appear to have cloned an empty repository.

Is this something other people also care about?

Ciao,
Dscho

> >
> > Signed-off-by: Jeff King <peff@peff.net>
> > ---
> > And it's one character shorter. Think of all of the bytes saved!
>
> :>  URL length has always bothered me.
> peff.net/git/$MESSAGE_ID/ would be nice to have, as well :)
>
> Anyways, consider this series:
>
> Acked-by: Eric Wong <e@80x24.org>
>
> (and I doubt I'll keep paying for 80x24.org, either...)
>
Eric Wong Nov. 27, 2019, 8:04 p.m. UTC | #3
Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> On Wed, 27 Nov 2019, Eric Wong wrote:
> > Jeff King <peff@peff.net> wrote:
> > > Since lore.kernel.org now has the same archive as public-inbox.org and
> > > may have more longevity going forward[1], let's recommend people use it
> > > for finding or referencing messages.
> > >
> > > [1] https://public-inbox.org/git/20191120195556.GA25189@dcvr/
> > >       or if you like:
> > >     https://lore.kernel.org/git/20191120195556.GA25189@dcvr/
> 
> One of the things I appreciate most about https://public-inbox.org/git is
> that you can clone it. I just tried this with
> https://lore.kernel.org/git/...
> 
> $ git clone https://lore.kernel.org/git/  lore-git
> Cloning into 'lore-git'...
> warning: You appear to have cloned an empty repository.

Oops, that's a usability issue I hope to fix at some point.

> Is this something other people also care about?

Instructions are actually at the bottom:

   git clone --mirror https://lore.kernel.org/git/0 git/git/0.git

The "0" is the "epoch", and larger repos have multiple epochs,
roughly 1GB each. https://lore.kernel.org/lkml/ has 0..7, right now.
Johannes Schindelin Nov. 28, 2019, 10:25 a.m. UTC | #4
Hi,

On Wed, 27 Nov 2019, Eric Wong wrote:

> Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> > On Wed, 27 Nov 2019, Eric Wong wrote:
> > > Jeff King <peff@peff.net> wrote:
> > > > Since lore.kernel.org now has the same archive as public-inbox.org and
> > > > may have more longevity going forward[1], let's recommend people use it
> > > > for finding or referencing messages.
> > > >
> > > > [1] https://public-inbox.org/git/20191120195556.GA25189@dcvr/
> > > >       or if you like:
> > > >     https://lore.kernel.org/git/20191120195556.GA25189@dcvr/
> >
> > One of the things I appreciate most about https://public-inbox.org/git is
> > that you can clone it. I just tried this with
> > https://lore.kernel.org/git/...
> >
> > $ git clone https://lore.kernel.org/git/  lore-git
> > Cloning into 'lore-git'...
> > warning: You appear to have cloned an empty repository.
>
> Oops, that's a usability issue I hope to fix at some point.

That would be nice. As you can tell from my puzzlement, not everybody
scrolls down to the instruction (which I finally found after your
comment)...

:-D

> > Is this something other people also care about?
>
> Instructions are actually at the bottom:
>
>    git clone --mirror https://lore.kernel.org/git/0 git/git/0.git
>
> The "0" is the "epoch", and larger repos have multiple epochs,
> roughly 1GB each. https://lore.kernel.org/lkml/ has 0..7, right now.

Okay, so how does that work, is the idea that you should graft them
together using replacement objects if you want to have the full archive?

And: if I want to track the latest mails in GitGitGadget, what indication
will I have that I'll need to switch to `.../1`?

Thanks,
Dscho
Eric Wong Nov. 28, 2019, 7:48 p.m. UTC | #5
Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> On Wed, 27 Nov 2019, Eric Wong wrote:
> > The "0" is the "epoch", and larger repos have multiple epochs,
> > roughly 1GB each. https://lore.kernel.org/lkml/ has 0..7, right now.
> 
> Okay, so how does that work, is the idea that you should graft them
> together using replacement objects if you want to have the full archive?

Yes.  Except we don't actually use grafts/replace and users can
currently only clone the latest epoch of LKML.  In the future,
it should also be easy to jettison old epochs if space is
limited.

> And: if I want to track the latest mails in GitGitGadget, what indication
> will I have that I'll need to switch to `.../1`?

You can use the gzipped JSON grokmirror manifest at:
https://lore.kernel.org/git/manifest.js.gz

grokmirror could be a bit of a pain to install because of Python
dependencies, so periodically attempting to clone the next
numbered epoch ought to be fine, too.

I've also considered adding epoch info into
https://lore.kernel.org/git/_/text/config/raw
so shell scripters w/o JSON parsers can use "git config"
Johannes Schindelin Nov. 28, 2019, 10:17 p.m. UTC | #6
Hi Eric,

On Thu, 28 Nov 2019, Eric Wong wrote:

> Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
>
> > And: if I want to track the latest mails in GitGitGadget, what indication
> > will I have that I'll need to switch to `.../1`?
>
> You can use the gzipped JSON grokmirror manifest at:
> https://lore.kernel.org/git/manifest.js.gz
>
> grokmirror could be a bit of a pain to install because of Python
> dependencies, so periodically attempting to clone the next
> numbered epoch ought to be fine, too.
>
> I've also considered adding epoch info into
> https://lore.kernel.org/git/_/text/config/raw
> so shell scripters w/o JSON parsers can use "git config"

I just had a look at its contents:

-- snip --
; example public-inbox config snippet for "git"
; see public-inbox-config(5) manpage for more details:
; https://public-inbox.org/public-inbox-config.html
[publicinbox "git"]
	inboxdir = /path/to/top-level-inbox
	; note: public-inbox before v1.2.0 used "mainrepo"
	; instead of "inboxdir", both remain supported after 1.2
	mainrepo = /path/to/top-level-inbox
	address = git@vger.kernel.org
	listid = git.vger.kernel.org
	filter = PublicInbox::Filter::Mirror
	newsgroup = org.kernel.vger.git
	nntpmirror = nntp://nntp.lore.kernel.org/org.kernel.vger.git
-- snap --

Isn't `inboxdir` and `mainrepo` incorrect?

And yes, adding `epoch` information there would be very welcome.

Thanks,
Dscho
Eric Wong Nov. 28, 2019, 10:31 p.m. UTC | #7
Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> Hi Eric,
> 
> On Thu, 28 Nov 2019, Eric Wong wrote:
> 
> > Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> >
> > > And: if I want to track the latest mails in GitGitGadget, what indication
> > > will I have that I'll need to switch to `.../1`?
> >
> > You can use the gzipped JSON grokmirror manifest at:
> > https://lore.kernel.org/git/manifest.js.gz
> >
> > grokmirror could be a bit of a pain to install because of Python
> > dependencies, so periodically attempting to clone the next
> > numbered epoch ought to be fine, too.
> >
> > I've also considered adding epoch info into
> > https://lore.kernel.org/git/_/text/config/raw
> > so shell scripters w/o JSON parsers can use "git config"
> 
> I just had a look at its contents:
> 
> -- snip --
> ; example public-inbox config snippet for "git"
> ; see public-inbox-config(5) manpage for more details:
> ; https://public-inbox.org/public-inbox-config.html
> [publicinbox "git"]
> 	inboxdir = /path/to/top-level-inbox
> 	; note: public-inbox before v1.2.0 used "mainrepo"
> 	; instead of "inboxdir", both remain supported after 1.2
> 	mainrepo = /path/to/top-level-inbox
> 	address = git@vger.kernel.org
> 	listid = git.vger.kernel.org
> 	filter = PublicInbox::Filter::Mirror
> 	newsgroup = org.kernel.vger.git
> 	nntpmirror = nntp://nntp.lore.kernel.org/org.kernel.vger.git
> -- snap --
> 
> Isn't `inboxdir` and `mainrepo` incorrect?

How so?  It's fine to have both in case users need to downgrade
to older versions of public-inbox.

> And yes, adding `epoch` information there would be very welcome.

Noted.  Not sure if the "modified" and "fingerprint" keys of
manifest would make sense there, too...
Johannes Schindelin Nov. 29, 2019, 9:32 a.m. UTC | #8
Hi Eric,

On Thu, 28 Nov 2019, Eric Wong wrote:

> Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> > Hi Eric,
> >
> > On Thu, 28 Nov 2019, Eric Wong wrote:
> >
> > > Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> > >
> > > > And: if I want to track the latest mails in GitGitGadget, what indication
> > > > will I have that I'll need to switch to `.../1`?
> > >
> > > You can use the gzipped JSON grokmirror manifest at:
> > > https://lore.kernel.org/git/manifest.js.gz
> > >
> > > grokmirror could be a bit of a pain to install because of Python
> > > dependencies, so periodically attempting to clone the next
> > > numbered epoch ought to be fine, too.
> > >
> > > I've also considered adding epoch info into
> > > https://lore.kernel.org/git/_/text/config/raw
> > > so shell scripters w/o JSON parsers can use "git config"
> >
> > I just had a look at its contents:
> >
> > -- snip --
> > ; example public-inbox config snippet for "git"
> > ; see public-inbox-config(5) manpage for more details:
> > ; https://public-inbox.org/public-inbox-config.html
> > [publicinbox "git"]
> > 	inboxdir = /path/to/top-level-inbox
> > 	; note: public-inbox before v1.2.0 used "mainrepo"
> > 	; instead of "inboxdir", both remain supported after 1.2
> > 	mainrepo = /path/to/top-level-inbox
> > 	address = git@vger.kernel.org
> > 	listid = git.vger.kernel.org
> > 	filter = PublicInbox::Filter::Mirror
> > 	newsgroup = org.kernel.vger.git
> > 	nntpmirror = nntp://nntp.lore.kernel.org/org.kernel.vger.git
> > -- snap --
> >
> > Isn't `inboxdir` and `mainrepo` incorrect?
>
> How so?  It's fine to have both in case users need to downgrade
> to older versions of public-inbox.

I must have misinterpreted the purpose of this URL, then. I thought that
was the configuration of _this_ instance, and that I could use the path
indicated by `mainrepo` to replace the `/_/text/config/raw` part of the
URL to get to the repo URL.

Is this just a template file, then?

> > And yes, adding `epoch` information there would be very welcome.
>
> Noted.  Not sure if the "modified" and "fingerprint" keys of
> manifest would make sense there, too...

I have no idea what purpose they serve, so I have no opinion on this
question.

Thanks,
Dscho
Eric Wong Nov. 29, 2019, 9:59 a.m. UTC | #9
Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> Hi Eric,
> 
> On Thu, 28 Nov 2019, Eric Wong wrote:
> 
> > Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> > > Hi Eric,
> > >
> > > On Thu, 28 Nov 2019, Eric Wong wrote:
> > >
> > > > Johannes Schindelin <Johannes.Schindelin@gmx.de> wrote:
> > > >
> > > > > And: if I want to track the latest mails in GitGitGadget, what indication
> > > > > will I have that I'll need to switch to `.../1`?
> > > >
> > > > You can use the gzipped JSON grokmirror manifest at:
> > > > https://lore.kernel.org/git/manifest.js.gz
> > > >
> > > > grokmirror could be a bit of a pain to install because of Python
> > > > dependencies, so periodically attempting to clone the next
> > > > numbered epoch ought to be fine, too.
> > > >
> > > > I've also considered adding epoch info into
> > > > https://lore.kernel.org/git/_/text/config/raw
> > > > so shell scripters w/o JSON parsers can use "git config"
> > >
> > > I just had a look at its contents:
> > >
> > > -- snip --
> > > ; example public-inbox config snippet for "git"
> > > ; see public-inbox-config(5) manpage for more details:
> > > ; https://public-inbox.org/public-inbox-config.html
> > > [publicinbox "git"]
> > > 	inboxdir = /path/to/top-level-inbox
> > > 	; note: public-inbox before v1.2.0 used "mainrepo"
> > > 	; instead of "inboxdir", both remain supported after 1.2
> > > 	mainrepo = /path/to/top-level-inbox
> > > 	address = git@vger.kernel.org
> > > 	listid = git.vger.kernel.org
> > > 	filter = PublicInbox::Filter::Mirror
> > > 	newsgroup = org.kernel.vger.git
> > > 	nntpmirror = nntp://nntp.lore.kernel.org/org.kernel.vger.git
> > > -- snap --
> > >
> > > Isn't `inboxdir` and `mainrepo` incorrect?
> >
> > How so?  It's fine to have both in case users need to downgrade
> > to older versions of public-inbox.
> 
> I must have misinterpreted the purpose of this URL, then. I thought that
> was the configuration of _this_ instance, and that I could use the path
> indicated by `mainrepo` to replace the `/_/text/config/raw` part of the
> URL to get to the repo URL.
> 
> Is this just a template file, then?

It's a config snippet that can be copy+pasted into
~/.public-inbox/config and edited to suit the local machine
(but also human-readable and git-config(1)-parseable)

Both "mainrepo" and "inboxdir" refer to local paths, not URLs,
currently.  But it would be nice to access inboxes over WebDAV
or similar :>

> > > And yes, adding `epoch` information there would be very welcome.
> >
> > Noted.  Not sure if the "modified" and "fingerprint" keys of
> > manifest would make sense there, too...
> 
> I have no idea what purpose they serve, so I have no opinion on this
> question.

They're timestamps and checksums used to reduce the cost of
checking multiple repos for updates.  It's hugely beneficial
when there's 100s or 1000s of repos to mirror.  grokmirror only
makes one HTTP request to get manifest.js.gz, and only runs
fetches for ones that need updating.

It's a less useful for git@vger since there's only one epoch,
currently; and checking for the existence of a next one (1.git)
isn't that expensive.
diff mbox series

Patch

diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 5e9b808f5f..5922803d87 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -970,7 +970,7 @@  reviewers the changes you've made that may not be as visible.
 You will also need to go and find the Message-Id of your previous cover letter.
 You can either note it when you send the first series, from the output of `git
 send-email`, or you can look it up on the
-https://public-inbox.org/git[mailing list]. Find your cover letter in the
+https://lore.kernel.org/git[mailing list]. Find your cover letter in the
 archives, click on it, then click "permalink" or "raw" to reveal the Message-Id
 header. It should match:
 
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 9b82564d1a..5f5b85ba27 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -928,7 +928,7 @@  Reporting Bugs
 Report bugs to the Git mailing list <git@vger.kernel.org> where the
 development and maintenance is primarily done.  You do not have to be
 subscribed to the list to send a message there.  See the list archive
-at https://public-inbox.org/git for previous bug reports and other
+at https://lore.kernel.org/git for previous bug reports and other
 discussions.
 
 Issues which are security relevant should be disclosed privately to
diff --git a/README.md b/README.md
index e1d2b82209..9d4564c8aa 100644
--- a/README.md
+++ b/README.md
@@ -35,7 +35,7 @@  requests, comments and patches to git@vger.kernel.org (read
 [Documentation/SubmittingPatches][] for instructions on patch submission).
 To subscribe to the list, send an email with just "subscribe git" in
 the body to majordomo@vger.kernel.org. The mailing list archives are
-available at <https://public-inbox.org/git/>,
+available at <https://lore.kernel.org/git/>,
 <http://marc.info/?l=git> and other archival sites.
 
 Issues which are security relevant should be disclosed privately to