3006f5ee16 · matheusbsbs/matheus-bagliano

@@ -14,14 +14,14 @@ SYNOPSIS

14

15 DESCRIPTION

16 -----------

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.

21

22 '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

25 the current branch.)

26 +

27 This means that `git reset <paths>` is the opposite of `git add

@@ -36,7 +36,7 @@ working tree in one go.

36

37 'git reset' (--patch | -p) [<tree-ish>] [--] [<paths>...]::

38 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

40 in reverse to the index.

41 +

42 This means that `git reset -p` is the opposite of `git add -p`, i.e.

@@ -44,16 +44,16 @@ you can use it to selectively reset hunks. See the ``Interactive Mode''

44 section of linkgit:git-add[1] to learn how to operate the `--patch` mode.

45

46 '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:

51 +

52 --

53 --soft::

54 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`

57 would put it.

58

59 --mixed::

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

66

67 --hard::

68 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.

70

71 --merge::

72 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

74 different between the index and working tree (i.e. which have changes

75 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.

78 +

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>`,

80 but carries forward unmerged index entries.

81

82 --keep::

83 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.

87 --

88

89 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>

113 +

114 <1> You are happily working on something, and find the changes

115 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

117 and changes with these files are distracting.

118 <2> Somebody asks you to pull, and the changes sound worthy of merging.

119 <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

122 index changes for these two files. Your changes in working tree

123 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`

125 changes still in the working tree.

126

127 Undo a commit and redo::

@@ -137,11 +137,11 @@ $ git commit -a -c ORIG_HEAD <3>

137 just committed is incomplete, or you misspelled your commit

138 message, or both. Leaves working tree as it was before "reset".

139 <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

141 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.

143 +

144 -See also the --amend option to linkgit:git-commit[1].

144 +See also the `--amend` option to linkgit:git-commit[1].

145

146 Undo a commit, making it a topic branch::

147 +

@@ -152,11 +152,11 @@ $ git checkout topic/wip <3>

152 ------------

153 +

154 <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`.

158 <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.

160

161 Undo commits permanently::

162 +

@@ -165,7 +165,7 @@ $ git commit ...

165 $ git reset --hard HEAD~3 <1>

166 ------------

167 +

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

169 and you do not want to ever see them again. Do *not* do this if

170 you have already given these commits to somebody else. (See the

171 "RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1] for

@@ -188,14 +188,14 @@ $ git reset --hard ORIG_HEAD <4>

188 <1> Try to update from the upstream resulted in a lot of

189 conflicts; you were not ready to spend a lot of time merging

190 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

193 from the index file and the working tree.

194 <3> Merge a topic branch into the current branch, which resulted

195 in a fast-forward.

196 <4> But you decided that the topic branch is not ready for public

197 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

199 brings your index file and the working tree back to that state,

200 and resets the tip of the branch to that commit.

201

@@ -211,14 +211,14 @@ $ git reset --merge ORIG_HEAD <2>

211 ------------

212 +

213 <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

215 that the change in the other branch does not overlap with

216 them.

217 <2> After inspecting the result of the merge, you may find

218 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

220 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.

222

223

224 Interrupted workflow::

@@ -284,13 +284,13 @@ $ git checkout -b branch2 <2>

284 $ git reset --keep start <3>

285 ------------

286 +

287 -<1> This commits your first edits in branch1.

287 +<1> This commits your first edits in `branch1`.

288 <2> In the ideal world, you could have realized that the earlier

289 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

291 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`.

294

295 Split a commit apart into a sequence of commits::

296 +

@@ -314,26 +314,27 @@ $ git commit ... <8>

314 +

315 <1> First, reset the history back one commit so that we remove the original

316 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`

318 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`

320 facility. This will ask you about each diff hunk in sequence and you can

321 use simple commands such as "yes, include this", "No don't include this"

322 or even the very powerful "edit" facility.

323 <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

325 shows all the changes that have been moved into the index and are about

326 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

328 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.

334 <5> You can repeat steps 2-4 multiple times to break the original code into

335 any number of commits.

336 <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

338 uncommitted changes.

339 <7> Once again, check to verify that you've included what you want to. You may

340 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:

351 git reset --option target

352 ----------

353

353 -to reset the HEAD to another commit (`target`) with the different

354 +to reset the `HEAD` to another commit (`target`) with the different

355 reset options depending on the state of the files.

356

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

358 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`).

365

366 ....

367 working index HEAD target working index HEAD

@@ -422,21 +423,21 @@ working index HEAD target working index HEAD

423 --keep B C C

424 ....

425

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

427 merge. Any mergy operation guarantees that the working tree file that is

428 involved in the merge does not have local change wrt the index before

429 it starts, and that it writes the result out to the working tree. So if

430 we see some difference between the index and the target and also

431 between the index and the working tree, then it means that we are not

432 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.

434

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

436 commits in the current branch while keeping changes in the working

437 tree. If there could be conflicts between the changes in the commit we

438 want to remove and the changes in the working tree we want to keep,

439 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

441 target. To be safe, it is also disallowed when there are unmerged

442 entries.

443

@@ -463,7 +464,7 @@ working index HEAD target working index HEAD

464 --keep (disallowed)

465 ....

466

466 -X means any state and U means an unmerged index.

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

468

469 GIT

470 ---

git-reset.txt: render literal examples as monospace