Browse Source

Document update for v0.5

Matthew Wang 11 years ago
parent
commit
d5b5153c95
3 changed files with 8 additions and 7 deletions
  1. 3
    0
      CHANGES
  2. 4
    6
      README.rst
  3. 1
    1
      cdiff.py

+ 3
- 0
CHANGES View File

@@ -6,6 +6,8 @@ Version 0.5 (2013-02-18)
6 6
 
7 7
   - Support read output from ``svn diff --log`` and ``hg log -p``
8 8
   - Streamline reading large patch set
9
+  - New ``--log (-l)`` option to read revision control diff log (thanks to
10
+    `Steven Myint <https://github.com/myint>`_)
9 11
 
10 12
 Version 0.4 (2013-02-16)
11 13
 
@@ -33,3 +35,4 @@ Version 0.0.3 (2013-02-04)
33 35
   
34 36
   - Publish on PyPI, supports read patch from file, pipe and diff output from
35 37
     revision tools (thanks to `Steven Myint <https://github.com/myint>`_)
38
+

+ 4
- 6
README.rst View File

@@ -72,12 +72,14 @@ Read diff from local modification in a *svn*, *git*, or *hg* workspace:
72 72
     cdiff -s                    # view side by side
73 73
     cdiff -s -w 90              # use text width 90 other than default 80
74 74
 
75
-Read the log (e.g. ``git log -p``) in a svn, git, or hg workspace:
75
+Read the log (e.g. ``git log -p``) in a *svn*, *git*, or *hg* workspace:
76 76
 
77 77
 .. code:: sh
78 78
 
79 79
     cd proj-workspace
80 80
     cdiff -l
81
+    cdiff -ls                   # equivalent to ``cdiff -l -s``
82
+    cdiff -ls -w90
81 83
 
82 84
 Pipe in a diff:
83 85
 
@@ -115,11 +117,7 @@ Notes
115 117
   2.4.3, maybe you can fix it)
116 118
 - Only takes unified diff for input
117 119
 - Side by side mode has alignment problem for wide chars
118
-
119
-Pull request is very welcome, make sure run ``make test`` and ``make test3`` to
120
-verify.  Single commit in pull request would make it easier for review, for
121
-example to collapse last 3 commits into 1 before *push*, use ``git rebase -i
122
-HEAD~3``, *pick* the first and *squash* the other two.
120
+- Pull requests are very welcome (please run ``make test test3`` to verify)
123 121
 
124 122
 See also
125 123
 --------

+ 1
- 1
cdiff.py View File

@@ -593,7 +593,7 @@ def main():
593 593
     parser.add_option('-w', '--width', type='int', default=80, metavar='N',
594 594
             help='set text width (side-by-side mode only), default is 80')
595 595
     parser.add_option('-l', '--log', action='store_true',
596
-                      help='show log from revision control (git, svn, hg)')
596
+            help='show diff log from revision control')
597 597
     opts, args = parser.parse_args()
598 598
 
599 599
     if opts.log: