about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong (Contractor, The Linux Foundation) <e@80x24.org>2018-03-29 09:57:49 +0000
committerEric Wong (Contractor, The Linux Foundation) <e@80x24.org>2018-03-29 10:00:01 +0000
commitcc44146289bd38a5f95d5dbab8b28016f2599fcb (patch)
tree3555a933999d37f041ad5ba88cc860ccb8f6546c /Documentation
parent1775db99c8004699efefc010fe2f76f375adedf3 (diff)
This should make it easier to let users perform comparisons and
migrate to v2 if needed.
Diffstat (limited to 'Documentation')
2 files changed, 46 insertions, 1 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index 8250b459..22ee9095 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -40,7 +40,7 @@ Default: none, required
 =item publicinbox.<name>.mainrepo
-The absolute path to the git repository which hosts the
+The absolute path to the directory which hosts the
 public-inbox.  This must be specified once.
 Default: none, required
diff --git a/Documentation/public-inbox-convert.pod b/Documentation/public-inbox-convert.pod
new file mode 100644
index 00000000..1e16ea45
--- /dev/null
+++ b/Documentation/public-inbox-convert.pod
@@ -0,0 +1,45 @@
+=head1 NAME
+public-inbox-convert - convert v1 inboxes to v2
+=head1 SYNOPSIS
+        public-inbox-convert OLD_DIR NEW_DIR
+public-inbox-convert copies the contents of an old "v1" inbox
+into a new "v2" inbox.  It makes no changes to the old inbox
+and users are expected to update the "mainrepo" path in
+L<public-inbox-config(5)> to point to the path of NEW_DIR
+once they are satisfied with the conversion.
+=over 8
+=item PI_CONFIG
+The default config file, normally "~/.public-inbox/config".
+See L<public-inbox-config(5)>
+=head1 CONTACT
+Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
+The mail archives are hosted at L<https://public-inbox.org/meta/>
+and L<http://hjrcffqmbrq6wope.onion/meta/>
+Copyright 2013-2018 all contributors L<mailto:meta@public-inbox.org>
+License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
+=head1 SEE ALSO
+L<public-inbox-init(1)>, L<public-inbox-index(1)>