소스 검색

Doc update for context diff support

Matthew Wang 11 년 전
부모
커밋
18985c1ca2
1개의 변경된 파일9개의 추가작업 그리고 5개의 파일을 삭제
  1. 9
    5
      README.rst

+ 9
- 5
README.rst 파일 보기

@@ -107,13 +107,16 @@ Pipe in a diff:
107 107
     svn diff -r1234 | cdiff -s  # view svn diff comparing to given revision
108 108
     diff -u file1 file2 | cdiff # view diff between two files (note the '-u')
109 109
     diff -ur dir1 dir2 | cdiff  # view diff between two dirs
110
-    cat foo.patch | cdiff       # view a unified patch (or cdiff < foo.path)
111 110
 
112
-    # View a GitHub pull request, side by side (GitHub web interface is missing
113
-    # this feature :)
114
-    #
111
+    # View diff in a GitHub pull request, side by side
115 112
     curl https://github.com/ymattw/cdiff/pull/11.diff | cdiff -s
116 113
 
114
+    # View a patch file in unified or context format, the latter depends on
115
+    # command `filterdiff` from package `patchutils` which is available in
116
+    # major Linux distros and MacPorts.  "cdiff < foo.path" works too.
117
+    #
118
+    cat foo.patch | cdiff 
119
+
117 120
 Redirect output to another patch file is safe:
118 121
 
119 122
 .. code:: sh
@@ -125,7 +128,8 @@ Notes
125 128
 
126 129
 Cdiff has following known issues:
127 130
 
128
-- Only takes unified diff for input
131
+- Does not recognize `normal` diff, and depends on ``filterdiff`` (patchutils)
132
+  to read `context` diff
129 133
 - Side by side mode has alignment problem for wide chars
130 134
 - Terminal might be in a mess on exception (type ``reset`` can fix it)
131 135