git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v1 02/11] restore: take tree-ish from --source option instead

From
Elijah Newren <newren@gmail.com>
Date
Mar 9, 2019, 18:13 UTC
Message-ID
<CABPp-BHwp_36Pc-xbCC0_t=uO3td1fn0KYjQ9N2esznJpRt3ig@mail.gmail.com>
In-Reply-To
<20190308101655.9767-3-pclouds@gmail.com>
On Fri, Mar 8, 2019 at 2:17 AM Nguyễn Thái Ngọc Duy <pclouds@gmail.com> wrote:
Show 24 quoted lines
>
> This is another departure from 'git checkout' syntax, which uses -- to
> separate ref and pathspec. The observation is restore (or "git
> checkout ,, <pathspec>") is most often used to restore some files from
> the index. If this is correct, we can simplify it by taking a way the
> ref, so that we can write
>
>     git restore some-file
>
> without worrying about some-file being a ref and whether we need to do
>
>     git restore -- some-file
>
> for safety. If the source of the restore comes from a tree, it will be
> in the form of an option with value, e.g.
>
>     git restore --source=this-tree some-file
>
> This is of course longer to type than using "--". But hopefully it
> will not be used as often, and it is clearly easier to understand.
>
> dwim_new_local_branch is no longer set (or unset) in cmd_restore_files()
> because it's irrelevant because we don't really care about dwim-ing.
> With accept_ref being unset, dwim can't happen.
Nice.  :-)
Show 14 quoted lines
>
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
>  builtin/checkout.c | 42 ++++++++++++++++++++++++++++++++++--------
>  1 file changed, 34 insertions(+), 8 deletions(-)
>
> diff --git a/builtin/checkout.c b/builtin/checkout.c
> index 11dd2ae44c..838343d6aa 100644
> --- a/builtin/checkout.c
> +++ b/builtin/checkout.c
> @@ -38,7 +38,7 @@ static const char * const switch_branch_usage[] = {
>  };
>
>  static const char * const restore_files_usage[] = {
restore_files_usage or restore_usage?
Show 37 quoted lines
> -       N_("git restore [<options>] [<branch>] -- <file>..."),
> +       N_("git restore [<options>] [--source=<branch>] <file>..."),
>         NULL,
>  };
>
> @@ -57,6 +57,7 @@ struct checkout_opts {
>         int count_checkout_paths;
>         int overlay_mode;
>         int dwim_new_local_branch;
> +       int accept_ref;
>         int accept_pathspec;
>         int switch_branch_doing_nothing_is_ok;
>         int only_merge_on_switching_branches;
> @@ -72,6 +73,7 @@ struct checkout_opts {
>         int branch_exists;
>         const char *prefix;
>         struct pathspec pathspec;
> +       const char *from_treeish;
>         struct tree *source_tree;
>  };
>
> @@ -1324,6 +1326,7 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
>  {
>         struct branch_info new_branch_info;
>         int dwim_remotes_matched = 0;
> +       int parseopt_flags = 0;
>
>         memset(&new_branch_info, 0, sizeof(new_branch_info));
>         opts->overwrite_ignore = 1;
> @@ -1335,8 +1338,13 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
>
>         opts->track = BRANCH_TRACK_UNSPECIFIED;
>
> -       argc = parse_options(argc, argv, prefix, options, usagestr,
> -                            PARSE_OPT_KEEP_DASHDASH);
> +       if (!opts->accept_pathspec && !opts->accept_ref)
> +               BUG("make up your mind, you need to take _something_");

hehe. I secretly hope that someone eventually hits that, preferably another git developer making some changes and not an end user, though.

Show 25 quoted lines
> +       if (opts->accept_pathspec && opts->accept_ref)
> +               parseopt_flags = PARSE_OPT_KEEP_DASHDASH;
> +
> +       argc = parse_options(argc, argv, prefix, options,
> +                            usagestr, parseopt_flags);
>
>         if (opts->show_progress < 0) {
>                 if (opts->quiet)
> @@ -1393,7 +1401,7 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
>          * including "last branch" syntax and DWIM-ery for names of
>          * remote branches, erroring out for invalid or ambiguous cases.
>          */
> -       if (argc) {
> +       if (argc && opts->accept_ref) {
>                 struct object_id rev;
>                 int dwim_ok =
>                         !opts->patch_mode &&
> @@ -1405,6 +1413,18 @@ static int checkout_main(int argc, const char **argv, const char *prefix,
>                                              &dwim_remotes_matched);
>                 argv += n;
>                 argc -= n;
> +       } else if (!opts->accept_ref && opts->from_treeish) {
> +               struct object_id rev;
> +
> +               if (get_oid_mb(opts->from_treeish, &rev))

Going on a slight tangent from your series: get_oid_mb really deserves a comment somewhere that "mb" is "merge base". I had to spelunk through history to find it...

Show 54 quoted lines
> +                       die(_("could not resolve %s"), opts->from_treeish);
> +
> +               setup_new_branch_info_and_source_tree(&new_branch_info,
> +                                                     opts, &rev,
> +                                                     opts->from_treeish);
> +
> +               if (!opts->source_tree)
> +                       die(_("reference is not a tree: %s"), opts->from_treeish);
>         }
>
>         if (argc) {
> @@ -1488,6 +1508,7 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
>         opts.dwim_new_local_branch = 1;
>         opts.switch_branch_doing_nothing_is_ok = 1;
>         opts.only_merge_on_switching_branches = 0;
> +       opts.accept_ref = 1;
>         opts.accept_pathspec = 1;
>         opts.implicit_detach = 1;
>
> @@ -1519,6 +1540,7 @@ int cmd_switch(int argc, const char **argv, const char *prefix)
>
>         memset(&opts, 0, sizeof(opts));
>         opts.dwim_new_local_branch = 0;
> +       opts.accept_ref = 1;
>         opts.accept_pathspec = 0;
>         opts.switch_branch_doing_nothing_is_ok = 0;
>         opts.only_merge_on_switching_branches = 1;
> @@ -1537,15 +1559,19 @@ int cmd_switch(int argc, const char **argv, const char *prefix)
>  int cmd_restore(int argc, const char **argv, const char *prefix)
>  {
>         struct checkout_opts opts;
> -       struct option *options = NULL;
> +       struct option *options;
> +       struct option restore_options[] = {
> +               OPT_STRING('s', "source", &opts.from_treeish, "<tree-ish>",
> +                          N_("where the checkout from")),
> +               OPT_END()
> +       };
>         int ret;
>
>         memset(&opts, 0, sizeof(opts));
> -       opts.dwim_new_local_branch = 1;
> -       opts.switch_branch_doing_nothing_is_ok = 0;
> +       opts.accept_ref = 0;
>         opts.accept_pathspec = 1;
>
> -       options = parse_options_dup(options);
> +       options = parse_options_dup(restore_options);
>         options = add_common_options(&opts, options);
>         options = add_checkout_path_options(&opts, options);
>
> --
> 2.21.0.rc1.337.gdf7f8d0522
>
Previous: Nguyễn Thái Ngọc DuyNext: Eric Sunshine
Message 11 of 97 in “And new command "restore"”
  1. 00/11 And new command "restore"Nguyễn Thái Ngọc Duy, Mar 8, 2019
  2. 01/11 checkout: split part of it to new command 'restore'Nguyễn Thái Ngọc Duy, Mar 8, 2019
  3. Elijah NewrenMar 8, 2019
  4. Duy NguyenMar 9, 2019
  5. Elijah NewrenMar 9, 2019
  6. Duy NguyenApr 9, 2019
  7. Duy NguyenMar 25, 2019
  8. Elijah NewrenMar 25, 2019
  9. Johannes SchindelinMar 13, 2019
  10. 02/11 restore: take tree-ish from --source option insteadNguyễn Thái Ngọc Duy, Mar 8, 2019
  11. Elijah NewrenMar 9, 2019
  12. Eric SunshineMar 10, 2019
  13. 03/11 restore: make pathspec mandatoryNguyễn Thái Ngọc Duy, Mar 8, 2019
  14. Elijah NewrenMar 9, 2019
  15. 04/11 restore: disable overlay mode by defaultNguyễn Thái Ngọc Duy, Mar 8, 2019
  16. Elijah NewrenMar 9, 2019
  17. 05/11 checkout: factor out worktree checkout codeNguyễn Thái Ngọc Duy, Mar 8, 2019
  18. 06/11 restore: add --worktree and --indexNguyễn Thái Ngọc Duy, Mar 8, 2019
  19. Elijah NewrenMar 9, 2019
  20. Eric SunshineMar 10, 2019
  21. Duy NguyenMar 13, 2019
  22. Junio C HamanoMar 13, 2019
  23. 07/11 restore: default to --source=HEAD when only --index is specifiedNguyễn Thái Ngọc Duy, Mar 8, 2019
  24. Elijah NewrenMar 9, 2019
  25. 08/11 restore: support --patchNguyễn Thái Ngọc Duy, Mar 8, 2019
  26. Elijah NewrenMar 9, 2019
  27. 09/11 t: add tests for restoreNguyễn Thái Ngọc Duy, Mar 8, 2019
  28. Andrei RybakMar 9, 2019
  29. Johannes SchindelinMar 13, 2019
  30. Duy NguyenMar 13, 2019
  31. Johannes SchindelinMar 13, 2019
  32. Duy NguyenMar 14, 2019
  33. Junio C HamanoMar 14, 2019
  34. Junio C HamanoMar 14, 2019
  35. 10/11 completion: support restoreNguyễn Thái Ngọc Duy, Mar 8, 2019
  36. Elijah NewrenMar 9, 2019
  37. Duy NguyenMar 11, 2019
  38. Duy NguyenMar 11, 2019
  39. Elijah NewrenMar 11, 2019
  40. 11/11 doc: promote "git restore"Nguyễn Thái Ngọc Duy, Mar 8, 2019
  41. Elijah NewrenMar 9, 2019
  42. Randall S. BeckerMar 11, 2019
  43. Duy NguyenMar 11, 2019
  44. Junio C HamanoMar 13, 2019
  45. Duy NguyenApr 11, 2019
  46. Duy NguyenMar 10, 2019
  47. Jacob KellerMar 10, 2019
  48. Elijah NewrenMar 11, 2019
  49. Junio C HamanoMar 13, 2019
  50. Duy NguyenMar 14, 2019
  51. 00/16 Add new command 'restore'Nguyễn Thái Ngọc Duy, Apr 11, 2019
  52. 01/16 checkout: split part of it to new command 'restore'Nguyễn Thái Ngọc Duy, Apr 11, 2019
  53. 02/16 restore: take tree-ish from --source option insteadNguyễn Thái Ngọc Duy, Apr 11, 2019
  54. 03/16 restore: make pathspec mandatoryNguyễn Thái Ngọc Duy, Apr 11, 2019
  55. 04/16 restore: disable overlay mode by defaultNguyễn Thái Ngọc Duy, Apr 11, 2019
  56. 05/16 checkout: factor out worktree checkout codeNguyễn Thái Ngọc Duy, Apr 11, 2019
  57. 06/16 restore: add --worktree and --stagedNguyễn Thái Ngọc Duy, Apr 11, 2019
  58. 07/16 restore: reject invalid combinations with --stagedNguyễn Thái Ngọc Duy, Apr 11, 2019
  59. 08/16 restore: default to --source=HEAD when only --staged is specifiedNguyễn Thái Ngọc Duy, Apr 11, 2019
  60. 09/16 restore: replace --force with --ignore-unmergedNguyễn Thái Ngọc Duy, Apr 11, 2019
  61. 10/16 restore: support --patchNguyễn Thái Ngọc Duy, Apr 11, 2019
  62. 11/16 t: add tests for restoreNguyễn Thái Ngọc Duy, Apr 11, 2019
  63. 12/16 completion: support restoreNguyễn Thái Ngọc Duy, Apr 11, 2019
  64. 13/16 user-manual.txt: prefer 'merge --abort' over 'reset --hard'Nguyễn Thái Ngọc Duy, Apr 11, 2019
  65. 14/16 doc: promote "git restore"Nguyễn Thái Ngọc Duy, Apr 11, 2019
  66. 15/16 rm: add --staged as alias for --cachedNguyễn Thái Ngọc Duy, Apr 11, 2019
  67. 16/16 help: move git-diff and git-reset to different groupsNguyễn Thái Ngọc Duy, Apr 11, 2019
  68. Junio C HamanoApr 12, 2019
  69. Duy NguyenApr 13, 2019
  70. Duy NguyenApr 17, 2019
  71. Junio C HamanoApr 18, 2019
  72. Duy NguyenApr 18, 2019
  73. Johannes SchindelinApr 18, 2019
  74. Duy NguyenApr 18, 2019
  75. 00/16 Add new command 'restore'Nguyễn Thái Ngọc Duy, Apr 25, 2019
  76. 01/16 checkout: split part of it to new command 'restore'Nguyễn Thái Ngọc Duy, Apr 25, 2019
  77. 02/16 restore: take tree-ish from --source option insteadNguyễn Thái Ngọc Duy, Apr 25, 2019
  78. 03/16 restore: make pathspec mandatoryNguyễn Thái Ngọc Duy, Apr 25, 2019
  79. 04/16 restore: disable overlay mode by defaultNguyễn Thái Ngọc Duy, Apr 25, 2019
  80. 05/16 checkout: factor out worktree checkout codeNguyễn Thái Ngọc Duy, Apr 25, 2019
  81. 06/16 restore: add --worktree and --stagedNguyễn Thái Ngọc Duy, Apr 25, 2019
  82. 07/16 restore: reject invalid combinations with --stagedNguyễn Thái Ngọc Duy, Apr 25, 2019
  83. 08/16 restore: default to --source=HEAD when only --staged is specifiedNguyễn Thái Ngọc Duy, Apr 25, 2019
  84. 09/16 restore: replace --force with --ignore-unmergedNguyễn Thái Ngọc Duy, Apr 25, 2019
  85. 10/16 restore: support --patchNguyễn Thái Ngọc Duy, Apr 25, 2019
  86. 11/16 t: add tests for restoreNguyễn Thái Ngọc Duy, Apr 25, 2019
  87. SZEDER GáborJun 13, 2019
  88. 12/16 completion: support restoreNguyễn Thái Ngọc Duy, Apr 25, 2019
  89. 13/16 user-manual.txt: prefer 'merge --abort' over 'reset --hard'Nguyễn Thái Ngọc Duy, Apr 25, 2019
  90. 14/16 doc: promote "git restore"Nguyễn Thái Ngọc Duy, Apr 25, 2019
  91. 15/16 help: move git-diff and git-reset to different groupsNguyễn Thái Ngọc Duy, Apr 25, 2019
  92. 16/16 Declare both git-switch and git-restore experimentalNguyễn Thái Ngọc Duy, Apr 25, 2019
  93. Emily ShafferMay 7, 2019
  94. Junio C HamanoMay 7, 2019
  95. Duy NguyenMay 7, 2019
  96. Emily ShafferMay 7, 2019
  97. Duy NguyenMay 8, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.