Add description of --jobs to the docs. Also, add missing newline in --help output.

schmiddy · schmiddy · commit d43ff3cd24fe · 2012-12-14T18:49:00.000-07:00
diff --git a/bin/pg_repack.c b/bin/pg_repack.c
@@ -1430,7 +1430,7 @@ pgut_help(bool details)
 
 	printf("Options:\n");
 	printf("  -a, --all                 repack all databases\n");
-	printf("  -j --jobs                 Use this many parallel jobs");
+	printf("  -j --jobs                 Use this many parallel jobs for each table\n");
 	printf("  -n, --no-order            do vacuum full instead of cluster\n");
 	printf("  -o, --order-by=COLUMNS    order by columns instead of cluster keys\n");
 	printf("  -t, --table=TABLE         repack specific table only\n");
diff --git a/doc/pg_repack.rst b/doc/pg_repack.rst
@@ -117,6 +117,7 @@ The following options can be specified in ``OPTIONS``.
 
 Options:
   -a, --all                 repack all databases
+  -j, --jobs                 Use this many parallel jobs for each table
   -n, --no-order            do vacuum full instead of cluster
   -o, --order-by=COLUMNS    order by columns instead of cluster keys
   -t, --table=TABLE         repack specific table only
@@ -145,6 +146,12 @@ Options to order rows. If not specified, pg_repack performs an online CLUSTER
 using cluster indexes. Only one option can be specified. You may also specify
 target tables or databases.
 
+``-j``, ``--jobs``
+   Create the specified number of extra connections to PostgreSQL, and
+   use these extra connections to parallelize the rebuild of indexes
+   on each table. If your PostgreSQL server has extra cores and disk
+   I/O available, this can be a useful way to speed up pg_repack.
+
 ``-n``, ``--no-order``
     Perform an online VACUUM FULL.
 
