Tutorial: Explain diffs a little bit better
authorKarl Hasselström <kha@treskal.com>
Sun, 12 Oct 2008 15:03:52 +0000 (17:03 +0200)
committerKarl Hasselström <kha@treskal.com>
Sun, 12 Oct 2008 15:03:52 +0000 (17:03 +0200)
Say that we use unified diffs, and point to the Wikipedia article
about them. We should probably explain this in more detail ourselves
when we get a proper user guide; but for the tutorial, this is
probably enough.

Signed-off-by: Karl Hasselström <kha@treskal.com>
Documentation/tutorial.txt

index 103f3e4..e9d8b22 100644 (file)
@@ -103,10 +103,11 @@ And voilà -- the patch is no longer empty:
            _main()
        finally:
 
-(I'm assuming you're already familiar with patches like this from Git,
-but it's really quite simple; in this example, I've added the +$$print
-'My first patch!'$$+ line to the file +stgit/main.py+, at around line
-171.)
+(I'm assuming you're already familiar with
+htmllink:http://en.wikipedia.org/wiki/Diff#Unified_format[unified
+diff] patches like this from Git, but it's really quite simple; in
+this example, I've added the +$$print 'My first patch!'$$+ line to the
+file +stgit/main.py+, at around line 171.)
 
 Since the patch is also a regular Git commit, you can also look at it
 with regular Git tools such as manlink:gitk[].