Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[b1c821]: index.html Maximize Restore History

Download this file

index.html    211 lines (179 with data), 7.8 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
<html>
<!--:wrap=hard:maxLineLen=80: -->
<head>
<title>GitPlugin</title>
</head>
<body bgcolor="#FFFFFF">
<table
summary="Header"
bgcolor="#CCCCFF"
cellspacing="0"
border="0"
width="100%"
cols="2"
>
<tr width="100%">
<td valign="TOP"><strong><font size="+2">GitPlugin</font></strong></td>
<td valign="TOP" align="RIGHT"><font size="-1">
<p> Alan Ezust </p>
<p> Marcelo Vanzin </p>
<p> Dale Anson </p>
</font></td>
</tr>
</table>
<table
summary="Introduction"
border="0"
cellspacing="0"
cellpadding="3"
width="100%">
<tr align="CENTER" width="100%">
<td bgcolor="#7FB2FF" width="100%"><strong><font color="#FFFFFF" size="+1">
<a name="intro">Introduction</a></font></strong></td>
</tr>
</table>
<p> The GitPlugin for jEdit is the place for git-related services in jEdit. </p>
<p> It runs the command-line tool and requires the tool to be in your path, or
else you can set the location of the executable from <tt>Plugin Options - Git -
git executable:</tt>. </p>
<p> GitPlugin provides actions such as <b>Blame</b>, <b>Checkout Branch</b>,
<b>Checkout Files</b>, <b>Commit</b>, and <b>Delete Branch</b>. </p>
<p> When you invoke a <b>Search in repository</b> action, the plugin uses the
output of the <tt>git grep</tt> command and presents the results in the
Hypersearch window. This is faster than the Project Search features of
ProjectViewer or XSearch, and does not require additional indexing like the
Lucene plugin. If the Git Version Control Service is not selected for a
project, the action will invoke the regular project search instead.
</p>
<p> A little warning about the <b>Open Modified Files</b> action: if the
<tt>Plugin Options - Git - Include Untracked Files</tt> option is checked, this
action opens all files that are listed in <tt>git status</tt>, regardless of
whether they were added to the project. That includes <i>all generated
files</i> that happen to be under the project root. </p>
<table
summary="File Importer Filter"
border="0"
cellspacing="0"
cellpadding="3"
width="100%">
<tr align="CENTER" width="100%">
<td bgcolor="#7FB2FF" width="100%"><strong><font color="#FFFFFF" size="+1">
<a name="importerfilter">File Importer Filter</a></font></strong></td>
</tr>
</table>
<p> GitPlugin offers a ProjectViewer <tt>VersionControlService</tt>, as well as
a file importer filter. This means you can choose <b>Use git ls-files</b> when
you are importing files into a project. You can choose whether or not this will
<tt>include untracked files</tt> from <tt>Plugin Options - Git</tt>. </p>
<table
summary="File Status Icons"
border="0"
cellspacing="0"
cellpadding="3"
width="100%">
<tr align="CENTER" width="100%">
<td bgcolor="#7FB2FF" width="100%"><strong><font color="#FFFFFF" size="+1">
<a name="filestatusicons">File Status Icons</a></font></strong></td>
</tr>
</table>
<p> If the Git plugin option <tt>Show VC state icons in ProjectViewer</tt> is
checked, and in Project Properties, <tt>Git</tt> is selected as the <tt>Version
Control</tt> service for your project, then the <tt>git status</tt> command will
be performed periodically on files in your project to show you icons with
different colored bars on them reflecting status of files in the project tree.
Here are the colors and their meaning, from
<tt>git/command/Status.java</tt>:</p>
<pre>
// version control states for Git
public static final int UNMODIFIED = 0; // green
public static final int MODIFIED = 1; // yellow
public static final int ADDED = 2; // blue
public static final int DELETED = 3; // black
public static final int RENAMED = 4; // cyan
public static final int COPIED = 5; // orange
public static final int UPDATED = 6; // magenta
public static final int UNTRACKED = 7; // gray
public static final int IGNORED = 8; // red
</pre>
<p> Each status icon will contain two bars. The top bar represents X, the bottom
bar represents Y, the two digits in the git status code for the file: </p>
<pre>
X Y Meaning
-------------------------------------------------
[MD] not updated
M [ MD] updated in index
A [ MD] added to index
D [ M] deleted from index
R [ MD] renamed in index
C [ MD] copied in index
[MARC] index and work tree matches
[ MARC] M work tree changed since index
[ MARC] D deleted in work tree
-------------------------------------------------
D D unmerged, both deleted
A U unmerged, added by us
U D unmerged, deleted by them
U A unmerged, added by them
D U unmerged, deleted by us
A A unmerged, both added
U U unmerged, both modified
-------------------------------------------------
? ? untracked
! ! ignored
</pre>
<p> The status returned from this class converts XY into an integer, where X is
in the 10's place and Y is in the 1's place, so if XY is " M", the status will
be 01. This would mean a file has local changes that have not yet been added to
the index. On the icon, it should appear as a green bar over a yellow bar. </p>
<p> After adding the file to the index (git add), its status should be 10, or a
yellow bar over a green bar. </p>
<p> After making subsequent edits to the file, it would then have a status of 11
meaning it's modified in your index but not yet committed, AND it's modified
locally, but that change isn't in your index yet. Two yellow bars. </p>
<table
summary="Feedback"
border="0"
cellspacing="0"
cellpadding="3"
width="100%">
<tr align="CENTER" width="100%">
<td bgcolor="#7FB2FF" width="100%"><strong><font color="#FFFFFF" size="+1">
<a name="feedback">Feedback</a></font></strong></td>
</tr>
</table>
<p> Enjoy! This is free software, released under a modified version of the <a
href="http://sam.zoy.org/wtfpl/">wtfpl</a>. Feel free to contribute to it (or
other plugins) too. Start by joining the
<tt>jedit-devel@lists.sourceforge.net</tt> mailing list and submitting or
commenting on tickets. </p>
<ul>
<li> <a href="http://www.jedit.org/?page=devel">jEdit Developer's Homepage</a></li>
<li> <a href="https://sourceforge.net/tracker/?limit=100&amp;func=&amp;group_id=588&amp;atid=565475&amp;status=1&amp;submit=Filter">Plugin Bugs</a> </li>
<li> <a href="https://sourceforge.net/tracker/?limit=100&amp;func=&amp;group_id=588&amp;atid=997936&amp;status=1&amp;submit=Filter">Plugin Feature Requests</a> </li>
<li> <a href="https://sourceforge.net/tracker/?limit=100&amp;func=&amp;group_id=588&amp;atid=997937&amp;status=1&amp;submit=Filter">Plugin Patches</a> </li>
</ul>
<table
summary="History"
border="0"
cellspacing="0"
cellpadding="3"
width="100%">
<tr align="CENTER" width="100%">
<td bgcolor="#7FB2FF" width="100%"><strong><font color="#FFFFFF" size="+1">
<a name="history">Version History</a></font></strong></td>
</tr>
</table>
<ul>
<li> <b>0.6</b>
<ul>
<li> Added a blame command. (#3557038 Dale Anson, Alan Ezust) </li>
<li> Added a status command. Added file status icons. (Dale Anson) </li>
</ul>
</li>
<li> <b>0.4</b> VersionControlService and additional actions (Marcelo Vanzin) </li>
<li> <b>0.3</b> Search for, and add clones as submodules under the project root. </li>
<li> <b>0.2</b> Bugfix - no longer ignoring files in subdirs of directories that contained directories only, and no files. </li>
<li> <b>0.1</b> Initial release. </li>
</ul>
</body>
</html>