Mercurial > hg > mercurial-crew-with-dirclash
comparison contrib/vim/patchreview.txt @ 2350:091d555653a4
contrib: patch review plugin for vim 7.0
The plugin takes an 'hg export'ed patch (in fact any
single or multi file patch) and opens multiple tabs
containing vim diff/merge windows for each affected
file in the patch allowing full visual code reviews.
author | Manpreet Singh <junkblocker@yahoo.com> |
---|---|
date | Sat, 27 May 2006 20:44:53 -0700 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
2349:88c881bda888 | 2350:091d555653a4 |
---|---|
1 *patchreview.txt* Vim global plugin for doing single or multipatch code reviews | |
2 | |
3 Author: Manpreet Singh (junkblocker-CAT-yahoo-DOG-com) | |
4 (Replace -CAT- and -DOG- with @ and . first) | |
5 Copyright (C) 2006 by Manpreet Singh | |
6 License : This file is placed in the public domain. | |
7 | |
8 ============================================================================= | |
9 | |
10 CONTENTS *patchreview* *patchreview-contents* | |
11 | |
12 1. Contents.........................................: |patchreview-contents| | |
13 2. Introduction.....................................: |patchreview-intro| | |
14 3. PatchReview options..............................: |patchreview-options| | |
15 4. PatchReview Usage................................: |patchreview-usage| | |
16 4.1 PatchReview Usage............................: |:PatchReview| | |
17 4.2 PatchReview Usage............................: |:PatchReviewCleanup| | |
18 | |
19 ============================================================================= | |
20 | |
21 PatchReview Introduction *patchreview-intro* | |
22 | |
23 The Patch Review plugin allows single or multipatch code review to be done in | |
24 VIM. VIM provides the |:diffpatch| command to do single file reviews but can | |
25 not handle patch files containing multiple patches as is common with software | |
26 development projects. This plugin provides that missing functionality. It also | |
27 tries to improve on |:diffpatch|'s behaviour of creating the patched files in | |
28 the same directory as original file which can lead to project workspace | |
29 pollution. | |
30 | |
31 ============================================================================= | |
32 | |
33 PatchReview Options *patchreview-options* | |
34 | |
35 g:patchreview_filterdiff : Optional path to filterdiff binary. PatchReview | |
36 tries to locate filterdiff on system path | |
37 automatically. If the binary is not on system | |
38 path, this option tell PatchReview the full path | |
39 to the binary. This option, if specified, | |
40 overrides the default filterdiff binary on the | |
41 path. | |
42 | |
43 examples: | |
44 (On Windows with Cygwin) | |
45 | |
46 let g:patchreview_filterdiff = 'c:\\cygwin\\bin\\filterdiff.exe' | |
47 | |
48 (On *nix systems) | |
49 | |
50 let g:patchreview_filterdiff = '/usr/bin/filterdiff' | |
51 | |
52 g:patchreview_patch : Optional path to patch binary. PatchReview tries | |
53 to locate patch on system path automatically. If | |
54 the binary is not on system path, this option | |
55 tell PatchReview the full path to the binary. | |
56 This option, if specified, overrides the default | |
57 patch binary on the path. | |
58 | |
59 examples: | |
60 (On Windows with Cygwin) | |
61 | |
62 let g:patchreview_patch = 'c:\\cygwin\\bin\\patch.exe' | |
63 | |
64 (On *nix systems) | |
65 | |
66 let g:patchreview_patch = '/usr/bin/gpatch' | |
67 | |
68 | |
69 g:patchreview_tmpdir : Optional path where the plugin can save temporary | |
70 files. If this is not specified, the plugin tries to | |
71 use TMP, TEMP and TMPDIR environment variables in | |
72 succession. | |
73 | |
74 examples: | |
75 (On Windows) let g:patchreview_tmpdir = 'c:\\tmp' | |
76 (On *nix systems) let g:patchreview_tmpdir = '~/tmp' | |
77 | |
78 ============================================================================= | |
79 | |
80 PatchReview Usage *patchreview-usage* | |
81 *:PatchReview* | |
82 | |
83 :PatchReview patchfile_path [optional_source_directory] | |
84 | |
85 Perform a patch review in the current directory based on the supplied | |
86 patchfile_path. If optional_source_directory is specified, patchreview is | |
87 done on that directory. Othewise, the current directory is assumed to be | |
88 the source directory. | |
89 *:PatchReviewCleanup* | |
90 | |
91 :PatchReviewCleanup | |
92 | |
93 After you are done using the :PatchReview command, you can cleanup the | |
94 temporary files in the temporary directory using this command. | |
95 | |
96 ============================================================================= | |
97 vim: ft=help:ts=2:sts=2:sw=2:tw=78:tw=78 |