← Back to branch summary

~vcs-imports/meld/master

« back to all changes in this revision

Viewing changes to help/C/vc-mode.page

  • Committer: Kai Willadsen
  • Date: 2012-06-16 22:58:36 UTC
  • Revision ID: git-v1:cb6bb61a9c2e777c6725794661b603846a9f82cd
Document version control mode and associated options

Show diffs side-by-side

added added

removed removed

Lines of Context:
help/C/vc-mode.page
 
1
<page xmlns="http://projectmallard.org/1.0/"
 
2
      type="topic"
 
3
      id="vc-mode">
 
4
<info>
 
5
  <title type="sort">0</title>
 
6
  <link type="guide" xref="index#vc-mode"/>
 
7
</info>
 
8
 
 
9
<title>Viewing version-controlled files</title>
 
10
 
 
11
<p>
 
12
<app>Meld</app> integrates with <link xref="vc-supported">many version
 
13
control systems</link> to let you review local changes and perform
 
14
simple version control tasks. You can start a new version control
 
15
comparison by selecting the
 
16
<guiseq><gui style="menu">File</gui><gui style="menuitem">New...</gui></guiseq>
 
17
menu item, and clicking on the <gui style="tab">Version Control</gui>
 
18
tab.
 
19
</p>
 
20
 
 
21
 
 
22
<section>
 
23
<title>Version control comparisons</title>
 
24
 
 
25
<p>
 
26
Version control comparisons show the differences between the contents
 
27
of your folder and the current repository version. Each file in your
 
28
local copy has a <link xref="#vc-state">state</link> that indicates
 
29
how it differs from the repository copy.
 
30
</p>
 
31
 
 
32
<comment>
 
33
  <cite date="2012-06-04" href="mailto:kai.willadsen@gmail.com">Kai</cite>
 
34
  <p>
 
35
  Interacting with VC systems should have its own page.
 
36
  </p>
 
37
</comment>
 
38
 
 
39
<p>
 
40
If you want to look at a particular file's differences, you can select
 
41
it and press <key>Enter</key>, or double-click the file to start a
 
42
<link xref="file-mode">file comparison</link>. You can also interact
 
43
with your version control system using the
 
44
<gui style="menu">Changes</gui> menu.
 
45
</p>
 
46
</section>
 
47
 
 
48
<section id="vc-state">
 
49
<title>Version control states</title>
 
50
 
 
51
<p>
 
52
Each file or folder in a version control comparison has a <em>state</em>,
 
53
obtained from the version control system itself. <app>Meld</app> maps
 
54
these different states into a standard set of very similar concepts.
 
55
As such, <app>Meld</app> might use slightly different names for states
 
56
than your version control system does. The possible states are:
 
57
</p>
 
58
 
 
59
<comment>
 
60
  <cite date="2012-06-04" href="mailto:kai.willadsen@gmail.com">Kai</cite>
 
61
  <p>
 
62
  The following table would be much more effective if we could style
 
63
  entries in the Appearance column to show what they would actually
 
64
  look like.
 
65
  </p>
 
66
  <p>
 
67
  Ideally we would pull these colours and other details from the
 
68
  theme/gtkrc, but even an illustration of the default would help a lot.
 
69
  </p>
 
70
</comment>
 
71
 
 
72
 
 
73
<table frame="top bottom">
 
74
  <title>Version control states</title>
 
75
 
 
76
  <thead>
 
77
    <tr>
 
78
      <td><p>State</p></td>
 
79
      <td><p>Appearance</p></td>
 
80
      <td><p>Meaning</p></td>
 
81
    </tr>
 
82
  </thead>
 
83
 
 
84
  <tbody>
 
85
    <tr>
 
86
      <td><p>Same</p></td>
 
87
      <td>
 
88
        <p>
 
89
        Normal font
 
90
<!--        <file>file.txt</file>-->
 
91
        </p>
 
92
      </td>
 
93
      <td>
 
94
        <p>
 
95
        The file/folder is the same as the repository version.
 
96
        </p>
 
97
      </td>
 
98
    </tr>
 
99
    <tr>
 
100
      <td><p>Modified</p></td>
 
101
      <td>
 
102
        <p>
 
103
        Red and bold
 
104
<!--        <file style="color: #880000; font-weight: bold">file.txt</file>-->
 
105
        </p>
 
106
      </td>
 
107
      <td>
 
108
        <p>
 
109
        This file is different to the repository version.
 
110
        </p>
 
111
      </td>
 
112
    </tr>
 
113
    <tr>
 
114
      <td><p>New</p></td>
 
115
      <td>
 
116
        <p>
 
117
        Green and bold
 
118
<!--        <file style="color: #008800; font-weight: bold">file.txt</file>-->
 
119
        </p>
 
120
      </td>
 
121
      <td>
 
122
        <p>
 
123
        This file/folder is new, and is scheduled to be added to
 
124
        the repository.
 
125
        </p>
 
126
      </td>
 
127
    </tr>
 
128
    <tr>
 
129
      <td><p>Removed</p></td>
 
130
      <td>
 
131
        <p>
 
132
        Red bold text with a line through the middle
 
133
<!--        <file style="color: #880000; text-decoration: line-through;">file.txt</file>-->
 
134
        </p>
 
135
      </td>
 
136
      <td>
 
137
        <p>
 
138
        This file/folder existed, but is scheduled to be removed from
 
139
        the repository.
 
140
        </p>
 
141
      </td>
 
142
    </tr>
 
143
    <tr>
 
144
      <td><p>Conflict</p></td>
 
145
      <td>
 
146
        <p>
 
147
        Bright red bold text
 
148
<!--        <file style="color: #ff0000; text-weight: bold;">file.txt</file>-->
 
149
        </p>
 
150
      </td>
 
151
      <td>
 
152
        <p>
 
153
        When trying to merge with the repository, the differences between
 
154
        the local file and the repository could not be resolved, and the
 
155
        file is now in conflict with the repository contents
 
156
        </p>
 
157
      </td>
 
158
    </tr>
 
159
    <tr>
 
160
      <td><p>Missing</p></td>
 
161
      <td>
 
162
        <p>
 
163
        Blue bold text with a line through the middle
 
164
<!--        <file style="color: #000088; text-weight: bold; text-decoration: line-through;">file.txt</file>-->
 
165
        </p>
 
166
      </td>
 
167
      <td>
 
168
        <p>
 
169
        This file/folder should be present, but isn't.
 
170
        </p>
 
171
      </td>
 
172
    </tr>
 
173
    <tr>
 
174
      <td><p>Ignored</p></td>
 
175
      <td>
 
176
        <p>
 
177
        Greyed out text
 
178
<!--        <file style="color: #888888;">file.txt</file>-->
 
179
        </p>
 
180
      </td>
 
181
      <td>
 
182
        <p>
 
183
        This file/folder has been explicitly ignored (e.g., by an entry
 
184
        in <file>.gitignore</file>) and is not being tracked by version
 
185
        control.
 
186
        </p>
 
187
      </td>
 
188
    </tr>
 
189
    <tr>
 
190
      <td><p>Non VC</p></td>
 
191
      <td>
 
192
        <p>
 
193
        Greyed out text
 
194
<!--        <file style="color: #888888;">file.txt</file>-->
 
195
        </p>
 
196
      </td>
 
197
      <td>
 
198
        <p>
 
199
        This file is not in the version control system; it is only in
 
200
        the local copy.
 
201
        </p>
 
202
      </td>
 
203
    </tr>
 
204
    <tr>
 
205
      <td><p>Error</p></td>
 
206
      <td>
 
207
        <p>
 
208
        Bright red with a yellow background and bold
 
209
<!--        <file style="color: #ff0000; background-color: yellow; font-weight: bold">file.txt</file>-->
 
210
        </p>
 
211
      </td>
 
212
      <td>
 
213
        <p>
 
214
        The version control system has reported a problem with this file.
 
215
        </p>
 
216
      </td>
 
217
    </tr>
 
218
  </tbody>
 
219
</table>
 
220
</section>
 
221
 
 
222
<section id="vc-state-filtering">
 
223
<title>Version control state filtering</title>
 
224
 
 
225
<p>
 
226
Most often, you will only want to see files that are identified as being
 
227
in some way different; this is the default setting in <app>Meld</app>.
 
228
You can change which file states you see by using the
 
229
<guiseq><gui style="menu">View</gui><gui style="menuitem">Version Status</gui></guiseq>
 
230
menu, or by clicking the corresponding <gui style="button">Modified</gui>,
 
231
<gui style="button">Normal</gui>, <gui style="button">Non VC</gui> and
 
232
<gui style="button">Ignored</gui> buttons on the toolbar.
 
233
</p>
 
234
</section>
 
235
 
 
236
</page>