path: root/Documentation/technical/api-ref-iteration.txt
diff options
authorHeba Waly <>2019-11-17 21:04:46 (GMT)
committerJunio C Hamano <>2019-11-18 06:21:28 (GMT)
commit126c1ccefbeec2b3ba368146f057054352484ef4 (patch)
treee3d7de2a89ffac07ee6a6cad9b65026e901f2821 /Documentation/technical/api-ref-iteration.txt
parentd27eb356bf253be763ab08733fae723adda27e1c (diff)
refs: move doc to refs.h
Move the documentation from Documentation/technical/api-ref-iteration.txt to refs.h as it's easier for the developers to find the usage information beside the code instead of looking for it in another doc file. Also documentation/technical/api-ref-iteration.txt is removed because the information it has is now redundant and it'll be hard to keep it up to date and synchronized with the documentation in the header file. Signed-off-by: Heba Waly <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/technical/api-ref-iteration.txt')
1 files changed, 0 insertions, 78 deletions
diff --git a/Documentation/technical/api-ref-iteration.txt b/Documentation/technical/api-ref-iteration.txt
deleted file mode 100644
index ad9d019..0000000
--- a/Documentation/technical/api-ref-iteration.txt
+++ /dev/null
@@ -1,78 +0,0 @@
-ref iteration API
-Iteration of refs is done by using an iterate function which will call a
-callback function for every ref. The callback function has this
- int handle_one_ref(const char *refname, const struct object_id *oid,
- int flags, void *cb_data);
-There are different kinds of iterate functions which all take a
-callback of this type. The callback is then called for each found ref
-until the callback returns nonzero. The returned value is then also
-returned by the iterate function.
-Iteration functions
-* `head_ref()` just iterates the head ref.
-* `for_each_ref()` iterates all refs.
-* `for_each_ref_in()` iterates all refs which have a defined prefix and
- strips that prefix from the passed variable refname.
-* `for_each_tag_ref()`, `for_each_branch_ref()`, `for_each_remote_ref()`,
- `for_each_replace_ref()` iterate refs from the respective area.
-* `for_each_glob_ref()` iterates all refs that match the specified glob
- pattern.
-* `for_each_glob_ref_in()` the previous and `for_each_ref_in()` combined.
-* Use `refs_` API for accessing submodules. The submodule ref store could
- be obtained with `get_submodule_ref_store()`.
-* `for_each_rawref()` can be used to learn about broken ref and symref.
-* `for_each_reflog()` iterates each reflog file.
-If you want to iterate the refs of a submodule you first need to add the
-submodules object database. You can do this by a code-snippet like
- const char *path = "path/to/submodule"
- if (add_submodule_odb(path))
- die("Error submodule '%s' not populated.", path);
-`add_submodule_odb()` will return zero on success. If you
-do not do this you will get an error for each ref that it does not point
-to a valid object.
-Note: As a side-effect of this you cannot safely assume that all
-objects you lookup are available in superproject. All submodule objects
-will be available the same way as the superprojects objects.
-static int handle_remote_ref(const char *refname,
- const unsigned char *sha1, int flags, void *cb_data)
- struct strbuf *output = cb_data;
- strbuf_addf(output, "%s\n", refname);
- return 0;
- struct strbuf output = STRBUF_INIT;
- for_each_remote_ref(handle_remote_ref, &output);
- printf("%s", output.buf);