Browse Source

Document update for known issues

Matthew Wang 11 years ago
parent
commit
af720a9031
1 changed files with 9 additions and 6 deletions
  1. 9
    6
      README.rst

+ 9
- 6
README.rst View File

@@ -91,10 +91,9 @@ Pipe in a diff:
91 91
     git log -p -2 | cdiff -s    # view git log with changes of last 2 commits
92 92
     git show 15bfa | cdiff -s   # view a git commit
93 93
     svn diff -r1234 | cdiff -s  # view svn diff comparing to given revision
94
-    cdiff < foo.patch           # view a patch file (unified format only)
95
-    cat foo.patch | cdiff       # same as above
96 94
     diff -u foo bar | cdiff     # pipe in diff between two files (note the '-u')
97 95
     diff -ur dir1 dir2 | cdiff  # pipe in diff between two dirs
96
+    cat foo.patch | cdiff       # or cdiff < foo.path to view a unified patch
98 97
 
99 98
 Redirect output to another patch file is safe:
100 99
 
@@ -105,12 +104,16 @@ Redirect output to another patch file is safe:
105 104
 Notes
106 105
 -----
107 106
 
108
-- Verified on `travis <https://travis-ci.org/ymattw/cdiff>`_ with python 2.5,
109
-  2.6, 2.7, 3.2, 3.3 and pypy
107
+Cdiff has following known issues:
108
+
110 109
 - Only takes unified diff for input
111 110
 - Side by side mode has alignment problem for wide chars
112
-- Pull requests are very welcome, run ``make test`` to verify (required tool
113
-  *coverage* can be installed with ``pip install coverage``)
111
+- Terminal might be in a mess on exception (type ``reset`` can fix it)
112
+
113
+Pull requests are very welcome, please make sure your changes can pass unit
114
+tests and regression tests by run ``make test`` (required tool *coverage* can be
115
+installed with ``pip install coverage``).  Also watch out `travis build
116
+<https://travis-ci.org/ymattw/cdiff>`_ after push, make sure it passes as well.
114 117
 
115 118
 See also
116 119
 --------