diff options
| author |  Stefan Beller <sbeller@google.com> | 2016-11-22 12:14:37 -0800 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2016-11-22 14:43:03 -0800 |
| commit | 73c293bb6c15992690b16c90bcac243a76d86400 (patch) | |
| tree | 49b5570f7f76e846002f69f712231866cd50ffae /Documentation | |
| parent | submodule config: inline config_from_{name, path} (diff) | |
| download | tgif-73c293bb6c15992690b16c90bcac243a76d86400.tar.xz | |
submodule-config: rename commit_sha1 to treeish_name
It is also possible to pass in any treeish name to lookup a submodule
config. Make it clear by naming the variables accordingly. Looking up
a submodule config by tree hash will come in handy in a later patch.
Signed-off-by: Stefan Beller <sbeller@google.com>
Reviewed-by: Brandon Williams <bmwill@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/technical/api-submodule-config.txt | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/technical/api-submodule-config.txt b/Documentation/technical/api-submodule-config.txt index 941fa178dd..8285bcc605 100644 --- a/Documentation/technical/api-submodule-config.txt +++ b/Documentation/technical/api-submodule-config.txt @@ -47,15 +47,16 @@ Functions Can be passed to the config parsing infrastructure to parse local (worktree) submodule configurations. -`const struct submodule *submodule_from_path(const unsigned char *commit_sha1, const char *path)`:: +`const struct submodule *submodule_from_path(const unsigned char *treeish_name, const char *path)`:: - Lookup values for one submodule by its commit_sha1 and path. + Given a tree-ish in the superproject and a path, return the + submodule that is bound at the path in the named tree. -`const struct submodule *submodule_from_name(const unsigned char *commit_sha1, const char *name)`:: +`const struct submodule *submodule_from_name(const unsigned char *treeish_name, const char *name)`:: The same as above but lookup by name. -If given the null_sha1 as commit_sha1 the local configuration of a +If given the null_sha1 as treeish_name the local configuration of a submodule will be returned (e.g. consolidated values from local git configuration and the .gitmodules file in the worktree). |