builtin: add new "history" command

When rewriting history via git-rebase(1) there are a couple of very
common use cases:

  - The ordering of two commits should be reversed.

  - A commit should be split up into two commits.

  - A commit should be dropped from the history completely.

  - Multiple commits should be squashed into one.

While these operations are all doable, it often feels needlessly kludgey
to do so by doing an interactive rebase, using the editor to say what
one wants, and then perform the actions. Furthermore, some operations
like splitting up a commit into two are way more involved than that and
require a whole series of commands.

Add a new "history" command to plug this gap. This command will have
several different subcommands to imperatively rewrite history for common
use cases like the above. These subcommands will be implemented in
subsequent commits.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/.gitignore b/.gitignore
index 78a45cb5bec99153c74b1978e789535e58115e14..24635cf2d6f4a37843ea7091da07c0d101dcac5b 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -79,6 +79,7 @@
 /git-grep
 /git-hash-object
 /git-help
+/git-history
 /git-hook
 /git-http-backend
 /git-http-fetch

diff --git a/Documentation/git-history.adoc b/Documentation/git-history.adoc
new file mode 100644 (file)
index 0000000..6bdfeb5
--- /dev/null
+++ b/Documentation/git-history.adoc
@@ -0,0 +1,44 @@
+git-history(1)
+==============
+
+NAME
+----
+git-history - EXPERIMENTAL: Rewrite history of the current branch
+
+SYNOPSIS
+--------
+[synopsis]
+git history [<options>]
+
+DESCRIPTION
+-----------
+
+Rewrite history by rearranging or modifying specific commits in the
+history.
+
+THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
+
+This command is similar to linkgit:git-rebase[1] and uses the same
+underlying machinery. You should use rebases if you want to reapply a range of
+commits onto a different base, or interactive rebases if you want to edit a
+range of commits.
+
+Note that this command does not (yet) work with histories that contain
+merges. You should use linkgit:git-rebase[1] with the `--rebase-merges`
+flag instead.
+
+COMMANDS
+--------
+
+Several commands are available to rewrite history in different ways:
+
+CONFIGURATION
+-------------
+
+include::includes/cmd-config-section-all.adoc[]
+
+include::config/sequencer.adoc[]
+
+GIT
+---
+Part of the linkgit:git[1] suite

diff --git a/Documentation/meson.build b/Documentation/meson.build
index 44f94cdb7ba6729c93c55d8091bd4a58c144c642..cf551a28ae7046edc52f143e316b6594dab88868 100644 (file)
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -64,6 +64,7 @@ manpages = {
   'git-gui.adoc' : 1,
   'git-hash-object.adoc' : 1,
   'git-help.adoc' : 1,
+  'git-history.adoc' : 1,
   'git-hook.adoc' : 1,
   'git-http-backend.adoc' : 1,
   'git-http-fetch.adoc' : 1,

diff --git a/Makefile b/Makefile
index 01c171b4f03a36bcfeebc07d08f246e3bcb4fef8..1380ee1e1961540ade5c0e7fdb78cb8db037c07d 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1395,6 +1395,7 @@ BUILTIN_OBJS += builtin/get-tar-commit-id.o
 BUILTIN_OBJS += builtin/grep.o
 BUILTIN_OBJS += builtin/hash-object.o
 BUILTIN_OBJS += builtin/help.o
+BUILTIN_OBJS += builtin/history.o
 BUILTIN_OBJS += builtin/hook.o
 BUILTIN_OBJS += builtin/index-pack.o
 BUILTIN_OBJS += builtin/init-db.o

diff --git a/builtin.h b/builtin.h
index 1b35565fbd9a3ce184fbe1d2e5c682d662bded9d..93c91d07d4bfdc4f3cd101f2bdb7f88bda92598b 100644 (file)
--- a/builtin.h
+++ b/builtin.h
@@ -172,6 +172,7 @@ int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix, struc
 int cmd_grep(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_hash_object(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_help(int argc, const char **argv, const char *prefix, struct repository *repo);
+int cmd_history(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_hook(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_index_pack(int argc, const char **argv, const char *prefix, struct repository *repo);
 int cmd_init_db(int argc, const char **argv, const char *prefix, struct repository *repo);

diff --git a/builtin/history.c b/builtin/history.c
new file mode 100644 (file)
index 0000000..f6fe326
--- /dev/null
+++ b/builtin/history.c
@@ -0,0 +1,22 @@
+#include "builtin.h"
+#include "gettext.h"
+#include "parse-options.h"
+
+int cmd_history(int argc,
+               const char **argv,
+               const char *prefix,
+               struct repository *repo UNUSED)
+{
+       const char * const usage[] = {
+               N_("git history [<options>]"),
+               NULL,
+       };
+       struct option options[] = {
+               OPT_END(),
+       };
+
+       argc = parse_options(argc, argv, prefix, options, usage, 0);
+       if (argc)
+               usagef("unrecognized argument: %s", argv[0]);
+       return 0;
+}

diff --git a/command-list.txt b/command-list.txt
index accd3d0c4b55249ad120452711e9d819fa083d45..f9005cf45979f114142a8a8474c8fcfaa3747bf7 100644 (file)
--- a/command-list.txt
+++ b/command-list.txt
@@ -115,6 +115,7 @@ git-grep                                mainporcelain           info
 git-gui                                 mainporcelain
 git-hash-object                         plumbingmanipulators
 git-help                                ancillaryinterrogators          complete
+git-history                             mainporcelain           history
 git-hook                                purehelpers
 git-http-backend                        synchingrepositories
 git-http-fetch                          synchelpers

diff --git a/git.c b/git.c
index c5fad56813f437cac4e3f52a7f96b2dc594fa25a..744cb6527e065e262989d9cd464b476e084e008a 100644 (file)
--- a/git.c
+++ b/git.c
@@ -586,6 +586,7 @@ static struct cmd_struct commands[] = {
        { "grep", cmd_grep, RUN_SETUP_GENTLY },
        { "hash-object", cmd_hash_object },
        { "help", cmd_help },
+       { "history", cmd_history, RUN_SETUP },
        { "hook", cmd_hook, RUN_SETUP },
        { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
        { "init", cmd_init_db },

diff --git a/meson.build b/meson.build
index ae8d4fef059f997e169647ea7fec8f5d2f89ddb0..2d789612a013befedd61e3402011447a4605d00f 100644 (file)
--- a/meson.build
+++ b/meson.build
@@ -604,6 +604,7 @@ builtin_sources = [
   'builtin/grep.c',
   'builtin/hash-object.c',
   'builtin/help.c',
+  'builtin/history.c',
   'builtin/hook.c',
   'builtin/index-pack.c',
   'builtin/init-db.c',

diff --git a/t/meson.build b/t/meson.build
index 401b24e50e0499877673733d3e15bedc0da8bb9c..019435918fae9367342744bd13fc569af33b1660 100644 (file)
--- a/t/meson.build
+++ b/t/meson.build
@@ -384,6 +384,7 @@ integration_tests = [
   't3436-rebase-more-options.sh',
   't3437-rebase-fixup-options.sh',
   't3438-rebase-broken-files.sh',
+  't3450-history.sh',
   't3500-cherry.sh',
   't3501-revert-cherry-pick.sh',
   't3502-cherry-pick-merge.sh',

diff --git a/t/t3450-history.sh b/t/t3450-history.sh
new file mode 100755 (executable)
index 0000000..417c343
--- /dev/null
+++ b/t/t3450-history.sh
@@ -0,0 +1,17 @@
+#!/bin/sh
+
+test_description='tests for git-history command'
+
+. ./test-lib.sh
+
+test_expect_success 'does nothing without any arguments' '
+       git history >out 2>&1 &&
+       test_must_be_empty out
+'
+
+test_expect_success 'raises an error with unknown argument' '
+       test_must_fail git history garbage 2>err &&
+       test_grep "unrecognized argument: garbage" err
+'
+
+test_done