Re: Re* [PATCH] Improvements to git-archive tests and add_submodule_odb()
Hi,
On Tue, Dec 03, 2013 at 10:39:36AM -0800, Junio C Hamano wrote:
> OK, thanks, then let's do this.
Yes, sounds good.
Cheers Heiko
Show 36 quoted lines
> -- >8 --
> From: Nick Townsend <nick.townsend@mac.com>
> Date: Mon, 25 Nov 2013 15:31:09 -0800
> Subject: [PATCH] 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>
> ---
> Documentation/technical/api-ref-iteration.txt | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/technical/api-ref-iteration.txt b/Documentation/technical/api-ref-iteration.txt
> index aa1c50f..02adfd4 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.
>
> --
> 1.8.5-262-g1a2486c
> Heiko Voigt <hvoigt@hvoigt.net>