Merge branch 'jk/parseopt-string-list' into jk/string-list-static-init
[gitweb.git] / Documentation / technical / api-ref-iteration.txt
index aa1c50f181eb20e27a8299ca8ec691eeffa9d51b..37379d83376fc2342d1a81570b3de86b8e7dcd49 100644 (file)
@@ -6,7 +6,7 @@ Iteration of refs is done by using an iterate function which will call a
 callback function for every ref. The callback function has this
 signature:
 
-       int handle_one_ref(const char *refname, const unsigned char *sha1,
+       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
@@ -50,10 +50,10 @@ submodules object database. You can do this by a code-snippet like
 this:
 
        const char *path = "path/to/submodule"
-       if (!add_submodule_odb(path))
+       if (add_submodule_odb(path))
                die("Error submodule '%s' not populated.", path);
 
-`add_submodule_odb()` will return an non-zero value on success. If you
+`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.