submodule-config: clarify/cleanup docs and header
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v4 Latest3 patches 1 replyIn review
- v33 patches 2 repliesSuperseded
- v23 patches 8 repliesSuperseded
Earlier versions · 1
| Version | Posted | Patches | Replies | Status |
|---|---|---|---|---|
| v1 | 3 patches | 1 reply | Superseded |
Changes in v4 from the cover letter
* renamed commit_or_tree to treeish_name
* added a test with a tag
* "it will overwrite" (removed the spurious "be").
Patches in v4 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/3 | submodule config: inline config_from_{name, path}submodule-config.c | +2 | 0 replies | |
| 2/3 | submodule-config: rename commit_sha1 to treeish_nameDocumentation/ submodule-config.c submodule-config.h +1 more | +44 | 0 replies | |
| 3/3 | submodule-config: clarify parsing of null_sha1 elementDocumentation/ | +5 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v4 yet.
Cover letter [PATCHv4 0/3] submodule-config: clarify/cleanup docs and header
replacing sb/submodule-config-cleanup
v4:
* renamed commit_or_tree to treeish_name
* added a test with a tag
* "it will overwrite" (removed the spurious "be").
v3:
diff to current origin/sb/submodule-config-cleanup:
Documentation/technical/api-submodule-config.txt +5 -5
@@ -49,17 +49,17 @@ Functions `const struct submodule *submodule_from_path(const unsigned char *commit_or_tree, const char *path)`:: - Lookup values for one submodule by its commit_sha1 and path. + Lookup values for one submodule by its commit_or_tree and path. `const struct submodule *submodule_from_name(const unsigned char *commit_or_tree, const char *name)`:: The same as above but lookup by name. Whenever a submodule configuration is parsed in `parse_submodule_config_option` -via e.g. `gitmodules_config()`, it will be overwrite the entry with the sha1 -zeroed out. So in the normal case, when HEAD:.gitmodules is parsed first and -then overlayed with the repository configuration, the null_sha1 entry contains -the local configuration of a submodule (e.g. consolidated values from local git +via e.g. `gitmodules_config()`, it will be overwrite the null_sha1 entry. +So in the normal case, when HEAD:.gitmodules is parsed first and then overlayed +with the repository configuration, the null_sha1 entry contains the local +configuration of a submodule (e.g. consolidated values from local git configuration and the .gitmodules file in the worktree). For an example usage see test-submodule-config.c.
submodule-config.c +0 -1
@@ -448,7 +448,6 @@ static const struct submodule *config_from(struct submodule_cache *cache,/* fill the submodule config into the cache */ parameter.cache = cache; -// todo: get the actual tree here: parameter.commit_or_tree = commit_or_tree; parameter.gitmodules_sha1 = sha1; parameter.overwrite =0 ;
v2:
addressed Jacobs concerns in patch2, fixing all occurrences of commit_sha1.
Thanks,
Stefan
interdiff to v1:
Documentation/technical/api-submodule-config.txt +1 -1
@@ -49,7 +49,7 @@ Functions `const struct submodule *submodule_from_path(const unsigned char *commit_or_tree, const char *path)`:: - Lookup values for one submodule by its commit_sha1 and path. + Lookup values for one submodule by its commit_or_tree and path. `const struct submodule *submodule_from_name(const unsigned char *commit_or_tree, const char *name)`::
v1:
A small series that would have helped me understand the submodule config once again.
Thanks,
Stefan
Stefan Beller (3):
submodule config: inline config_from_{name, path}
submodule-config: rename commit_sha1 to treeish_name
submodule-config: clarify parsing of null_sha1 element
Documentation/technical/api-submodule-config.txt | 14 ++++-- submodule-config.c | 58 ++++++++++-------------- submodule-config.h | 4 +- t/t7411-submodule-config.sh | 14 ++++++ 4 files changed, 48 insertions(+), 42 deletions(-)
Signature · 1 line
2.11.0.rc2.4.g3396b6f.dirty