From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ping Yin Subject: [PATCH v4 4/5] git-submodule summary: documentation Date: Tue, 11 Mar 2008 01:54:16 +0800 Message-ID: <1205171657-16216-4-git-send-email-pkufranky@gmail.com> References: <1205171657-16216-1-git-send-email-pkufranky@gmail.com> <1205171657-16216-2-git-send-email-pkufranky@gmail.com> <1205171657-16216-3-git-send-email-pkufranky@gmail.com> Cc: git@vger.kernel.org, Ping Yin To: gitster@pobox.com X-From: git-owner@vger.kernel.org Mon Mar 10 18:55:33 2008 Return-path: Envelope-to: gcvg-git-2@gmane.org Received: from vger.kernel.org ([209.132.176.167]) by lo.gmane.org with esmtp (Exim 4.50) id 1JYmDI-0001Ri-OB for gcvg-git-2@gmane.org; Mon, 10 Mar 2008 18:55:05 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751471AbYCJRyX (ORCPT ); Mon, 10 Mar 2008 13:54:23 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1751450AbYCJRyW (ORCPT ); Mon, 10 Mar 2008 13:54:22 -0400 Received: from mail.qikoo.org ([60.28.205.235]:42287 "EHLO mail.qikoo.org" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1751252AbYCJRyU (ORCPT ); Mon, 10 Mar 2008 13:54:20 -0400 Received: by mail.qikoo.org (Postfix, from userid 1029) id C5116470B0; Tue, 11 Mar 2008 01:54:17 +0800 (CST) X-Mailer: git-send-email 1.5.4.3.347.g5314c In-Reply-To: <1205171657-16216-3-git-send-email-pkufranky@gmail.com> Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: Signed-off-by: Ping Yin --- Documentation/git-submodule.txt | 19 ++++++++++++++++--- 1 files changed, 16 insertions(+), 3 deletions(-) diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index b4d0160..41f9f63 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -12,6 +12,7 @@ SYNOPSIS 'git-submodule' [--quiet] add [-b branch] [--] [] 'git-submodule' [--quiet] status [--cached] [--] [...] 'git-submodule' [--quiet] [init|update] [--] [...] +'git-submodule' [--quiet] summary [--summary-limit ] [commit] [--] [...] COMMANDS @@ -47,6 +48,11 @@ update:: checkout the commit specified in the index of the containing repository. This will make the submodules HEAD be detached. +summary:: + Show commit summary between the given commit (defaults to HEAD) and + working tree/index. For a submodule in question, a series of commits + in the submodule between the given super project commit and the + index or working tree (switched by --cached) are shown. OPTIONS ------- @@ -57,9 +63,16 @@ OPTIONS Branch of repository to add as submodule. --cached:: - Display the SHA-1 stored in the index, not the SHA-1 of the currently - checked out submodule commit. This option is only valid for the - status command. + This option is only valid for status and summary commands. These + commands typically use the commit found in the submodule HEAD, but + with this option, the commit stored in the index is used instead. + +-n, --summary-limit:: + This option is only valid for the summary command. + Limit the summary size (number of commits shown in total). + Giving 0 will disable the summary; a negative number means unlimted + (the default). This limit only applies to modified submodules. The + size is always limited to 1 for added/deleted/typechanged submodules. :: Path to submodule(s). When specified this will restrict the command -- 1.5.4.3.347.g5314c