Commit eb609b26 authored by Jonas Bernoulli's avatar Jonas Bernoulli

magit-reset: Improve documentation

parent 371b80c5
......@@ -8,7 +8,7 @@
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Magit: (magit).
#+TEXINFO_DIR_DESC: Using Git from Emacs with Magit.
#+SUBTITLE: for version 2.13.0 (2.13.0-294-g21f786a15+1)
#+SUBTITLE: for version 2.13.0 (2.13.0-295-g371b80c56+1)
#+BIND: ox-texinfo+-before-export-hook ox-texinfo+-update-version-strings
#+TEXINFO_DEFFN: t
......@@ -23,7 +23,7 @@ directly from within Emacs. While many fine Git clients exist, only
Magit and Git itself deserve to be called porcelains.
#+TEXINFO: @noindent
This manual is for Magit version 2.13.0 (2.13.0-294-g21f786a15+1).
This manual is for Magit version 2.13.0 (2.13.0-295-g371b80c56+1).
#+BEGIN_QUOTE
Copyright (C) 2015-2018 Jonas Bernoulli <jonas@bernoul.li>
......@@ -5438,9 +5438,10 @@ Also see [[man:git-reset]]
- Key: x, magit-reset
Reset the head and index to some commit read from the user and
defaulting to the commit at point. The working tree is kept as-is.
With a prefix argument also reset the working tree.
Reset the ~HEAD~ and index to some commit read from the user and
defaulting to the commit at point, and possibly also reset the
working tree. With a prefix argument reset the working tree
otherwise don't.
- Key: X m, magit-reset-mixed
......
......@@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Magit User Manual
@subtitle for version 2.13.0 (2.13.0-294-g21f786a15+1)
@subtitle for version 2.13.0 (2.13.0-295-g371b80c56+1)
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
......@@ -53,7 +53,7 @@ directly from within Emacs. While many fine Git clients exist, only
Magit and Git itself deserve to be called porcelains.
@noindent
This manual is for Magit version 2.13.0 (2.13.0-294-g21f786a15+1).
This manual is for Magit version 2.13.0 (2.13.0-295-g371b80c56+1).
@quotation
Copyright (C) 2015-2018 Jonas Bernoulli <jonas@@bernoul.li>
......@@ -7330,9 +7330,10 @@ the git-reset(1) manpage.
@cindex magit-reset
@item @kbd{x} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset})
Reset the head and index to some commit read from the user and
defaulting to the commit at point. The working tree is kept as-is.
With a prefix argument also reset the working tree.
Reset the @code{HEAD} and index to some commit read from the user and
defaulting to the commit at point, and possibly also reset the
working tree. With a prefix argument reset the working tree
otherwise don't.
@kindex X m
@cindex magit-reset-mixed
......
......@@ -44,8 +44,8 @@
;;;###autoload
(defun magit-reset (commit &optional hard)
"Reset the `HEAD' and index to COMMIT, but not the working tree.
With a prefix argument also reset the working tree.
"Reset the `HEAD' and index to COMMIT, and possibly the working tree.
With a prefix argument reset the working tree otherwise don't.
\n(git reset --mixed|--hard COMMIT)"
(interactive (list (magit-reset-read-branch-or-commit
(if current-prefix-arg
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment