From: Nick Townsend <nick.townsend@mac.com>
Date: Mon, 25 Nov 2013 23:31:09 +0000 (-0800)
Subject: ref-iteration doc: add_submodule_odb() returns 0 for success
X-Git-Tag: v1.8.5.1~1
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/2951add0e908f04fd63b48b8fcc138ae4dd66116?ds=inline;hp=--cc

ref-iteration doc: add_submodule_odb() returns 0 for success

The usage sample of add_submodule_odb() function in the Submodules
section expects non-zero return value for success, but the function
actually reports success with zero.

Helped-by: René Scharfe <l.s.r@web.de>
Reviewed-by: Heiko Voigt <hvoigt@hvoigt.net>
Signed-off-by: Nick Townsend <nick.townsend@mac.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

2951add0e908f04fd63b48b8fcc138ae4dd66116
diff --git a/Documentation/technical/api-ref-iteration.txt b/Documentation/technical/api-ref-iteration.txt
index aa1c50f181..02adfd45d3 100644
--- a/Documentation/technical/api-ref-iteration.txt
+++ b/Documentation/technical/api-ref-iteration.txt
@@ -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.