From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.176.0/21 X-Spam-Status: No, score=-3.5 required=3.0 tests=AWL,BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,MSGID_FROM_MTA_HEADER,RP_MATCHES_RCVD shortcircuit=no autolearn=ham autolearn_force=no version=3.4.0 From: Brian Gernhardt Subject: [PATCH] Cleanup git-diff documentation Date: Thu, 14 Dec 2006 07:32:56 -0500 Message-ID: <9A80051B-1F6B-4FFD-B33F-84121D3A422F@silverinsanity.com> References: <7vr6v2aofs.fsf@assigned-by-dhcp.cox.net> Mime-Version: 1.0 (Apple Message framework v752.3) Content-Type: text/plain; charset=US-ASCII; delsp=yes; format=flowed Content-Transfer-Encoding: 7bit NNTP-Posting-Date: Thu, 14 Dec 2006 12:33:11 +0000 (UTC) Cc: Junio C Hamano , Johannes Schindelin Return-path: Envelope-to: gcvg-git@gmane.org In-Reply-To: X-Mailer: Apple Mail (2.752.3) Precedence: bulk X-Mailing-List: git@vger.kernel.org Archived-At: Received: from vger.kernel.org ([209.132.176.167]) by dough.gmane.org with esmtp (Exim 4.50) id 1Guplq-00057k-PQ for gcvg-git@gmane.org; Thu, 14 Dec 2006 13:33:07 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932693AbWLNMdD (ORCPT ); Thu, 14 Dec 2006 07:33:03 -0500 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S932697AbWLNMdD (ORCPT ); Thu, 14 Dec 2006 07:33:03 -0500 Received: from vs072.rosehosting.com ([216.114.78.72]:50148 "EHLO silverinsanity.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932693AbWLNMdB (ORCPT ); Thu, 14 Dec 2006 07:33:01 -0500 Received: from [IPv6???1] (localhost [127.0.0.1]) (using TLSv1 with cipher AES128-SHA (128/128 bits)) (No client certificate requested) by silverinsanity.com (Postfix) with ESMTP id E06ED1FFCECA; Thu, 14 Dec 2006 12:32:59 +0000 (UTC) To: git@vger.kernel.org Sender: git-owner@vger.kernel.org There were a couple inconsistencies in the formatting of the command descriptions and a more descriptive initial description is better. Signed-off-by: Brian Gernhardt --- I agree with Johannes about the original being clearer. Plus two of the command examples were missing brackets around -- and one had a * at the beginning the others didn't. This patch is against Junio's changes made on master (1d770), even though his patch didn't apply cleanly. Documentation/git-diff.txt | 11 +++++++---- 1 files changed, 7 insertions(+), 4 deletions(-) diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 534f824..2ba9145 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -12,7 +12,10 @@ SYNOPSIS DESCRIPTION ----------- -This command shows changes between four combinations of states. +Show changes between two trees, a tree and the working tree, a +tree and the index file, or the index file and the working tree. +The combination of what is compared with what is determined by +the number of trees given to the command. 'git-diff' [--options] [--] [...]:: @@ -25,11 +28,11 @@ This command shows changes between four combinations of states. 'git-diff' [--options] --cached [] [--] [...]:: This form is to view the changes you staged for the next - commit relative to the named . Typically you + commit relative to the named . Typically you would want comparison with the latest commit, so if you do not give , it defaults to HEAD. -'git-diff' [--options] -- [...]:: +'git-diff' [--options] [--] [...]:: This form is to view the changes you have in your working tree relative to the named . You can @@ -37,7 +40,7 @@ This command shows changes between four combinations of states. branch name to compare with the tip of a different branch. -* 'git-diff' [--options] -- [...] +'git-diff' [--options] [--] [...] This form is to view the changes between two , for example, tips of two branches. --