[RFC PATCH] Documentation: diff produces patches, which can be 'apply'd

[RFC PATCH] Documentation: diff produces patches, which can be 'apply'd

[Philip Oakley]

This attached patch (my first) suggests a couple of small documenation changes for 'diff' based on Junio's supportive comments at
http://article.gmane.org/gmane.comp.version-control.git/197282

The purpose of the patch is to make users aware of the apply command as a companion to diff.

If changing the NAME text is considered inappropriate, the same change could just as easily be applied to the start of the 
DESCRIPTION.

I haven't sorted out using 'send-mail' for patches yet, so I've attached it.
The patch was generated with "git format-patch -M" as per directions.
The patch was on top of tag v1.7.10.msysgit.0 from https://github.com/msysgit/git

Comments?

Philip

Re: [RFC PATCH] Documentation: diff produces patches, which can be 'apply'd

[Philip Oakley]

[-- Attachment #1: Type: text/plain, Size: 2306 bytes --]

With attachment this time. In-text readable copy below.

From: "Philip Oakley" <philipoakley@iee.org> Sent: Wednesday, May 09, 2012 2:17 PM
> This attached patch (my first) suggests a couple of small documenation changes for 'diff' based on Junio's supportive comments at
> http://article.gmane.org/gmane.comp.version-control.git/197282
> 
> The purpose of the patch is to make users aware of the apply command as a companion to diff.
> 
> If changing the NAME text is considered inappropriate, the same change could just as easily be applied to the start of the 
> DESCRIPTION.
> 
> I haven't sorted out using 'send-mail' for patches yet, so I've attached it.
> The patch was generated with "git format-patch -M" as per directions.
> The patch was on top of tag v1.7.10.msysgit.0 from https://github.com/msysgit/git
> 
> Comments?
> 
> Philip
>
This may be white space damaged
---
From 54824f78e0b8389d506661a7db35b6a7f74d0664 Mon Sep 17 00:00:00 2001
From: Philip Oakley <philipoakley@iee.org>
Date: Tue, 8 May 2012 17:28:41 +0100
Subject: [PATCH] Documentation: diff produces patches, which can be 'apply'd

Tell users from different work environments that the diff format
is usually a patch. Tell them the git command to implement such
a patch is 'git apply'.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---

If changing the NAME text is considered inappropriate, the same change
could just as easily be applied to the start of the DESCRIPTION.

 Documentation/git-diff.txt |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index f8d0819..b2d2c06 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -3,7 +3,7 @@ git-diff(1)
 
 NAME
 ----
-git-diff - Show changes between commits, commit and working tree, etc
+git-diff - Show changes, usually as a patch, between commits, commit and working tree, etc
 
 
 SYNOPSIS
@@ -18,7 +18,8 @@ DESCRIPTION
 -----------
 Show changes between the working tree and the index or a tree, changes
 between the index and a tree, changes between two trees, or changes
-between two files on disk.
+between two files on disk. You can implement a diff's patch using linkgit:git-apply[1].
+
 
 'git diff' [--options] [--] [<path>...]::
 
-- 
1.7.8.msysgit.0


[-- Attachment #2: 0001-Documentation-diff-produces-patches-which-can-be-app.patch --]
[-- Type: application/octet-stream, Size: 1469 bytes --]

>From 54824f78e0b8389d506661a7db35b6a7f74d0664 Mon Sep 17 00:00:00 2001
From: Philip Oakley <philipoakley@iee.org>
Date: Tue, 8 May 2012 17:28:41 +0100
Subject: [PATCH] Documentation: diff produces patches, which can be 'apply'd

Tell users from different work environments that the diff format
is usually a patch. Tell them the git command to implement such
a patch is 'git apply'.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
---

If changing the NAME text is considered inappropriate, the same change
could just as easily be applied to the start of the DESCRIPTION.

 Documentation/git-diff.txt |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index f8d0819..b2d2c06 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -3,7 +3,7 @@ git-diff(1)
 
 NAME
 ----
-git-diff - Show changes between commits, commit and working tree, etc
+git-diff - Show changes, usually as a patch, between commits, commit and working tree, etc
 
 
 SYNOPSIS
@@ -18,7 +18,8 @@ DESCRIPTION
 -----------
 Show changes between the working tree and the index or a tree, changes
 between the index and a tree, changes between two trees, or changes
-between two files on disk.
+between two files on disk. You can implement a diff's patch using linkgit:git-apply[1].
+
 
 'git diff' [--options] [--] [<path>...]::
 
-- 
1.7.8.msysgit.0