]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: -clone|lei add-external: add bit about the Makefile
authorEric Wong <e@80x24.org>
Wed, 3 Nov 2021 08:34:45 +0000 (08:34 +0000)
committerEric Wong <e@80x24.org>
Wed, 3 Nov 2021 18:32:11 +0000 (18:32 +0000)
It's pretty useful, I think.

Documentation/lei-add-external.pod
Documentation/public-inbox-clone.pod

index 1ab65a1650a68e97adce46ac821467b9347b774e..1761eed1ed784a260caca2cdf0a5189f1b075813 100644 (file)
@@ -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
 
index efee01eec59282fcbd27017314c3b655b3c7716a..103260913d92a41c400e47441d8483b3b43ac851 100644 (file)
@@ -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>).