From: Junio C Hamano <gitster@pobox.com>
To: Heiko Voigt <hvoigt@hvoigt.net>
Cc: "Nick Townsend" <nick.townsend@mac.com>,
git@vger.kernel.org, "René Scharfe" <l.s.r@web.de>,
"Jens Lehmann" <Jens.Lehmann@web.de>
Subject: Re* [PATCH] Improvements to git-archive tests and add_submodule_odb()
Date: Tue, 03 Dec 2013 10:39:36 -0800 [thread overview]
Message-ID: <xmqqpppdok2f.fsf_-_@gitster.dls.corp.google.com> (raw)
In-Reply-To: <20131203181807.GA4629@sandbox-ub> (Heiko Voigt's message of "Tue, 3 Dec 2013 19:18:07 +0100")
Heiko Voigt <hvoigt@hvoigt.net> writes:
> On Mon, Dec 02, 2013 at 04:14:37PM -0800, Nick Townsend wrote:
>> diff --git a/submodule.c b/submodule.c
>> index 1905d75..1ea46be 100644
>> --- a/submodule.c
>> +++ b/submodule.c
>> @@ -143,7 +143,7 @@ void stage_updated_gitmodules(void)
>> die(_("staging updated .gitmodules failed"));
>> }
>>
>> -static int add_submodule_odb(const char *path)
>> +int add_submodule_odb(const char *path)
>
> I am not against making add_submodule_odb() usable from outside
> submodule.c but I would prefer if this change goes along with some code
> actually using it. The reason being that when refactoring or extending
> you immediately know that a function is file local only with the static
> keyword. Without anyone using this function from outside submodule.c
> this fact is still true and so the code should say, IMO.
>
> Its not a big deal to postpone removing this keyword in a later commit
> so I would like to drop this change from the patch. The documentation
> fix is fine with me.
OK, thanks, then let's do this.
-- >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
next prev parent reply other threads:[~2013-12-03 18:39 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-12-03 0:10 [PATCH] Improvements to git-archive tests and add_submodule_odb() Nick Townsend
2013-12-03 0:14 ` Nick Townsend
2013-12-03 17:52 ` Junio C Hamano
2013-12-03 18:18 ` Heiko Voigt
2013-12-03 18:39 ` Junio C Hamano [this message]
2013-12-03 20:42 ` Re* " Heiko Voigt
2013-12-03 0:16 ` Nick Townsend
2013-12-03 9:26 ` Eric Sunshine
2013-12-03 17:54 ` Junio C Hamano
2013-12-05 2:49 ` [PATCH] Additional git-archive tests Nick Townsend
2013-12-05 19:52 ` Junio C Hamano
2013-12-10 5:26 ` Nick Townsend
2013-12-10 18:48 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqpppdok2f.fsf_-_@gitster.dls.corp.google.com \
--to=gitster@pobox.com \
--cc=Jens.Lehmann@web.de \
--cc=git@vger.kernel.org \
--cc=hvoigt@hvoigt.net \
--cc=l.s.r@web.de \
--cc=nick.townsend@mac.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).