[PATCH] git-pack-objects progress flag documentation and cleanup
From: Nicolas Pitre <hidden>
Date: 2016-08-11 19:44:19
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
This adds documentation for --progress and --all-progress, remove a duplicate --progress handling and make usage string more readable. Signed-off-by: Nicolas Pitre <redacted> ---
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index 5ebe34e..fdc6f97 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt@@ -99,6 +99,23 @@ base-name:: Only create a packed archive if it would contain at least one object. +--progress:: + Progress status is reported on the standard error stream + by default when it is attached to a terminal, unless -q + is specified. This flag forces progress status even if + the standard error stream is not directed to a terminal. + +--all-progress:: + When --stdout is specified then progress report is + displayed during the object count and deltification phases + but inhibited during the write-out phase. The reason is + that in some cases the output stream is directly linked + to another command which may wish to display progress + status of its own as it processes incoming pack data. + This flag is like --progress except that it forces progress + report for the write-out phase as well even if --stdout is + used. + -q:: This flag makes the command not to report its progress on the standard error stream.
diff --git a/builtin-pack-objects.c b/builtin-pack-objects.c
index 270bcbd..69e5dd3 100644
--- a/builtin-pack-objects.c
+++ b/builtin-pack-objects.c@@ -15,7 +15,12 @@ #include <sys/time.h> #include <signal.h> -static const char pack_usage[] = "git-pack-objects [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty] [--local] [--incremental] [--window=N] [--depth=N] [--all-progress] [--revs [--unpacked | --all]*] [--stdout | base-name] <ref-list | <object-list]"; +static const char pack_usage[] = "\ +git-pack-objects [{ -q | --progress | --all-progress }] \n\ + [--local] [--incremental] [--window=N] [--depth=N] \n\ + [--no-reuse-delta] [--delta-base-offset] [--non-empty] \n\ + [--revs [--unpacked | --all]*] [--stdout | base-name] \n\ + [<ref-list | <object-list]"; struct object_entry { unsigned char sha1[20];
@@ -1520,14 +1525,6 @@ int cmd_pack_objects(int argc, const cha local = 1; continue; } - if (!strcmp("--progress", arg)) { - progress = 1; - continue; - } - if (!strcmp("--all-progress", arg)) { - progress = 2; - continue; - } if (!strcmp("--incremental", arg)) { incremental = 1; continue;
@@ -1550,6 +1547,10 @@ int cmd_pack_objects(int argc, const cha progress = 1; continue; } + if (!strcmp("--all-progress", arg)) { + progress = 2; + continue; + } if (!strcmp("-q", arg)) { progress = 0;