Skip to content

Commit 3006f5e

Browse files
Martin Ågrengitster
authored andcommitted
git-reset.txt: render literal examples as monospace
Large parts of this document do not use `backticks` around literal examples such as branch names (`topic/wip`), git usages, `HEAD` and `<commit-ish>` so they render as ordinary text. Fix that. Signed-off-by: Martin Ågren <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4724f31 commit 3006f5e

File tree

1 file changed

+66
-65
lines changed

1 file changed

+66
-65
lines changed

Documentation/git-reset.txt

Lines changed: 66 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ SYNOPSIS
1414

1515
DESCRIPTION
1616
-----------
17-
In the first and second form, copy entries from <tree-ish> to the index.
18-
In the third form, set the current branch head (HEAD) to <commit>, optionally
19-
modifying index and working tree to match. The <tree-ish>/<commit> defaults
20-
to HEAD in all forms.
17+
In the first and second form, copy entries from `<tree-ish>` to the index.
18+
In the third form, set the current branch head (`HEAD`) to `<commit>`,
19+
optionally modifying index and working tree to match.
20+
The `<tree-ish>`/`<commit>` defaults to `HEAD` in all forms.
2121

2222
'git reset' [-q] [<tree-ish>] [--] <paths>...::
23-
This form resets the index entries for all <paths> to their
24-
state at <tree-ish>. (It does not affect the working tree or
23+
This form resets the index entries for all `<paths>` to their
24+
state at `<tree-ish>`. (It does not affect the working tree or
2525
the current branch.)
2626
+
2727
This means that `git reset <paths>` is the opposite of `git add
@@ -36,24 +36,24 @@ working tree in one go.
3636

3737
'git reset' (--patch | -p) [<tree-ish>] [--] [<paths>...]::
3838
Interactively select hunks in the difference between the index
39-
and <tree-ish> (defaults to HEAD). The chosen hunks are applied
39+
and `<tree-ish>` (defaults to `HEAD`). The chosen hunks are applied
4040
in reverse to the index.
4141
+
4242
This means that `git reset -p` is the opposite of `git add -p`, i.e.
4343
you can use it to selectively reset hunks. See the ``Interactive Mode''
4444
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
4545

4646
'git reset' [<mode>] [<commit>]::
47-
This form resets the current branch head to <commit> and
48-
possibly updates the index (resetting it to the tree of <commit>) and
49-
the working tree depending on <mode>. If <mode> is omitted,
50-
defaults to "--mixed". The <mode> must be one of the following:
47+
This form resets the current branch head to `<commit>` and
48+
possibly updates the index (resetting it to the tree of `<commit>`) and
49+
the working tree depending on `<mode>`. If `<mode>` is omitted,
50+
defaults to `--mixed`. The `<mode>` must be one of the following:
5151
+
5252
--
5353
--soft::
5454
Does not touch the index file or the working tree at all (but
55-
resets the head to <commit>, just like all modes do). This leaves
56-
all your changed files "Changes to be committed", as 'git status'
55+
resets the head to `<commit>`, just like all modes do). This leaves
56+
all your changed files "Changes to be committed", as `git status`
5757
would put it.
5858

5959
--mixed::
@@ -66,24 +66,24 @@ linkgit:git-add[1]).
6666

6767
--hard::
6868
Resets the index and working tree. Any changes to tracked files in the
69-
working tree since <commit> are discarded.
69+
working tree since `<commit>` are discarded.
7070

7171
--merge::
7272
Resets the index and updates the files in the working tree that are
73-
different between <commit> and HEAD, but keeps those which are
73+
different between `<commit>` and `HEAD`, but keeps those which are
7474
different between the index and working tree (i.e. which have changes
7575
which have not been added).
76-
If a file that is different between <commit> and the index has unstaged
77-
changes, reset is aborted.
76+
If a file that is different between `<commit>` and the index has
77+
unstaged changes, reset is aborted.
7878
+
79-
In other words, --merge does something like a 'git read-tree -u -m <commit>',
79+
In other words, `--merge` does something like a `git read-tree -u -m <commit>`,
8080
but carries forward unmerged index entries.
8181

8282
--keep::
8383
Resets index entries and updates files in the working tree that are
84-
different between <commit> and HEAD.
85-
If a file that is different between <commit> and HEAD has local changes,
86-
reset is aborted.
84+
different between `<commit>` and `HEAD`.
85+
If a file that is different between `<commit>` and `HEAD` has local
86+
changes, reset is aborted.
8787
--
8888

8989
If you want to undo a commit other than the latest on a branch,
@@ -113,15 +113,15 @@ $ git pull git://info.example.com/ nitfol <4>
113113
+
114114
<1> You are happily working on something, and find the changes
115115
in these files are in good order. You do not want to see them
116-
when you run "git diff", because you plan to work on other files
116+
when you run `git diff`, because you plan to work on other files
117117
and changes with these files are distracting.
118118
<2> Somebody asks you to pull, and the changes sound worthy of merging.
119119
<3> However, you already dirtied the index (i.e. your index does
120-
not match the HEAD commit). But you know the pull you are going
121-
to make does not affect frotz.c or filfre.c, so you revert the
120+
not match the `HEAD` commit). But you know the pull you are going
121+
to make does not affect `frotz.c` or `filfre.c`, so you revert the
122122
index changes for these two files. Your changes in working tree
123123
remain there.
124-
<4> Then you can pull and merge, leaving frotz.c and filfre.c
124+
<4> Then you can pull and merge, leaving `frotz.c` and `filfre.c`
125125
changes still in the working tree.
126126

127127
Undo a commit and redo::
@@ -137,11 +137,11 @@ $ git commit -a -c ORIG_HEAD <3>
137137
just committed is incomplete, or you misspelled your commit
138138
message, or both. Leaves working tree as it was before "reset".
139139
<2> Make corrections to working tree files.
140-
<3> "reset" copies the old head to .git/ORIG_HEAD; redo the
140+
<3> "reset" copies the old head to `.git/ORIG_HEAD`; redo the
141141
commit by starting with its log message. If you do not need to
142-
edit the message further, you can give -C option instead.
142+
edit the message further, you can give `-C` option instead.
143143
+
144-
See also the --amend option to linkgit:git-commit[1].
144+
See also the `--amend` option to linkgit:git-commit[1].
145145

146146
Undo a commit, making it a topic branch::
147147
+
@@ -152,11 +152,11 @@ $ git checkout topic/wip <3>
152152
------------
153153
+
154154
<1> You have made some commits, but realize they were premature
155-
to be in the "master" branch. You want to continue polishing
156-
them in a topic branch, so create "topic/wip" branch off of the
157-
current HEAD.
155+
to be in the `master` branch. You want to continue polishing
156+
them in a topic branch, so create `topic/wip` branch off of the
157+
current `HEAD`.
158158
<2> Rewind the master branch to get rid of those three commits.
159-
<3> Switch to "topic/wip" branch and keep working.
159+
<3> Switch to `topic/wip` branch and keep working.
160160

161161
Undo commits permanently::
162162
+
@@ -165,7 +165,7 @@ $ git commit ...
165165
$ git reset --hard HEAD~3 <1>
166166
------------
167167
+
168-
<1> The last three commits (HEAD, HEAD^, and HEAD~2) were bad
168+
<1> The last three commits (`HEAD`, `HEAD^`, and `HEAD~2`) were bad
169169
and you do not want to ever see them again. Do *not* do this if
170170
you have already given these commits to somebody else. (See the
171171
"RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1] for
@@ -188,14 +188,14 @@ $ git reset --hard ORIG_HEAD <4>
188188
<1> Try to update from the upstream resulted in a lot of
189189
conflicts; you were not ready to spend a lot of time merging
190190
right now, so you decide to do that later.
191-
<2> "pull" has not made merge commit, so "git reset --hard"
192-
which is a synonym for "git reset --hard HEAD" clears the mess
191+
<2> "pull" has not made merge commit, so `git reset --hard`
192+
which is a synonym for `git reset --hard HEAD` clears the mess
193193
from the index file and the working tree.
194194
<3> Merge a topic branch into the current branch, which resulted
195195
in a fast-forward.
196196
<4> But you decided that the topic branch is not ready for public
197197
consumption yet. "pull" or "merge" always leaves the original
198-
tip of the current branch in ORIG_HEAD, so resetting hard to it
198+
tip of the current branch in `ORIG_HEAD`, so resetting hard to it
199199
brings your index file and the working tree back to that state,
200200
and resets the tip of the branch to that commit.
201201

@@ -211,14 +211,14 @@ $ git reset --merge ORIG_HEAD <2>
211211
------------
212212
+
213213
<1> Even if you may have local modifications in your
214-
working tree, you can safely say "git pull" when you know
214+
working tree, you can safely say `git pull` when you know
215215
that the change in the other branch does not overlap with
216216
them.
217217
<2> After inspecting the result of the merge, you may find
218218
that the change in the other branch is unsatisfactory. Running
219-
"git reset --hard ORIG_HEAD" will let you go back to where you
219+
`git reset --hard ORIG_HEAD` will let you go back to where you
220220
were, but it will discard your local changes, which you do not
221-
want. "git reset --merge" keeps your local changes.
221+
want. `git reset --merge` keeps your local changes.
222222

223223

224224
Interrupted workflow::
@@ -284,13 +284,13 @@ $ git checkout -b branch2 <2>
284284
$ git reset --keep start <3>
285285
------------
286286
+
287-
<1> This commits your first edits in branch1.
287+
<1> This commits your first edits in `branch1`.
288288
<2> In the ideal world, you could have realized that the earlier
289289
commit did not belong to the new topic when you created and switched
290-
to branch2 (i.e. "git checkout -b branch2 start"), but nobody is
290+
to `branch2` (i.e. `git checkout -b branch2 start`), but nobody is
291291
perfect.
292-
<3> But you can use "reset --keep" to remove the unwanted commit after
293-
you switched to "branch2".
292+
<3> But you can use `reset --keep` to remove the unwanted commit after
293+
you switched to `branch2`.
294294

295295
Split a commit apart into a sequence of commits::
296296
+
@@ -314,26 +314,27 @@ $ git commit ... <8>
314314
+
315315
<1> First, reset the history back one commit so that we remove the original
316316
commit, but leave the working tree with all the changes. The -N ensures
317-
that any new files added with HEAD are still marked so that git add -p
317+
that any new files added with `HEAD` are still marked so that `git add -p`
318318
will find them.
319-
<2> Next, we interactively select diff hunks to add using the git add -p
319+
<2> Next, we interactively select diff hunks to add using the `git add -p`
320320
facility. This will ask you about each diff hunk in sequence and you can
321321
use simple commands such as "yes, include this", "No don't include this"
322322
or even the very powerful "edit" facility.
323323
<3> Once satisfied with the hunks you want to include, you should verify what
324-
has been prepared for the first commit by using git diff --cached. This
324+
has been prepared for the first commit by using `git diff --cached`. This
325325
shows all the changes that have been moved into the index and are about
326326
to be committed.
327-
<4> Next, commit the changes stored in the index. The -c option specifies to
327+
<4> Next, commit the changes stored in the index. The `-c` option specifies to
328328
pre-populate the commit message from the original message that you started
329-
with in the first commit. This is helpful to avoid retyping it. The HEAD@{1}
330-
is a special notation for the commit that HEAD used to be at prior to the
331-
original reset commit (1 change ago). See linkgit:git-reflog[1] for more
332-
details. You may also use any other valid commit reference.
329+
with in the first commit. This is helpful to avoid retyping it. The
330+
`HEAD@{1}` is a special notation for the commit that `HEAD` used to be at
331+
prior to the original reset commit (1 change ago).
332+
See linkgit:git-reflog[1] for more details. You may also use any other
333+
valid commit reference.
333334
<5> You can repeat steps 2-4 multiple times to break the original code into
334335
any number of commits.
335336
<6> Now you've split out many of the changes into their own commits, and might
336-
no longer use the patch mode of git add, in order to select all remaining
337+
no longer use the patch mode of `git add`, in order to select all remaining
337338
uncommitted changes.
338339
<7> Once again, check to verify that you've included what you want to. You may
339340
also wish to verify that git diff doesn't show any remaining changes to be
@@ -350,17 +351,17 @@ The tables below show what happens when running:
350351
git reset --option target
351352
----------
352353

353-
to reset the HEAD to another commit (`target`) with the different
354+
to reset the `HEAD` to another commit (`target`) with the different
354355
reset options depending on the state of the files.
355356

356-
In these tables, A, B, C and D are some different states of a
357+
In these tables, `A`, `B`, `C` and `D` are some different states of a
357358
file. For example, the first line of the first table means that if a
358-
file is in state A in the working tree, in state B in the index, in
359-
state C in HEAD and in state D in the target, then "git reset --soft
360-
target" will leave the file in the working tree in state A and in the
361-
index in state B. It resets (i.e. moves) the HEAD (i.e. the tip of
362-
the current branch, if you are on one) to "target" (which has the file
363-
in state D).
359+
file is in state `A` in the working tree, in state `B` in the index, in
360+
state `C` in `HEAD` and in state `D` in the target, then `git reset --soft
361+
target` will leave the file in the working tree in state `A` and in the
362+
index in state `B`. It resets (i.e. moves) the `HEAD` (i.e. the tip of
363+
the current branch, if you are on one) to `target` (which has the file
364+
in state `D`).
364365

365366
....
366367
working index HEAD target working index HEAD
@@ -422,21 +423,21 @@ working index HEAD target working index HEAD
422423
--keep B C C
423424
....
424425

425-
"reset --merge" is meant to be used when resetting out of a conflicted
426+
`reset --merge` is meant to be used when resetting out of a conflicted
426427
merge. Any mergy operation guarantees that the working tree file that is
427428
involved in the merge does not have local change wrt the index before
428429
it starts, and that it writes the result out to the working tree. So if
429430
we see some difference between the index and the target and also
430431
between the index and the working tree, then it means that we are not
431432
resetting out from a state that a mergy operation left after failing
432-
with a conflict. That is why we disallow --merge option in this case.
433+
with a conflict. That is why we disallow `--merge` option in this case.
433434

434-
"reset --keep" is meant to be used when removing some of the last
435+
`reset --keep` is meant to be used when removing some of the last
435436
commits in the current branch while keeping changes in the working
436437
tree. If there could be conflicts between the changes in the commit we
437438
want to remove and the changes in the working tree we want to keep,
438439
the reset is disallowed. That's why it is disallowed if there are both
439-
changes between the working tree and HEAD, and between HEAD and the
440+
changes between the working tree and `HEAD`, and between `HEAD` and the
440441
target. To be safe, it is also disallowed when there are unmerged
441442
entries.
442443

@@ -463,7 +464,7 @@ working index HEAD target working index HEAD
463464
--keep (disallowed)
464465
....
465466

466-
X means any state and U means an unmerged index.
467+
`X` means any state and `U` means an unmerged index.
467468

468469
GIT
469470
---

0 commit comments

Comments
 (0)