Skip to content

Commit cde3318

Browse files
committed
Fix formatting in README
1 parent c5af004 commit cde3318

File tree

1 file changed

+88
-36
lines changed

1 file changed

+88
-36
lines changed

README.rst

Lines changed: 88 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Manual
2929
make
3030
make install
3131
32-
By default, files are installed to ``/usr/local``. You can install to an alternate location by passing ``PREFIX`` to ``make install``.
32+
By default, files are installed to ``/usr/local``. You can install elsewhere by passing ``PREFIX`` to ``make install``.
3333

3434
.. code-block:: sh
3535
@@ -61,7 +61,7 @@ git-config(1) settings can be used to customize the behavior of git-follow.
6161
</td>
6262
<td>
6363
<div>
64-
<span>Diff mode to use with git-diff(1), git-log(1), etc.</span>
64+
<span>Diff mode to use with git-diff(1), git-log(1), git-show(1), etc.</span>
6565
</div>
6666
<div>
6767
<span>See <a href="https://git-scm.com/docs/git-log#Documentation/git-log.txt---word-diffltmodegt"><var>--word-diff</var></a> of git-log(1).</span>
@@ -117,7 +117,7 @@ git-config(1) settings can be used to customize the behavior of git-follow.
117117
</td>
118118
<td>
119119
<div>
120-
<span>Disable pager used with git-diff(1), git-log(1), etc.</span>
120+
<span>Disable pager used with git-diff(1), git-log(1), git-show(1), etc.</span>
121121
</div>
122122
<div>
123123
<span>See <a href="https://git-scm.com/docs/git#Documentation/git.txt---no-pager"><var>--no-pager</var></a> of git(1).</span>
@@ -154,11 +154,13 @@ Options can be specified to provide more refined information. If no options are
154154
<tr>
155155
<td>
156156
<kbd>
157-
<span>-b, --branch <var>&lt;BRANCH&gt;</var></span>
157+
<span>-b, --branch <var>BRANCH</var></span>
158158
</kbd>
159159
</td>
160160
<td>
161-
<span>Show commits for <var>&lt;BRANCH&gt;</var></span>
161+
<div>
162+
<span>Show commits for <var>BRANCH</var></span>
163+
</div>
162164
</td>
163165
</tr>
164166
<tr>
@@ -168,40 +170,54 @@ Options can be specified to provide more refined information. If no options are
168170
</kbd>
169171
</td>
170172
<td>
171-
<span>Show first commit where Git initiated tracking of pathspec.</span>
173+
<div>
174+
<span>Show first commit where Git initiated tracking of pathspec.</span>
175+
</div>
172176
</td>
173177
</tr>
174178
<tr>
175179
<td>
176180
<kbd>
177-
<span>-F, --func <var>&lt;FUNCNAME&gt;</var></span>
181+
<span>-F, --func <var>FUNCNAME</var></span>
178182
</kbd>
179183
</td>
180184
<td>
181-
<span>Show commits for function <var>&lt;FUNCNAME&gt;.</span>
182-
<span>See <a href="https://git-scm.com/docs/git-log#git-log--Lltfuncnamegtltfilegt"><var>-L</var></a> of git-log(1).</span>
185+
<div>
186+
<span>Show commits for function <var>FUNCNAME</var>.</span>
187+
</div>
188+
<div>
189+
<span>See <a href="https://git-scm.com/docs/git-log#git-log--Lltfuncnamegtltfilegt"><var>-L</var></a> of git-log(1).</span>
190+
</div>
183191
</td>
184192
</tr>
185193
<tr>
186194
<td>
187195
<kbd>
188-
<span>-l, --last <var>&lt;COUNT&gt;</var></span>
196+
<span>-l, --last <var>COUNT</var></span>
189197
</kbd>
190198
</td>
191199
<td>
192-
<span>Show last <var>&lt;COUNT&gt;</var> commits for pathspec.</span>
193-
<span>Omit <var>&lt;COUNT&gt;</var> defaults to last commit.</span>
200+
<div>
201+
<span>Show last <var>COUNT</var> commits for pathspec.</span>
202+
</div>
203+
<div>
204+
<span>Omit <var>COUNT</var> defaults to last commit.</span>
205+
</div>
194206
</td>
195207
</tr>
196208
<tr>
197209
<td>
198210
<kbd>
199-
<span>-L, --lines <var>&lt;START&gt;[,&lt;END&gt;]</var></span>
211+
<span>-L, --lines <var>X[,Y]</var></span>
200212
</kbd>
201213
</td>
202214
<td>
203-
<span>Show commits for lines <var>&lt;START&gt;</var>-<var>&lt;END&gt;</var>.</span>
204-
<span>Omit <var>&lt;END&gt;</var> defaults to <var>EOF</var></span>
215+
<div>
216+
<span>Show commits for lines <var>X</var> through <var>Y</var>.</span>
217+
</div>
218+
<div>
219+
<span>Omit <var>Y</var> defaults to <var>EOF</var>.</span>
220+
</div>
205221
</td>
206222
</tr>
207223
<tr>
@@ -211,8 +227,12 @@ Options can be specified to provide more refined information. If no options are
211227
</kbd>
212228
</td>
213229
<td>
214-
<span>Show commits which have a maximum of one parent.</span>
215-
<span>See <a href="https://git-scm.com/docs/git-log#git-log---no-merges"><var>--no-merges</var></a> of git-log(1).</span>
230+
<div>
231+
<span>Show commits which have a maximum of one parent.</span>
232+
</div>
233+
<div>
234+
<span>See <a href="https://git-scm.com/docs/git-log#git-log---no-merges"><var>--no-merges</var></a> of git-log(1).</span>
235+
</div>
216236
</td>
217237
</tr>
218238
<tr>
@@ -222,8 +242,12 @@ Options can be specified to provide more refined information. If no options are
222242
</kbd>
223243
</td>
224244
<td>
225-
<span>Suppress diff output.</span>
226-
<span>See <a href="https://git-scm.com/docs/git-log#git-log---no-patch"><var>--no-patch</var></a> of git-log(1).</span>
245+
<div>
246+
<span>Suppress diff output.</span>
247+
</div>
248+
<div>
249+
<span>See <a href="https://git-scm.com/docs/git-log#git-log---no-patch"><var>--no-patch</var></a> of git-log(1).</span>
250+
</div>
227251
</td>
228252
</tr>
229253
<tr>
@@ -233,8 +257,12 @@ Options can be specified to provide more refined information. If no options are
233257
</kbd>
234258
</td>
235259
<td>
236-
<span>Disable rename detection.</span>
237-
<span>See <a href="https://git-scm.com/docs/git-log#git-log---no-renames"><var>--no-renames</var></a> of git-log(1).</span>
260+
<div>
261+
<span>Disable rename detection.</span>
262+
</div>
263+
<div>
264+
<span>See <a href="https://git-scm.com/docs/git-log#git-log---no-renames"><var>--no-renames</var></a> of git-log(1).</span>
265+
</div>
238266
</td>
239267
</tr>
240268
<tr>
@@ -244,30 +272,42 @@ Options can be specified to provide more refined information. If no options are
244272
</kbd>
245273
</td>
246274
<td>
247-
<span>Force pager when invoking git-log(1).</span>
248-
<span>Overrides <var>follow.pager.disable</var> config value.</span>
275+
<div>
276+
<span>Force pager when invoking git-log(1).</span>
277+
</div>
278+
<div>
279+
<span>Overrides <var>follow.pager.disable</var> config value.</span>
280+
</div>
249281
</td>
250282
</tr>
251283
<tr>
252284
<td>
253285
<kbd>
254-
<span>-P, --pickaxe <var>&lt;STRING&gt;</var></span>
286+
<span>-P, --pickaxe <var>STRING</var></span>
255287
</kbd>
256288
</td>
257289
<td>
258-
<span>Show commits which change the # of occurrences of <var>&lt;STRING&gt;</var></span>
259-
<span>See <a href="https://git-scm.com/docs/git-log#git-log--Sltstringgt"><var>-S</var></a> of git-log(1).</span>
290+
<div>
291+
<span>Show commits which change the # of occurrences of <var>STRING</var></span>
292+
</div>
293+
<div>
294+
<span>See <a href="https://git-scm.com/docs/git-log#git-log--Sltstringgt"><var>-S</var></a> of git-log(1).</span>
295+
</div>
260296
</td>
261297
</tr>
262298
<tr>
263299
<td>
264300
<kbd>
265-
<span>-r, --range <var>&lt;START&gt;[,&lt;END&gt;]</var></span>
301+
<span>-r, --range <var>X[,Y]</var></span>
266302
</kbd>
267303
</td>
268304
<td>
269-
<span>Show commits in range <var>&lt;START&gt;</var>-<var>&lt;END&gt;</var>.</span>
270-
<span>Omit <var>&lt;END&gt;</var> defaults to <var>HEAD</var>.</span>
305+
<div>
306+
<span>Show commits in range <var>X</var> through <var>Y</var>.</span>
307+
</div>
308+
<div>
309+
<span>Omit <var>Y</var> defaults to <var>HEAD</var>.</span>
310+
</div>
271311
</td>
272312
</tr>
273313
<tr>
@@ -277,18 +317,24 @@ Options can be specified to provide more refined information. If no options are
277317
</kbd>
278318
</td>
279319
<td>
280-
<span>Show commits in reverse chronological order.</span>
281-
<span>See <a href="https://git-scm.com/docs/git-log#git-log---walk-reflogs"><var>--walk-reflogs</var></a> of git-log(1).</span>
320+
<div>
321+
<span>Show commits in reverse chronological order.</span>
322+
</div>
323+
<div>
324+
<span>See <a href="https://git-scm.com/docs/git-log#git-log---walk-reflogs"><var>--walk-reflogs</var></a> of git-log(1).</span>
325+
</div>
282326
</td>
283327
</tr>
284328
<tr>
285329
<td>
286330
<kbd>
287-
<span>-t, --tag <var>&lt;TAG&gt;</var></span>
331+
<span>-t, --tag <var>TAG</var></span>
288332
</kbd>
289333
</td>
290334
<td>
291-
<span>Show commits specific to a tag.</span>
335+
<div>
336+
<span>Show commits specific to tag <var>TAG</var>.</span>
337+
</div>
292338
</td>
293339
</tr>
294340
<tr>
@@ -298,7 +344,9 @@ Options can be specified to provide more refined information. If no options are
298344
</kbd>
299345
</td>
300346
<td>
301-
<span>Show total number of commits for pathspec.</span>
347+
<div>
348+
<span>Show total number of commits for pathspec.</span>
349+
</div>
302350
</td>
303351
</tr>
304352
<tr>
@@ -308,7 +356,9 @@ Options can be specified to provide more refined information. If no options are
308356
</kbd>
309357
</td>
310358
<td>
311-
<span>Show usage information.</span>
359+
<div>
360+
<span>Show usage information.</span>
361+
</div>
312362
</td>
313363
</tr>
314364
<tr>
@@ -318,7 +368,9 @@ Options can be specified to provide more refined information. If no options are
318368
</kbd>
319369
</td>
320370
<td>
321-
<span>Show current version number.</span>
371+
<div>
372+
<span>Show current version number.</span>
373+
</div>
322374
</td>
323375
</tr>
324376
</tbody>

0 commit comments

Comments
 (0)