From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 2/3] doc: -clone|lei add-external: add bit about the Makefile
Date: Wed, 3 Nov 2021 08:34:45 +0000 [thread overview]
Message-ID: <20211103083446.29264-3-e@80x24.org> (raw)
In-Reply-To: <20211103083446.29264-1-e@80x24.org>
It's pretty useful, I think.
---
Documentation/lei-add-external.pod | 2 ++
Documentation/public-inbox-clone.pod | 5 +++++
2 files changed, 7 insertions(+)
diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod
index 1ab65a1650a6..1761eed1ed78 100644
--- a/Documentation/lei-add-external.pod
+++ b/Documentation/lei-add-external.pod
@@ -29,6 +29,8 @@ Default: 0
=item --mirror=URL
Create C<LOCATION> by mirroring the public-inbox at C<URL>.
+C<LOCATION> will have a Makefile with a C<make update>
+target to update the external.
=item --epoch=RANGE
diff --git a/Documentation/public-inbox-clone.pod b/Documentation/public-inbox-clone.pod
index efee01eec592..103260913d92 100644
--- a/Documentation/public-inbox-clone.pod
+++ b/Documentation/public-inbox-clone.pod
@@ -18,6 +18,11 @@ L<public-inbox-index(1)>. Those commands must be run separately
if serving/searching the mirror is required. As-is,
public-inbox-clone is suitable for creating a git-only backup.
+public-inbox-clone creates a Makefile with handy targets to update the
+inbox once indexed. This Makefile may be edited by the user; it will
+not be rewritten by L<public-inbox-fetch(1)> unless it is removed
+completely.
+
public-inbox-clone does not use nor require any extra
configuration files (not even C<~/.public-inbox/config>).
next prev parent reply other threads:[~2021-11-03 8:34 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-03 8:34 [PATCH 0/3] doc: extindex-related updates Eric Wong
2021-11-03 8:34 ` [PATCH 1/3] doc: extindex: document current behavior + knobs Eric Wong
2021-11-03 8:34 ` Eric Wong [this message]
2021-11-03 8:34 ` [PATCH 3/3] doc: relnotes: 1.7.0: move extindex, note search results change Eric Wong
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=20211103083446.29264-3-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).