From mboxrd@z Thu Jan 1 00:00:00 1970 From: mhagger@alum.mit.edu Subject: [PATCH v3 12/14] resolve_gitlink_ref(): improve docstring Date: Fri, 28 Oct 2011 13:14:39 +0200 Message-ID: <1319800481-15138-13-git-send-email-mhagger@alum.mit.edu> References: <1319800481-15138-1-git-send-email-mhagger@alum.mit.edu> Cc: git@vger.kernel.org, Jeff King , Drew Northup , Jakub Narebski , Heiko Voigt , Johan Herland , Julian Phillips , Michael Haggerty To: Junio C Hamano X-From: git-owner@vger.kernel.org Fri Oct 28 13:23:51 2011 Return-path: Envelope-to: gcvg-git-2@lo.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1RJkXN-0000IY-5a for gcvg-git-2@lo.gmane.org; Fri, 28 Oct 2011 13:23:49 +0200 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932245Ab1J1LXb (ORCPT ); Fri, 28 Oct 2011 07:23:31 -0400 Received: from mail.berlin.jpk.com ([212.222.128.130]:54823 "EHLO mail.berlin.jpk.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755549Ab1J1LUa (ORCPT ); Fri, 28 Oct 2011 07:20:30 -0400 Received: from michael.berlin.jpk.com ([192.168.100.152]) by mail.berlin.jpk.com with esmtp (Exim 4.50) id 1RJkIZ-00076m-Au; Fri, 28 Oct 2011 13:08:31 +0200 X-Mailer: git-send-email 1.7.7 In-Reply-To: <1319800481-15138-1-git-send-email-mhagger@alum.mit.edu> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: From: Michael Haggerty Signed-off-by: Michael Haggerty --- refs.h | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-) diff --git a/refs.h b/refs.h index 4c5d570..d498291 100644 --- a/refs.h +++ b/refs.h @@ -133,8 +133,12 @@ extern char *shorten_unambiguous_ref(const char *refname, int strict); /** rename ref, return 0 on success **/ extern int rename_ref(const char *oldref, const char *newref, const char *logmsg); -/** resolve ref in nested "gitlink" repository */ -extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *sha1); +/** + * Resolve refname in the nested "gitlink" repository that is located + * at path. If the resolution is successful, return 0 and set sha1 to + * the name of the object; otherwise, return a non-zero value. + */ +extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1); /** lock a ref and then write its file */ enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR }; -- 1.7.7