| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> |
|---|
| 2 | |
|---|
| 3 | <html> |
|---|
| 4 | |
|---|
| 5 | <head> |
|---|
| 6 | <title>J User's Guide - CVS Support</title> |
|---|
| 7 | <LINK REL="stylesheet" HREF="j.css" TYPE="text/css"> |
|---|
| 8 | </head> |
|---|
| 9 | |
|---|
| 10 | <body> |
|---|
| 11 | |
|---|
| 12 | <a href="contents.html">Top</a> |
|---|
| 13 | |
|---|
| 14 | <hr> |
|---|
| 15 | |
|---|
| 16 | <h1>CVS Support</h1> |
|---|
| 17 | |
|---|
| 18 | <hr> |
|---|
| 19 | |
|---|
| 20 | <p> |
|---|
| 21 | J provides commands to perform a few common CVS operations that it makes sense |
|---|
| 22 | to do from within an editor. |
|---|
| 23 | <p> |
|---|
| 24 | For these commands to work, CVS must be set up correctly outside of j first. A |
|---|
| 25 | CVS operation won't work within j unless it can be performed successfully from |
|---|
| 26 | a shell command prompt in the parent directory of the current buffer. |
|---|
| 27 | <p> |
|---|
| 28 | Most CVS-related commands are not mapped to any keystrokes by default, but you |
|---|
| 29 | can use <a href="commands.html#executeCommand">executeCommand</a>, mapped by |
|---|
| 30 | default to Alt X, and then type in the name of the command (or just type "cvs" |
|---|
| 31 | and then keep hitting Tab until you see the command you want; completion is |
|---|
| 32 | your friend). |
|---|
| 33 | <p> |
|---|
| 34 | CVS revision information for checked-out files is displayed in the status |
|---|
| 35 | bar, to the right of the mode name, like this: |
|---|
| 36 | <pre> |
|---|
| 37 | CVS 1.34</pre> |
|---|
| 38 | or |
|---|
| 39 | <pre> |
|---|
| 40 | CVS 1.34 M</pre> |
|---|
| 41 | or |
|---|
| 42 | <pre> |
|---|
| 43 | CVS A</pre> |
|---|
| 44 | <p> |
|---|
| 45 | In this example, "1.34" is the revision; it's followed by an 'M' if the file |
|---|
| 46 | modification time of the local file is different from the checkout time, which |
|---|
| 47 | is often an indication that the local file has been modified since it was |
|---|
| 48 | checked out. "CVS A", with no revision number, means the file has been added |
|---|
| 49 | to CVS but not yet committed. |
|---|
| 50 | <p> |
|---|
| 51 | If you're working on a file that's registered with CVS, you can use the |
|---|
| 52 | command <a href="commands.html#cvsDiff">cvsDiff</a> to get a diff output |
|---|
| 53 | buffer showing the changes between the checked-in version and your local copy. |
|---|
| 54 | <a href="commands.html#cvsDiffDir">cvsDiffDir</a> is similar, but it generates |
|---|
| 55 | a diff output buffer containing information about all the files in the current |
|---|
| 56 | directory and its subdirectories, not just the current buffer. Once you're in |
|---|
| 57 | the diff output buffer, you can scroll around and use |
|---|
| 58 | <a href="commands.html#diffGotoFile">diffGotoFile</a>, mapped by default to |
|---|
| 59 | Enter, to jump to the location in the source file that corresponds to the line |
|---|
| 60 | you're on in the diff output buffer. You can use |
|---|
| 61 | <a href="commands.html#escape">escape</a>, mapped by default to Escape, to get |
|---|
| 62 | rid of the diff output buffer when you're done. |
|---|
| 63 | <p> |
|---|
| 64 | When you're ready to check in your changes, use the command |
|---|
| 65 | <a href="commands.html#cvsCommit">cvsCommit</a>. This command opens a checkin |
|---|
| 66 | buffer in which you can compose your checkin comment. When your comment is |
|---|
| 67 | ready, use the command <a href="commands.html#finish">finish</a>, mapped by |
|---|
| 68 | default to Ctrl Enter in the checkin buffer, to complete the checkin operation. |
|---|
| 69 | <p> |
|---|
| 70 | If you change several source files for the same reason, it is often convenient |
|---|
| 71 | to specify the same checkin comment for several files. To help you do this, j |
|---|
| 72 | maintains a history of the checkin comments you've used recently. You can use |
|---|
| 73 | the commands <a href="commands.html#previousComment">previousComment</a> and |
|---|
| 74 | <a href="commands.html#nextComment">nextComment</a>, mapped by default to Ctrl |
|---|
| 75 | P and Ctrl N (respectively) in the checkin buffer, to cycle through this |
|---|
| 76 | history list. |
|---|
| 77 | <p> |
|---|
| 78 | To register the current buffer's file with CVS for the first time, use the |
|---|
| 79 | command <a href="commands.html#cvsAdd">cvsAdd</a>. |
|---|
| 80 | <p> The generic command <a href="commands.html#cvs">cvs</a>, which requires an |
|---|
| 81 | argument, can be used to execute arbitrary CVS commands for which j has no |
|---|
| 82 | specific support. The required argument is the CVS command to be executed, |
|---|
| 83 | together with any necessary flags. For example: |
|---|
| 84 | <pre> |
|---|
| 85 | cvs status -v</pre> |
|---|
| 86 | <p> |
|---|
| 87 | The name of the file associated with the current buffer is automatically |
|---|
| 88 | appended to the command line, so if you're editing a file called Jdb.java, the |
|---|
| 89 | command line that CVS sees is actually: |
|---|
| 90 | <pre> |
|---|
| 91 | cvs status -v Jdb.java</pre> |
|---|
| 92 | <p> |
|---|
| 93 | There is one exception: if the argument you supply begins with "-H" (CVS |
|---|
| 94 | command-specific help), the filename is not appended. For example: |
|---|
| 95 | <pre> |
|---|
| 96 | cvs -H admin</pre> |
|---|
| 97 | <p> |
|---|
| 98 | The output of the command is displayed in a transient output buffer. |
|---|
| 99 | <p> |
|---|
| 100 | The following commands are specifically relevant to CVS support: |
|---|
| 101 | <ul> |
|---|
| 102 | <li><a href="commands.html#cvs">cvs</a></li> |
|---|
| 103 | <li><a href="commands.html#cvsAdd">cvsAdd</a></li> |
|---|
| 104 | <li><a href="commands.html#cvsCommit">cvsCommit</a></li> |
|---|
| 105 | <li><a href="commands.html#cvsDiff">cvsDiff</a></li> |
|---|
| 106 | <li><a href="commands.html#cvsDiffDir">cvsDiffDir</a></li> |
|---|
| 107 | <li><a href="commands.html#cvsLog">cvsLog</a></li> |
|---|
| 108 | <li><a href="commands.html#finish">finish</a></li> |
|---|
| 109 | <li><a href="commands.html#nextComment">nextComment</a></li> |
|---|
| 110 | <li><a href="commands.html#previousComment">previousComment</a></li> |
|---|
| 111 | </ul> |
|---|
| 112 | </body> |
|---|
| 113 | </html> |
|---|
