OSDN Git Service

Update Document
[tortoisegit/TortoiseGitJp.git] / doc / test / subwcrev1.txt
1 SubWCRev  -  A Working Copy Status Tool for Git\r
2 ------------------------------------------------------\r
3 \r
4 SubWCRev is Windows console program which can be used to read the status\r
5 of a Git working copy and optionally perform keyword substitution\r
6 in a template file.\r
7 \r
8 usage: SubWCRev WorkingCopyPath [SrcVersionFile] [DstVersionFile] [-n|-d]\r
9 \r
10 Params:\r
11 WorkingCopyPath    :   path to a Git working copy\r
12 SrcVersionFile     :   path to a template header file\r
13 DstVersionFile     :   path to where to save the resulting header file\r
14 -n                 :   if given, then SubWCRev will error if the working\r
15                        copy contains local modifications\r
16 -d                 :   if given, then SubWCRev will only do its job if\r
17                        DstVersionFile does not exist\r
18 \r
19 \r
20 SubWCRev reads the Git status of all files in a working copy, excluding\r
21 externals. It records the highest revision number found, and the commit\r
22 timestamp of that revision, and also whether there are local modifications in\r
23 the working copy. The revision number and mod status are displayed on stdout.\r
24 \r
25 If a source and destination files are supplied, SubWCRev copies source\r
26 to destination, performing keyword substitution as follows:\r
27 \r
28 $WCDATE$ is replaced with the commit date/time of that revision in\r
29 international format, ie. yyyy-mm-dd hh:mm:ss\r
30 \r
31 Finally, an optional switch may be added to abort SubWCRev if certain\r
32 conditions are not met.\r
33 \r
34 The -d switch causes SubWCRev to abort with ERRORLEVEL 8 if the destination\r
35 file already exists.\r
36 \r
37 -------------------------------------------------------------------------------\r
38 SubWCRev was written by Stefan Küng for the TortoiseGit project.\r
39 Visit our website at http://TortoiseGit.tigris.org\r
40 -------------------------------------------------------------------------------\r
41 \r