With the same reasoning as for git-init(1), rename "--ref-format=" to
"--ref-storage=" and keep the old name as an alias.
Note that this commit is a bit more complex compared to the others as we
also need to adapt the submodule helper for consistency. But overall,
the changes are straight-forward and in the same spirit.
Signed-off-by: Patrick Steinhardt <ps@xxxxxx>
---
Documentation/git-submodule.adoc | 8 ++++----
builtin/clone.c | 2 +-
builtin/submodule--helper.c | 24 +++++++++++++++---------
git-submodule.sh | 20 ++++++++++----------
t/t7424-submodule-mixed-ref-formats.sh | 6 +++---
5 files changed, 33 insertions(+), 27 deletions(-)
diff --git a/Documentation/git-submodule.adoc b/Documentation/git-submodule.adoc
index 722d827908..a3713709b1 100644
--- a/Documentation/git-submodule.adoc
+++ b/Documentation/git-submodule.adoc
@@ -34,7 +34,7 @@ COMMANDS
With no arguments, shows the status of existing submodules. Several
subcommands are available to perform operations on the submodules.
-`add [-b <branch>] [-f | --force] [--name <name>] [--reference <repository>] [--ref-format <format>] [--depth <depth>] [--] <repository> [<path>]`::
+`add [-b <branch>] [-f | --force] [--name <name>] [--reference <repository>] [--ref-storage <format>] [--depth <depth>] [--] <repository> [<path>]`::
Add the given repository as a submodule at the given path
to the changeset to be committed next to the current
project: the current project is termed the "superproject".
@@ -72,7 +72,7 @@ location, and only the superproject's URL needs to be provided.
git-submodule will correctly locate the submodule using the relative
URL in `.gitmodules`.
+
-If `--ref-format <format>` is specified, the ref storage format of newly
+If `--ref-storage <format>` is specified, the ref storage format of newly
cloned submodules will be set accordingly.
`status [--cached] [--recursive] [--] [<path>...]`::
@@ -139,7 +139,7 @@ If you really want to remove a submodule from the repository and commit
that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal
options.
-`update [--init] [--remote] [-N | --no-fetch] [--[no-]recommend-shallow] [-f | --force] [--checkout | --rebase | --merge] [--reference=<repository>] [--ref-format=<format>] [--depth=<depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter=<filter-spec>] [--] [<path>...]`::
+`update [--init] [--remote] [-N | --no-fetch] [--[no-]recommend-shallow] [-f | --force] [--checkout | --rebase | --merge] [--reference=<repository>] [--ref-storage=<format>] [--depth=<depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter=<filter-spec>] [--] [<path>...]`::
+
--
Update the registered submodules to match what the superproject
@@ -188,7 +188,7 @@ submodule with the `--init` option.
If `--recursive` is specified, this command will recurse into the
registered submodules, and update any nested submodules within.
-If `--ref-format <format>` is specified, the ref storage format of newly
+If `--ref-storage <format>` is specified, the ref storage format of newly
cloned submodules will be set accordingly.
If `--filter <filter-spec>` is specified, the given partial clone filter will be
diff --git a/builtin/clone.c b/builtin/clone.c
index 63bd7b795d..c4f9dc7472 100644
--- a/builtin/clone.c
+++ b/builtin/clone.c
@@ -725,7 +725,7 @@ static int checkout(int submodule_progress,
}
if (ref_storage_format != REF_STORAGE_FORMAT_UNKNOWN)
- strvec_pushf(&cmd.args, "--ref-format=%s",
+ strvec_pushf(&cmd.args, "--ref-storage=%s",
ref_storage_format_to_name(ref_storage_format));
if (filter_submodules && filter_options->choice)
diff --git a/builtin/submodule--helper.c b/builtin/submodule--helper.c
index e7cd3225fa..50bc4aeb4d 100644
--- a/builtin/submodule--helper.c
+++ b/builtin/submodule--helper.c
@@ -1941,7 +1941,7 @@ static int clone_submodule(const struct module_clone_data *clone_data,
item->string, NULL);
}
if (clone_data->ref_storage_format != REF_STORAGE_FORMAT_UNKNOWN)
- strvec_pushf(&cp.args, "--ref-format=%s",
+ strvec_pushf(&cp.args, "--ref-storage=%s",
ref_storage_format_to_name(clone_data->ref_storage_format));
if (clone_data->dissociate)
strvec_push(&cp.args, "--dissociate");
@@ -2057,8 +2057,10 @@ static int module_clone(int argc, const char **argv, const char *prefix,
OPT_STRING_LIST(0, "reference", &reference,
N_("repo"),
N_("reference repository")),
- OPT_STRING(0, "ref-format", &ref_storage_format, N_("format"),
- N_("specify the reference format to use")),
+ OPT_STRING(0, "ref-storage", &ref_storage_format, N_("format"),
+ N_("specify the reference storage format to use")),
+ OPT_STRING_F(0, "ref-format", &ref_storage_format, N_("format"),
+ N_("specify the reference storage format to use"), PARSE_OPT_HIDDEN),
OPT_BOOL(0, "dissociate", &dissociate,
N_("use --reference only while cloning")),
OPT_INTEGER(0, "depth", &clone_data.depth,
@@ -2357,7 +2359,7 @@ static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
if (suc->update_data->require_init)
strvec_push(&child->args, "--require-init");
if (suc->update_data->ref_storage_format != REF_STORAGE_FORMAT_UNKNOWN)
- strvec_pushf(&child->args, "--ref-format=%s",
+ strvec_pushf(&child->args, "--ref-storage=%s",
ref_storage_format_to_name(suc->update_data->ref_storage_format));
strvec_pushl(&child->args, "--path", sub->path, NULL);
strvec_pushl(&child->args, "--name", sub->name, NULL);
@@ -2801,7 +2803,7 @@ static void update_data_to_args(const struct update_data *update_data,
strvec_pushl(args, "--reference", item->string, NULL);
}
if (update_data->ref_storage_format != REF_STORAGE_FORMAT_UNKNOWN)
- strvec_pushf(args, "--ref-format=%s",
+ strvec_pushf(args, "--ref-storage=%s",
ref_storage_format_to_name(update_data->ref_storage_format));
if (update_data->filter_options && update_data->filter_options->choice)
strvec_pushf(args, "--filter=%s",
@@ -3010,8 +3012,10 @@ static int module_update(int argc, const char **argv, const char *prefix,
SM_UPDATE_REBASE),
OPT_STRING_LIST(0, "reference", &opt.references, N_("repo"),
N_("reference repository")),
- OPT_STRING(0, "ref-format", &ref_storage_format, N_("format"),
- N_("specify the reference format to use")),
+ OPT_STRING(0, "ref-storage", &ref_storage_format, N_("format"),
+ N_("specify the reference storage format to use")),
+ OPT_STRING_F(0, "ref-format", &ref_storage_format, N_("format"),
+ N_("specify the reference storage format to use"), PARSE_OPT_HIDDEN),
OPT_BOOL(0, "dissociate", &opt.dissociate,
N_("use --reference only while cloning")),
OPT_INTEGER(0, "depth", &opt.depth,
@@ -3659,8 +3663,10 @@ static int module_add(int argc, const char **argv, const char *prefix,
OPT_BOOL(0, "progress", &progress, N_("force cloning progress")),
OPT_STRING(0, "reference", &add_data.reference_path, N_("repository"),
N_("reference repository")),
- OPT_STRING(0, "ref-format", &ref_storage_format, N_("format"),
- N_("specify the reference format to use")),
+ OPT_STRING(0, "ref-storage", &ref_storage_format, N_("format"),
+ N_("specify the reference storage format to use")),
+ OPT_STRING_F(0, "ref-format", &ref_storage_format, N_("format"),
+ N_("specify the reference storage format to use"), PARSE_OPT_HIDDEN),
OPT_BOOL(0, "dissociate", &dissociate, N_("borrow the objects from reference repositories")),
OPT_STRING(0, "name", &add_data.sm_name, N_("name"),
N_("sets the submodule's name to the given string "
diff --git a/git-submodule.sh b/git-submodule.sh
index 2999b31fad..3d16f28ad6 100755
--- a/git-submodule.sh
+++ b/git-submodule.sh
@@ -95,13 +95,13 @@ cmd_add()
--reference=*)
reference="1ドル"
;;
- --ref-format)
+ --ref-format|--ref-storage)
case "2ドル" in '') usage ;; esac
- ref_format="--ref-format=2ドル"
+ ref_storage="--ref-storage=2ドル"
shift
;;
- --ref-format=*)
- ref_format="1ドル"
+ --ref-format=*|--ref-storage=*)
+ ref_storage="1ドル"
;;
--dissociate)
dissociate=1ドル
@@ -147,7 +147,7 @@ cmd_add()
$progress \
${branch:+"$branch"} \
${reference:+"$reference"} \
- ${ref_format:+"$ref_format"} \
+ ${ref_storage:+"$ref_storage"} \
$dissociate \
${name:+"$name"} \
${depth:+"$depth"} \
@@ -302,13 +302,13 @@ cmd_update()
-r|--rebase)
rebase=1ドル
;;
- --ref-format)
+ --ref-format|--ref-storage)
case "2ドル" in '') usage ;; esac
- ref_format="--ref-format=2ドル"
+ ref_storage="--ref-storage=2ドル"
shift
;;
- --ref-format=*)
- ref_format="1ドル"
+ --ref-format=*|--ref-storage=*)
+ ref_storage="1ドル"
;;
--reference)
case "2ドル" in '') usage ;; esac
@@ -385,7 +385,7 @@ cmd_update()
$rebase \
$merge \
$checkout \
- ${ref_format:+"$ref_format"} \
+ ${ref_storage:+"$ref_storage"} \
${reference:+"$reference"} \
$dissociate \
${depth:+"$depth"} \
diff --git a/t/t7424-submodule-mixed-ref-formats.sh b/t/t7424-submodule-mixed-ref-formats.sh
index 5c26fc18be..c20d981ef2 100755
--- a/t/t7424-submodule-mixed-ref-formats.sh
+++ b/t/t7424-submodule-mixed-ref-formats.sh
@@ -44,7 +44,7 @@ test_expect_success 'add submodules with different ref storage format' '
test_commit -C submodule submodule-initial &&
git init upstream &&
test_ref_format upstream "$GIT_DEFAULT_REF_FORMAT" &&
- git -C upstream submodule add --ref-format="$OTHER_FORMAT" "file://$(pwd)/submodule" &&
+ git -C upstream submodule add --ref-storage="$OTHER_FORMAT" "file://$(pwd)/submodule" &&
test_ref_format upstream/submodule "$OTHER_FORMAT"
'
@@ -82,7 +82,7 @@ test_expect_success 'clone submodules with different ref storage format' '
git clone --no-recurse-submodules "file://$(pwd)/upstream" downstream &&
test_ref_format downstream "$GIT_DEFAULT_REF_FORMAT" &&
- git -C downstream submodule update --init --ref-format=$OTHER_FORMAT &&
+ git -C downstream submodule update --init --ref-storage=$OTHER_FORMAT &&
test_ref_format downstream/submodule "$OTHER_FORMAT"
'
@@ -122,7 +122,7 @@ test_expect_success 'recursive pull with mixed formats' '
# Clone the upstream repository such that the main repo and its
# submodules have different formats.
git clone --no-recurse-submodules "file://$(pwd)/upstream" downstream &&
- git -C downstream submodule update --init --ref-format=$OTHER_FORMAT &&
+ git -C downstream submodule update --init --ref-storage=$OTHER_FORMAT &&
test_ref_format downstream "$GIT_DEFAULT_REF_FORMAT" &&
test_ref_format downstream/submodule "$OTHER_FORMAT" &&
--
2.55.0.1007.g17ff1f9808.dirty