path: root/Documentation/magit.texi

\input texinfo    @c -*- texinfo -*-
@c %**start of header
@setfilename ./magit.info
@settitle Magit User Manual
@documentencoding UTF-8
@documentlanguage en
@c %**end of header

@copying
@ifnottex
Magit is an interface to the version control system Git, implemented
as an Emacs package.  Magit aspires to be a complete Git porcelain.
While we cannot (yet) claim that Magit wraps and improves upon each
and every Git command, it is complete enough to allow even experienced
Git users to perform almost all of their daily version control tasks
directly from within Emacs.  While many fine Git clients exist, only
Magit and Git itself deserve to be called porcelains.
@end ifnottex

@quotation
Copyright (C) 2015 Jonas Bernoulli <jonas@@bernoul.li>

You can redistribute this document and/or modify it under the terms
of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any
later version.

This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
@end quotation
@end copying

@dircategory Emacs
@direntry
* Magit: (magit).       Using Git from Emacs with Magit.
@end direntry

@finalout
@titlepage
@title Magit User Manual
@subtitle for version 2.1
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@contents

@ifnottex
@node Top
@top Magit User Manual
@insertcopying
@end ifnottex


@menu
* Introduction::
* Installation::
* Getting started::
* Interface concepts::
* Inspecting::
* Manipulating::
* Transferring::
* Miscellaneous::
* Customizing::
* Plumbing::
* FAQ::
* Keystroke Index::
* Command Index::
* Function Index::
* Variable Index::

@detailmenu
--- The Detailed Node Listing ---

Installation

* Updating from an older release::
* Installing from an Elpa archive::
* Installing from the Git repository::
* Post-installation tasks::

Interface concepts

* Modes and Buffers::
* Automatic save::
* Automatic refresh and revert::
* Sections::
* Popup buffers and prefix commands::
* Completion and confirmation::
* Running Git::

Sections

* Section movement::
* Section visibility::
* Section hooks::
* Section types and values::
* Section options::

Running Git

* Viewing Git output::
* Running Git manually::
* Git executable::
* Global Git arguments::

Inspecting

* Status buffer::
* Logging::
* Diffing::
* Ediffing::
* References buffer::
* Bisecting::
* Visiting blobs::
* Blaming::

Status buffer

* Status sections::
* Status header sections::
* Status options::

Logging

* Log Buffer::
* Select from log::
* Reflog::

Diffing

* Refreshing diffs::
* Diff buffer::
* Diff options::
* Revision buffer::

References buffer

* References sections::

Manipulating

* Repository setup::
* Staging and unstaging::
* Applying::
* Committing::
* Branching::
* Merging::
* Rebasing::
* Cherry picking::
* Resetting::
* Stashing::

Staging and unstaging

* Staging from file-visiting buffers::

Committing

* Initiating a commit::
* Editing commit messages::

Rebasing

* Editing rebase sequences::

Cherry picking

* Reverting::

Transferring

* Remotes::
* Fetching::
* Pulling::
* Pushing::
* Creating and sending patches::
* Applying patches::

Miscellaneous

* Tagging::
* Notes::
* Submodules::
* Wip Modes::

Customizing

* Per-repository configuration::
* Essential settings::

Essential settings

* Safety::
* Performance::

Plumbing

* Calling Git::
* Section plumbing::
* Refreshing buffers::
* Conventions::

Calling Git

* Getting a value from Git::
* Calling Git for effect::

Section plumbing

* Creating sections::
* Section selection::
* Matching sections::

Conventions

* Confirmation and completion::
* Theming Faces::

FAQ

* Magit is slow::
* I am having problems committing::
* I am using an Emacs release older than 24.4: I am using an Emacs release older than 244. 
* I am using a Git release older than 1.9.4: I am using a Git release older than 194. 
* I am using MS Windows and cannot push with Magit::
* How to install the gitman info manual?::
* How can I show Git's output?::
* Expanding a file to show the diff causes it to disappear::
* Magit claims repository accessed using Tramp does not exist::
* Can Magit be used as ediff-version-control-package?::
* How to show diffs for gpg-encrypted files?::
* Emacs 24.5 hangs when loading Magit: Emacs 245 hangs when loading Magit. 

@end detailmenu
@end menu



@node Introduction
@chapter Introduction

Magit is an interface to the version control system Git, implemented
as an Emacs package.  Magit aspires to be a complete Git porcelain.
While we cannot (yet) claim that Magit wraps and improves upon each
and every Git command, it is complete enough to allow even experienced
Git users to perform almost all of their daily version control tasks
directly from within Emacs.  While many fine Git clients exist, only
Magit and Git itself deserve to be called porcelains.

Staging and otherwise applying changes is one of the most important
features in a Git porcelain and here Magit outshines anything else,
including Git itself.  Git's own staging interface (@code{git add --patch})
is so cumbersome that many users only use it in exceptional cases.
In Magit staging a hunk or even just part of a hunk is as trivial as
staging all changes made to a file.

The most visible part of Magit's interface is the status buffer, which
displays information about the current repository.  Its content is
created by running several Git commands and making their output
actionable.  Among other things, it displays information about the
current branch, lists unpulled and unpushed changes and contains
sections displaying the staged and unstaged changes.  That might sound
noisy, but, since sections are collapsible, it's not.

To stage or unstage a change one places the cursor on the change and
then types @code{s} or @code{u}.  The change can be a file or a hunk, or when the
region is active (i.e. when there is a selection) several files or
hunks, or even just part of a hunk.  The change or changes that these
commands - and many others - would act on are highlighted.

Magit also implements several other "apply variants" in addition to
staging and unstaging.  One can discard or reverse a change, or
apply it to the working tree.  Git's own porcelain only supports this
for staging and unstaging and you would have to do something like @code{git
diff ... | ??? | git apply ...} to discard, revert, or apply a single
hunk on the command line.  In fact that's exactly what Magit does
internally (which is what lead to the term "apply variants").

Magit isn't just for Git experts, but it does assume some prior
experience with Git as well as Emacs.  That being said, many users
have reported that using Magit was what finally taught them what Git
it is capable off and how to use it to its fullest.  Other users
wished they had switched to Emacs sooner so that they would have
gotten their hands on Magit earlier.

While one has to know the basic features of Emacs to be able to make
full use of Magit, acquiring just enough Emacs skills doesn't take
long and is worth it, even for users who prefer other editors.  Vim
users are advised to give @uref{https://bitbucket.org/lyro/evil/wiki/Home,Evil}, the "Extensible VI Layer for Emacs",
and @uref{https://github.com/syl20bnr/spacemacs,Spacemacs}, an "Emacs starter-kit focused on Evil" a try.

Magit provides a consistent and efficient Git porcelain.  After a
short learning period, you will be able to perform most of your daily
version control tasks faster than you would on the command line.  You
will likely also start using features that seemed too daunting in the
past.

Magit fully embraces Git.  It exposes many advanced features using a
simple but flexible interface instead of only wrapping the trivial
ones like many GUI clients do.  Of course Magit supports logging,
cloning, pushing, and other commands that usually don't fail in
spectacular ways; but it also supports tasks that often cannot be
completed in a single step.  Magit fully supports tasks such as
merging, rebasing, cherry-picking, reverting, and blaming by not only
providing a command to initiate these tasks but also by displaying
context sensitive information along the way and providing commands
that are useful for resolving conflicts and resuming the sequence
after doing so.

Magit wraps and in many cases improves upon at least the following Git
porcelain commands: @code{add}, @code{am}, @code{bisect}, @code{blame}, @code{branch},
@code{checkout}, @code{cherry}, @code{cherry-pick}, @code{clean}, @code{clone}, @code{commit},
@code{config}, @code{describe}, @code{diff}, @code{fetch}, @code{format-patch}, @code{init}, @code{log},
@code{merge}, @code{merge-tree}, @code{mv}, @code{notes}, @code{pull}, @code{rebase}, @code{reflog},
@code{remote}, @code{request-pull}, @code{reset}, @code{revert}, @code{rm}, @code{show}, @code{stash},
@code{submodule}, and @code{tag}.  Many more Magit porcelain commands are
implemented on top of Git plumbing commands.

@node Installation
@chapter Installation

Magit can be installed using Emacs' package manager or manually from
its development repository.

@menu
* Updating from an older release::
* Installing from an Elpa archive::
* Installing from the Git repository::
* Post-installation tasks::
@end menu

@node Updating from an older release
@section Updating from an older release

When updating from @code{1.2.*} or @code{1.4.*}, you should first uninstall Magit
and some of its dependencies and restart Emacs before installing the
latest release.

@itemize
@item
The old Magit installation has to be removed because some macros
have changed and using the old definitions when building the new
release would lead to very strange results, including compile
errors.  This is due to a limitation in Emacs' package manager or
rather Emacs itself: it's not possible to reliably unload a feature
or even all features belonging to a package.


@item
Furthermore the old dependencies @code{git-commit-mode} and @code{git-rebase-mode}
have to be removed because they are no longer used by the @code{2.1.0}
release and get in the way of their successors @code{git-commit} and
@code{git-rebase}.
@end itemize

So please uninstall the packages @code{magit}, @code{git-commit-mode}, and
@code{git-rebase-mode}.  Then quit Emacs and start a new instance.  Only then
follow the instructions in either one of the next two sections.

Also note that starting with the @code{2.1.0} release, Magit requires at least
Emacs @code{24.4} and Git @code{1.9.4}.  You should make sure you have at least
these releases installed before updating Magit.  And if you connect to
remote hosts using Tramp, then you should also make sure to install a
recent enough Git version on these hosts.

@node Installing from an Elpa archive
@section Installing from an Elpa archive

If you are updating from a release older than @code{2.1.0}, then you have to
first uninstall the old version.  See @ref{Updating from an older release,Updating from an older release}.

Magit is available from all three of the popular unofficial Elpa
archives: Melpa, Melpa-Stable, and Marmalade.  If you haven't used
Emacs' package manager before, then it is high time you familiarize
yourself with it by reading the documentation in the Emacs manual,
see @ref{Packages,,,emacs,}.  Then add one of the archives to @code{package-archives}:

@itemize
@item
To use Melpa:
@end itemize

@lisp
(require 'package)
(add-to-list 'package-archives
             '("melpa" . "http://melpa.org/packages/") t)
@end lisp

@itemize
@item
To use Melpa-Stable:
@end itemize

@lisp
(require 'package)
(add-to-list 'package-archives
             '("melpa-stable" . "http://stable.melpa.org/packages/") t)
@end lisp

@itemize
@item
To use Marmalade:
@end itemize

@lisp
(require 'package)
(add-to-list 'package-archives
             '("marmalade" . "http://marmalade-repo.org/packages/") t)
@end lisp

Once you have added your preferred archive, you need to update the
local package list using:

@example
M-x package-refresh-contents RET
@end example

Once you have done that, you can install Magit and its dependencies
using:

@example
M-x package-install RET magit RET
@end example

Now see @ref{Post-installation tasks,Post-installation tasks}.

@node Installing from the Git repository
@section Installing from the Git repository

If you are updating from a release older than @code{2.1.0}, then you have to
first uninstall the old version.  See @ref{Updating from an older release,Updating from an older release}.

Magit depends on the @code{dash} library, available from all three of the
popular third-party Elpa archives.  Install it using @code{M-x
install-package RET dash RET}.  Of course you may also install it
manually from its development repository, but I won't cover that here.

Then clone the Magit repository:

@example
$ git clone git://github.com/magit/magit.git ~/.emacs.d/site-lisp/magit
$ cd ~/.emacs.d/site-lisp/magit
@end example

Then compile the libraries and generate the info manuals:

@example
$ make
@end example

If you haven't installed @code{dash} using Elpa or at @code{/path/to/magit/../dash},
then you have to tell @code{make} where to find it.  To do so create
@code{/path/to/magit/config.mk} with the following content before running
@code{make}:

@example
LOAD_PATH = -L /path/to/magit/lisp -L /path/to/dash
@end example

Finally add this to your init file:

@lisp
(add-to-list 'load-path "~/.emacs.d/site-lisp/magit/lisp")
(require 'magit)

(with-eval-after-load 'info
  (info-initialize)
  (add-to-list 'Info-directory-list
               "~/.emacs.d/site-lisp/magit/Documentation/"))
@end lisp

Note that you have to add the @code{lisp/} subdirectory to the @code{load-path},
not the top-level of the repository.

Instead of requiring the feature @code{magit}, you could only load the
autoloads, by loading the file @code{magit-autoloads.el}.

Instead of running Magit directly from the repository by adding that
to the @code{load-path}, you might want to instead install it in some other
directory using @code{sudo make install} and setting @code{load-path} accordingly.

To update Magit use:

@example
$ git pull
$ make
@end example

At times it might be necessary to run @code{make clean all} instead.

To view all available targets use @code{make help}.

Now see @ref{Post-installation tasks,Post-installation tasks}.

@node Post-installation tasks
@section Post-installation tasks

After installing Magit you should verify that you are indeed using the
Magit, Git, and Emacs releases you think you are using.  It's best to
restart Emacs before doing so, to make sure you are not using an
outdated value for @code{load-path}.

@example
M-x magit-version RET
@end example

should display something like

@example
Magit 2.1.0, Git 2.4.2, Emacs 24.5.1
@end example

Then you might also want to read about options that many users likely
want to customize.  See @ref{Essential settings,Essential settings}.

To be able to follow cross references to Git manpages found in this
manual, you might also have to manually install the @code{gitman} info manual,
or advice @code{Info-follow-nearest-node} to instead open the actual manpage.
See @ref{How to install the gitman info manual?,How to install the gitman info manual?}.

If you are completely new to Magit then see @ref{Getting started,Getting started}.

If you have used an older Magit release before, then you should have a
look at the release notes
@uref{https://raw.githubusercontent.com/magit/magit/master/Documentation/RelNotes/2.1.0.txt}.

And last but not least please consider making a donation, to ensure
that I can keep working on Magit.  See @uref{http://magit.vc/donations.html}
for various donation options.

@node Getting started
@chapter Getting started

This section describes the most essential features that many
Magitians use on a daily basis.  It only scratches the surface but
should be enough to get you started.

(You might want to create a repository just for this walk-through,
e.g. by cloning an existing repository.  If you don't use a separate
repository then make sure you create a snapshot as described below).

To display information about the current Git repository, type @code{M-x
magit-status}.  You will be doing that so often that it is best to bind
this command globally:

@lisp
(global-set-key (kbd "C-x g") 'magit-status)
@end lisp

Most Magit commands are commonly invoked from this buffer.  It should
be considered the primary interface to interact with Git using Magit.
There are many other Magit buffers, but they are usually created from
this buffer.

Depending on what state your repository is in, this buffer will
contain sections titled "Staged changes", "Unstaged changes",
"Unpulled commits", "Unpushed commits", and/or some others.

If some staged and/or unstaged changes exist, you should back them up
now.  Type @code{z} to show the stashing popup buffer featuring various stash
variants and arguments that can be passed to these commands.  Do not
worry about those for now, just type @code{Z} (uppercase) to create a stash
while also keeping the index and work tree intact.  The status buffer
should now also contain a section titled "Stashes".

Otherwise, if there are no uncommitted changes, you should create some
now by editing and saving some of the tracked files.  Then go back to
the status buffer, while at the same time refreshing it, by typing @code{C-x
g}.  (When the status buffer, or any Magit buffer for that matter, is
the current buffer, then you can also use just @code{g} to refresh it).

Move between sections using @code{p} and @code{n}.  Note that the bodies of some
sections are hidden.  Type @code{TAB} to expand or collapse the section at
point.  You can also use @code{C-tab} to cycle the visibility of the current
section and its children. Move to a file section inside the section
named "Unstaged changes" and type @code{s} to stage the changes you have made
to that file. That file now appears under "Staged changes".

Magit can stage and unstage individual hunks, not just complete files.
Move to the file you have just staged, expand it using @code{TAB}, move to
one of the hunks using @code{n}, and unstage just that by typing @code{u}.  Note how
the staging (@code{s}) and unstaging (@code{u}) commands operate on the change at
point.  Many other commands behave the same way.

You can also un-/stage just part of a hunk.  Inside the body of a hunk
section (move there using @code{C-n}), set the mark using @code{C-SPC} and move down
until some added and removed lines fall inside the region but not all
of them.  Again type @code{s} to stage.

It's also possible to un-/stage multiple files at once.  Move to a
file section, type @code{C-SPC}, move to the next file using @code{n}, and then @code{s} to
stage both files.  Note that both the mark and point have to be on the
headings of sibling sections for this to work.  If the region looks
like it does in other buffers, then it doesn't select Magit sections
that can be acted on as a unit.

And then of course you want to commit your changes.  Type @code{c}.  This
shows the committing popup buffer featuring various commit variants
and arguments that can be passed to @code{git commit}.  Do not worry about
those for now.  We want to create a "normal" commit, which is done by
typing @code{c} again.

Now two new buffers appear.  One is for writing the commit message,
the other shows a diff with the changes that are about to committed.
Write a message and then type @code{C-c C-c} to actually create the commit.

You probably don't want to push the commit you just created because
you just committed some random changes, but if that is not the case
you could push it by typing @code{P} to bring up the push popup and then @code{P}
again to push to the configured upstream.  (If the upstream is not
configured, then you would be prompted for the push target instead.)

Instead we are going to undo the changes made so far.  Bring up the
log for the current branch by typing @code{l l}, move to the last commit
created before starting with this walk through using @code{n}, and do a hard
reset using @code{C-u x}.  @strong{WARNING}: this discards all uncommitted changes.
If you did not follow the advice about using a separate repository for
these experiments and did not create a snapshot of uncommitted changes
before starting to try out Magit, then don't do this.

So far we have mentioned the commit, push, and log popups.  These are
probably among the popups you will be using the most, but many others
exist.  To show a popup with all other popups (and some other commands
which are not popups), type @code{h}.  Try a few.

In most cases the key bindings in that popup correspond to the
bindings in Magit buffers, including but not limited to the status
buffer.  So you could type @code{h d} to bring up the diff popup, but once
you remember that "d" stands for "diff", you would usually do so by
just typing @code{d}.  But the "popup of popups" is useful even once you have
memorized all the bindings, as it can provide easy access to Magit
commands from non-Magit buffers.  So you should bind this globally
too:

@lisp
(global-set-key (kbd "C-x M-g") 'magit-dispatch-popup)
@end lisp

@node Interface concepts
@chapter Interface concepts


@menu
* Modes and Buffers::
* Automatic save::
* Automatic refresh and revert::
* Sections::
* Popup buffers and prefix commands::
* Completion and confirmation::
* Running Git::
@end menu

@node Modes and Buffers
@section Modes and Buffers

Magit provides several major modes.  For each of these modes there
usually exists only one buffer per repository.  Separate modes and
thus buffers exist for commits, diffs, logs, and some other things.

In this manual we often speak about "Magit buffers".  By that we mean
buffers whose major-modes derive from @code{magit-mode}.

Besides these special purpose buffers, there also exists an overview
buffer, called the @strong{status buffer}.  Its usually from this buffer that
the user invokes Git commands, or creates or visits other buffers.

@table @asis
@kindex q
@cindex magit-mode-bury-buffer
@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-mode-bury-buffer})

This command buries the current Magit buffer.  With a prefix
argument, it instead kills the buffer.

If @code{magit-restore-window-configuration} is non-nil and the last
configuration stored by @code{magit-mode-display-buffer} originates from
the selected frame (which usually is the case), then that is restored
after burying or killing the buffer.

@end table

@defopt magit-restore-window-configuration

This option controls whether quitting a Magit buffer restores the
previous window configuration.
@end defopt

While it often is enough to have one buffer of a certain Magit mode
per repository, this is not always the case.  You might, for example,
want to view the diffs for two commits at the same time.  To do so,
first rename the existing revision buffer.  Then show another commit.
Usually that would reuse the existing buffer, but because its name no
longer matches the default name, a new buffer is created instead.  The
new buffer uses the default name, and therefore will be reused to show
other commits as usual.

@table @asis
@kindex M-x magit-rename-buffer
@cindex magit-rename-buffer
@item @kbd{M-x magit-rename-buffer} @tie{}@tie{}@tie{}@tie{}(@code{magit-rename-buffer})

This command changes the name of the current Magit buffer by
appending @code{<N>} and thereby keeping Magit from re-using it to display
other information of the same kind.

With a prefix argument, the user can pick an arbitrary name.
@end table

@node Automatic save
@section Automatic save

File-visiting buffers are by default saved at certain points in time.
This doesn't guarantee that Magit buffers are always up-to-date, but,
provided one only edits files by editing them in Emacs and uses only
Magit to interact with Git, one can be fairly confident.  When in
doubt or after outside changes, type @code{g} (@code{magit-refresh}) to save and
refresh explicitly.

@defopt magit-save-repository-buffers

This option controls whether file-visiting buffers are saved before
certain events.

If this is non-nil then all modified file-visiting buffers belonging
to the current repository may be saved before running commands,
before creating new Magit buffers, and before explicitly refreshing
such buffers.  If this is @code{dontask} then this is done without user
intervention.  If it is @code{t} then the user has to confirm each save.
@end defopt

@node Automatic refresh and revert
@section Automatic refresh and revert

After running a commands which may change the state of the current
repository, the current Magit buffer and the corresponding status
buffer are refreshed.  This ensures that the displayed information is
up-to-date but can lead to a noticeable delay in big repositories.
Other Magit buffers are not refreshed to keep the delay to a minimum
and also because doing so can sometimes be undesirable.

@defopt magit-revert-buffers

This option controls if and how file-visiting buffers in the current
repository are reverted.

Unmodified buffers visiting files belonging to the current
repository may be reverted after refreshing the current Magit buffer
and after running certain other commands.

@itemize
@item
@code{nil}

Don't revert any buffers.


@item
@code{ask}

List the buffers which might potentially have to be reverted and
ask the user whether she wants to revert them.  If so, then do it
synchronously.


@item
@code{t}

Revert the buffers synchronously, mentioning each one as it is
being reverted and then also show a summary in the echo area.


@item
@code{usage}

Like @code{t} but include usage information in the summary.  This is the
default so that users come here and pick what is right for them.


@item
@code{silent}

Revert the buffers synchronously and be quiet about it.


@item
NUMBER

An integer or float.  Revert the buffers asynchronously,
mentioning each one as it is being reverted.  If user input
arrives, then stop reverting.  After NUMBER seconds resume
reverting.
@end itemize
@end defopt

Buffers can also be refreshed explicitly, which is useful in buffers
that weren't current during the last refresh and after changes were
made to the repository outside of Magit.

@table @asis
@kindex g
@cindex magit-refresh
@item @kbd{g} @tie{}@tie{}@tie{}@tie{}(@code{magit-refresh})

This command refreshes the current buffer if its major mode derives
from @code{magit-mode} as well as the corresponding status buffer.

If the option @code{magit-revert-buffers} calls for it, then it also
reverts all unmodified buffers that visit files being tracked in the
current repository.

@kindex G
@cindex magit-refresh-all
@item @kbd{G} @tie{}@tie{}@tie{}@tie{}(@code{magit-refresh-all})

This command refreshes all Magit buffers belonging to the current
repository and also reverts all unmodified buffers that visit files
being tracked in the current repository.

The file-visiting buffers are always reverted, even if
@code{magit-revert-buffers} is nil.

@end table

@defopt magit-refresh-buffer-hook

This hook is run in each Magit buffer that was refreshed during the
current refresh - normally the current buffer and the status buffer.
@end defopt

@defopt magit-after-revert-hook

This hook is run in each file-visiting buffer belonging to the
current repository that was actually reverted during a refresh.

Note that adding something here is very expensive.  If you
experience performance issues, you might want to check this hook, as
well as @code{magit-not-reverted-hook} and, if possible, remove some of the
functions added by third-party packages.
@end defopt

@defopt magit-not-reverted-hook

This hook is run in each file-visiting buffer belonging to the
current repository that was reverted during a refresh.  The file
was not reverted because it did not change, and so Magit does not
have to do anything.  This hook is intended for third-party
extensions that need to run some functions even on such files.
@end defopt

@node Sections
@section Sections

Magit buffers are organized into nested sections, which can be
collapsed and expanded, similar to how sections are handled in Org
mode.  Each section also has a type, and some sections also have a
value.  For each section type there can also be a local keymap, shared
by all sections of that type.

Taking advantage the section value and type, many commands operate on
the current section, or when the region is active and selects sections
of the same type, all of the selected sections.  Commands that only
make sense for a particular section type (as opposed to just behaving
differently depending on the type) are usually bound in section type
keymaps.

@menu
* Section movement::
* Section visibility::
* Section hooks::
* Section types and values::
* Section options::
@end menu

@node Section movement
@subsection Section movement

To move within a section use the usual keys (@code{C-p}, @code{C-n}, @code{C-b}, @code{C-f} etc),
whose global bindings are not shadowed.  To move to another section use
the following commands.

@table @asis
@kindex p
@cindex magit-section-backward
@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-backward})

When not at the beginning of a section, then move to the beginning
of the current section.  At the beginning of a section, instead move
to the beginning of the previous visible section.

@kindex n
@cindex magit-section-forward
@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-forward})

Move to the beginning of the next visible section.

@kindex P
@cindex magit-section-backward-siblings
@item @kbd{P} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-backward-siblings})

Move to the beginning of the previous sibling section.  If there is
no previous sibling section, then move to the parent section
instead.

@kindex N
@cindex magit-section-forward-siblings
@item @kbd{N} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-forward-siblings})

Move to the beginning of the next sibling section.  If there is no
next sibling section, then move to the parent section instead.

@kindex ^
@cindex magit-section-up
@item @kbd{^} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-up})

Move to the beginning of the parent of the current section.
@end table

The above commands all call the hook @code{magit-section-movement-hook}.
And, except for the second, the below functions are all members of
that hook's default value.

@defvar magit-section-movement-hook

This hook is run by all of the above movement commands, after
arriving at the destination.
@end defvar

@defun magit-hunk-set-window-start

This hook function ensures that the beginning of the current section
is visible, provided it is a @code{hunk} section.  Otherwise, it does
nothing.
@end defun

@defun magit-section-set-window-start

This hook function ensures that the beginning of the current section
is visible, regardless of the section's type.  If you add this to
@code{magit-section-movement-hook}, then you must remove the hunk-only
variant in turn.
@end defun

@defun magit-log-maybe-show-commit

This hook function shows the commit at point in another window.  If
the section at point is a @code{commit} section and the value of
@code{magit-diff-auto-show-p} calls for it, then the commit is shown in
another window, using @code{magit-show-commit}.
@end defun

@defun magit-log-maybe-show-more-commits

This hook function only has an effect in log buffers, and @code{point} is
on the "show more" section.  If that is the case, then it doubles
the number of commits that are being shown.
@end defun

@node Section visibility
@subsection Section visibility

Magit provides many commands for changing the visibility of sections,
but all you need to get started are the next two.

@table @asis
@kindex TAB
@cindex magit-section-toggle
@item @kbd{TAB} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-toggle})

Toggle the visibility of the body of the current section.

@kindex C-<tab>
@cindex magit-section-cycle
@item @kbd{C-<tab>} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-cycle})

Cycle the visibility of current section and its children.

@kindex M-<tab>
@cindex magit-section-cycle-diffs
@item @kbd{M-<tab>} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-cycle-diffs})

Cycle the visibility of diff-related sections in the current buffer.

@kindex s-<tab>
@cindex magit-section-cycle-global
@item @kbd{s-<tab>} @tie{}@tie{}@tie{}@tie{}(@code{magit-section-cycle-global})

Cycle the visibility of all sections in the current buffer.
@end table

@kindex 1
@kindex 2
@kindex 3
@kindex 4
@cindex magit-section-show-level-1
@deffn Command magit-section-show-level-1
@cindex magit-section-show-level-2
@deffnx Command magit-section-show-level-2
@cindex magit-section-show-level-3
@deffnx Command magit-section-show-level-3
@cindex magit-section-show-level-4
@deffnx Command magit-section-show-level-4

To show sections surrounding the current section, up to level N,
press the respective number key (@code{1}, @code{2}, @code{3}, or @code{4}).
@end deffn

@kindex M-1
@kindex M-2
@kindex M-3
@kindex M-4
@cindex magit-section-show-level-1-all
@deffn Command magit-section-show-level-1-all
@cindex magit-section-show-level-2-all
@deffnx Command magit-section-show-level-2-all
@cindex magit-section-show-level-3-all
@deffnx Command magit-section-show-level-3-all
@cindex magit-section-show-level-4-all
@deffnx Command magit-section-show-level-4-all

To show all sections up to level N, press the respective number key
and meta (@code{M-1}, @code{M-2}, @code{M-3}, or @code{M-4}).
@end deffn

Some functions, which are used to implement the above commands, are
also exposed as commands themselves.  By default no keys are bound to
these commands, as they are generally perceived to be much less
useful.  But your mileage may vary.

@cindex magit-section-show
@deffn Command magit-section-show

Show the body of the current section.
@end deffn

@cindex magit-section-hide
@deffn Command magit-section-hide

Hide the body of the current section.
@end deffn

@cindex magit-section-show-headings
@deffn Command magit-section-show-headings

Recursively show headings of children of the current section.  Only
show the headings.  Previously shown text-only bodies are hidden.
@end deffn

@cindex magit-section-show-children
@deffn Command magit-section-show-children

Recursively show the bodies of children of the current section.
With a prefix argument show children down to the level of the
currect section, and hide deeper children.
@end deffn

@cindex magit-section-hide-children
@deffn Command magit-section-hide-children

Recursively hide the bodies of children of the current section.
@end deffn

@cindex magit-section-toggle-children
@deffn Command magit-section-toggle-children

Toggle visibility of bodies of children of the current section.
@end deffn

When a buffer is first created then some sections are shown expanded
while others are not.  This is hard coded.  When a buffer is refreshed
then the previous visibility is preserved. The initial visibility of
certain sections can also be overwritten using the hook
@code{magit-section-set-visibility-hook}.

@defvar magit-section-set-visibility-hook

This hook is run when first creating a buffer and also when
refreshing an existing buffer, and is used to determine the
visibility of the section currently being inserted.

Each function is called with one argument, the section being
inserted.  It should return @code{hide} or @code{show}, or to leave the visibility
undefined @code{nil}.  If no function decides on the visibility and the
buffer is being refreshed, then the visibility is preserved; or if
the buffer is being created, then the hard coded default is used.

Usually this should only be used to set the initial visibility but
not during refreshes.  If @code{magit-insert-section--oldroot} is non-nil,
then the buffer is being refreshed and these functions should
immediately return @code{nil}.
@end defvar

@node Section hooks
@subsection Section hooks

Which sections are inserted into certain buffers is controlled with
hooks.  This includes the status and the refs buffers.  For other
buffers, e.g. log, diff, and revision buffers, this is not possible.

For buffers whose sections can be customized by the user, a hook
variable called @code{magit-TYPE-sections-hook} exists.  This hook should be
changed using @code{magit-add-section-hook}.  Avoid using @code{add-hooks} or the
Custom interface.

The various available section hook variables are described later in
this manual along with the appropriate "section inserter functions".

@defun magit-add-section-hook hook function &optional at append local

Add the function FUNCTION to the value of section hook HOOK.

Add FUNCTION at the beginning of the hook list unless optional
APPEND is non-nil, in which case FUNCTION is added at the end.  If
FUNCTION already is a member then move it to the new location.

If optional AT is non-nil and a member of the hook list, then add
FUNCTION next to that instead.  Add before or after AT depending
on APPEND.  If only FUNCTION is a member of the list, then leave
it wherever it already is.

If optional LOCAL is non-nil, then modify the hook's buffer-local
value rather than its global value.  This makes the hook local by
copying the default value.  That copy is then modified.

HOOK should be a symbol.  If HOOK is void, it is first set to nil.
HOOK's value must not be a single hook function.  FUNCTION should
be a function that takes no arguments and inserts one or multiple
sections at point, moving point forward.  FUNCTION may choose not
to insert its section(s), when doing so would not make sense.  It
should not be abused for other side-effects.
@end defun

To remove a function from a section hook, use @code{remove-hook}.

@node Section types and values
@subsection Section types and values

Each section has a type, for example @code{hunk}, @code{file}, and @code{commit}.
Instances of certain section types also have a value.  The value of a
section of type @code{file}, for example, is a file name.

Users usually do not have to worry about a section's type and value,
but knowing them can be handy at times.

@table @asis
@kindex M-x magit-describe-section
@cindex magit-describe-section
@item @kbd{M-x magit-describe-section} @tie{}@tie{}@tie{}@tie{}(@code{magit-describe-section})

Show information about the section at point in the echo area,
as "VALUE [TYPE PARENT-TYPE@dots{}] BEGINNING-END".
@end table

Many commands behave differently depending on the type of the section
at point and/or somehow consume the value of that section.  But that
is only one of the reasons why the same key may do something different,
depending on what section is current.

Additionally for each section type a keymap @strong{might} be defined, named
@code{magit-TYPE-section-map}.  That keymap is used as text property keymap
of all text belonging to any section of the respective type.  If such
a map does not exist for a certain type, then you can define it
yourself, and it will automatically be used.

@node Section options
@subsection Section options

This section describes options that have an effect on more than just a
certain type of sections.  As you can see there are not many of those.

@defopt magit-section-show-child-count

Whether to append the number of children to section headings.  This
only affects sections that could benefit from this information.
@end defopt

@node Popup buffers and prefix commands
@section Popup buffers and prefix commands

Many Magit commands are implemented using @strong{popup buffers}.  First the
user invokes a @strong{popup} or @strong{prefix} command, which causes a popup buffer
with the available @strong{infix} arguments and @strong{suffix} commands to be
displayed.  The user then optionally toggles/sets some arguments and
finally invokes one of the suffix commands.

This is implemented in the library @code{magit-popup}.  Earlier releases used
the library @code{magit-key-mode}.  A future release will switch to a
yet-to-be-written successor, which will likely be named @code{transient}.

Because @code{magit-popup} can also be used by other packages without having
to depend on all of Magit, it is documented in its own manual.  See
@ref{Top,,,magit-popup,}.

@table @asis
@kindex C-c C-c
@cindex magit-dispatch-popup
@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{magit-dispatch-popup})

This popup command shows a buffer featuring all other Magit popup
commands as well as some other commands that are not popup commands
themselves.
@end table

This command is also, or especially, useful outside Magit buffers, so
you should setup a global binding:

@lisp
(global-set-key (kbd "C-x M-g") 'magit-dispatch-popup)
@end lisp

@node Completion and confirmation
@section Completion and confirmation

Many commands read a value from the user.  By default this is done
using the built-in function @code{completing-read}, but Magit can instead use
another completion framework.

@defopt magit-completing-read-function

The value of this variable is the function used to perform
completion.  Because functions @emph{intended} to replace @code{completing-read}
often are not fully compatible drop-in replacements, and also
because Magit expects them to add the default choice to the prompt
themselves, such functions should not be used directly.  Instead a
wrapper function has to be used.
@end defopt

Currently only the real @code{completing-read} and @uref{http://www.emacswiki.org/emacs/InteractivelyDoThings,Ido} are fully supported.
More frameworks will be supported in the future.

@defun magit-builtin-completing-read prompt choices &optional predicate require-match initial-input hist def

Perform completion using @code{completion-read}.
@end defun

@defun magit-ido-completing-read prompt choices &optional predicate require-match initial-input hist def

Perform completion using @code{ido-completing-read+} from the package by
the same name (which you have to explicitly install).  Ido itself
comes with a supposed drop-in replacement @code{ido-completing-read}, but
that has too many deficits to serve our needs.
@end defun

By default many commands that could potentially lead to data loss have
to be confirmed.  This includes many very common commands, so this
can become annoying quickly.  Many of these actions can be undone,
provided @code{magit-wip-before-change-mode} is turned on (which it is not by
default, due to performance concerns).

@defopt magit-no-confirm

The value of this option is a list of symbols, representing commands
which do not have to be confirmed by the user before being carried
out.

When the global mode @code{magit-wip-before-change-mode} is enabled then
many commands can be undone.  If that mode is enabled then adding
@code{safe-with-wip} to this list has the same effect as adding @code{discard},
@code{reverse}, @code{stage-all-changes}, and @code{unstage-all-changes}.

@lisp
(add-to-list 'magit-no-confirm 'safe-with-wip)
@end lisp

For a list of all symbols that can be added to the value of this
variable, see the doc-string.
@end defopt

Note that there are commands that ignore this option and always
require confirmation, or which can be told not to do so using another
dedicated option.  Also most commands, when acting on multiple sections
at once always, require confirmation, even when they do respect this
option when acting on a single section.

@node Running Git
@section Running Git


@menu
* Viewing Git output::
* Running Git manually::
* Git executable::
* Global Git arguments::
@end menu

@node Viewing Git output
@subsection Viewing Git output

Magit runs Git either for side-effects (e.g. when pushing) or to get
some value (e.g. the name of the current branch).  When Git is run for
side-effects then the output goes into a per-repository log buffer,
which can be consulted when things don't go as expected.

@table @asis
@kindex $
@cindex magit-process
@item @kbd{$} @tie{}@tie{}@tie{}@tie{}(@code{magit-process})

This commands displays the process buffer for the current
repository.
@end table

Inside that buffer, the usual key bindings for navigating and showing
sections are available.  There is one additional command.

@table @asis
@kindex k
@cindex magit-process-kill
@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{magit-process-kill})

This command kills the process represented by the section at point.

@end table

@defopt magit-git-debug

When this is non-nil then the output of all calls to git are logged
in the process buffer.  This is useful when debugging, otherwise it
just negatively affects performance.
@end defopt

@node Running Git manually
@subsection Running Git manually

While Magit provides many Emacs commands to interact with Git, it does
not cover everything.  In those cases your existing Git knowledge will
come in handy.  Magit provides some commands for running arbitrary Git
commands by typing them into the minibuffer, instead of having to
switch to a shell.

@table @asis
@kindex !
@cindex magit-run-popup
@item @kbd{!} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-popup})

Show the popup buffer featuring the below suffix commands.

@kindex ! !
@cindex magit-git-command-topdir
@item @kbd{! !} @tie{}@tie{}@tie{}@tie{}(@code{magit-git-command-topdir})

Execute a Git subcommand asynchronously, displaying the output.

With a prefix argument run Git in the root of the current
repository.

@kindex ! :
@cindex magit-git-command
@item @kbd{! :} @tie{}@tie{}@tie{}@tie{}(@code{magit-git-command})

Execute a Git subcommand asynchronously, displaying the output.
Run Git in the top-level directory of the current repository.
@end table

This popup also features some commands that start external gui tools.

@table @asis
@kindex ! g
@cindex magit-run-git-gui
@item @kbd{! g} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-git-gui})

Run @code{git gui} for the current git repository.

@kindex ! k
@cindex magit-run-gitk
@item @kbd{! k} @tie{}@tie{}@tie{}@tie{}(@code{magit-run-gitk})

Run Gitk for the current git repository.

Run @code{gitk --all}.  With a prefix argument run gitk without any
arguments.
@end table

@node Git executable
@subsection Git executable

Except on MS Windows, Magit defaults to running Git without specifying
the path to the git executable.  Instead the first executable found by
Emacs on @code{exec-path} is used (whose value in turn is set based on the
value of the environment variable @code{$PATH} when Emacs was started).

This has the advantage that it continues to work even when using Tramp
to connect to a remote machine on which the executable is found in a
different place.  The downside is that if you have multiple versions
of Git installed, then you might end up using another version than the
one you think you are using.

@table @asis
@kindex M-x magit-version
@cindex magit-version
@item @kbd{M-x magit-version} @tie{}@tie{}@tie{}@tie{}(@code{magit-version})

Shows the currently used versions of Magit, Git, and Emacs in the
echo area.  Non-interactively this just returns the Magit version.
@end table

When the @code{system-type} is @code{windows-nt}, then @code{magit-git-executable} is set
to an absolute path when Magit is first loaded.  This is necessary
because Git on that platform comes with several wrapper scripts for
the actual git binary, which are also placed on @code{$PATH}, and using one
of these wrappers instead of the binary would degrade performance
horribly.

If Magit doesn't find the correct executable then you @strong{can} work around
that by setting @code{magit-git-executable} to an absolute path.  But note
that doing so is a kludge.  It is better to make sure the order in the
environment variable @code{$PATH} is correct, and that Emacs is started with
that environment in effect.  If you have to connect from Windows to a
non-Windows machine, then you must change the value to "git".

@defopt magit-git-executable

The git executable used by Magit, either the full path to the
executable or the string "git" to let Emacs find the executable
itself, using the standard mechanism for doing such things.
@end defopt

@node Global Git arguments
@subsection Global Git arguments

@defopt magit-git-global-arguments

The arguments set here are used every time the git executable is run
as a subprocess.  They are placed right after the executable itself
and before the git command - as in @code{git HERE... COMMAND REST}.  For
valid arguments see 
@ifinfo
@ref{git,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git">git(1)</a> manpage
@end html
@end ifhtml
@iftex
the git(1) manpage
@end iftex
.

Be careful what you add here, especially if you are using Tramp to
connect to servers with ancient Git versions.  Never remove anything
that is part of the default value, unless you really know what you
are doing.  And think very hard before adding something; it will be
used every time Magit runs Git for any purpose.
@end defopt

@node Inspecting
@chapter Inspecting

The functionality provided by Magit can be roughly divided into three
groups: inspecting existing data, manipulating existing data or adding
new data, and transferring data.  Of course that is a rather crude
distinction that often falls short, but it's more useful than no
distinction at all.  This section is concerned with inspecting data,
the next two with manipulating and transferring it.  Then follows a
section about miscellaneous functionality, which cannot easily be fit
into this distinction.

Of course other distinctions make sense too, e.g. Git's distinction
between porcelain and plumbing commands, which for the most part is
equivalent to Emacs' distinction between interactive commands and
non-interactive functions.  All of the sections mentioned before are
mainly concerned with the porcelain -- Magit's plumbing layer is
described later.

@menu
* Status buffer::
* Logging::
* Diffing::
* Ediffing::
* References buffer::
* Bisecting::
* Visiting blobs::
* Blaming::
@end menu

@node Status buffer
@section Status buffer

While other Magit buffers contain e.g. one particular diff or one
particular log, the status buffer contains the diffs for staged and
unstaged changes, logs for unpushed and unpulled commits, lists of
stashes and untracked files, and information related to the current
branch.

During certain incomplete operations -- for example when a merge
resulted in a conflict -- additional information is displayed that
helps proceeding with or aborting the operation.

The command @code{magit-status} displays the status buffer belonging to the
current repository in another window.  This command is used so often
that it should be bound globally.  We recommend using @code{C-x g}:

@lisp
(global-set-key (kbd "C-x g") 'magit-status)
@end lisp

@table @asis
@kindex C-x g
@cindex magit-status
@item @kbd{C-x g} @tie{}@tie{}@tie{}@tie{}(@code{magit-status})

Show the status of the current Git repository in a buffer.
With a prefix argument prompt for a repository to be shown.
With two prefix arguments prompt for an arbitrary directory.
If that directory isn't the root of an existing repository,
then offer to initialize it as a new repository.

@end table

@defopt magit-repository-directories

Directories containing Git repositories.  Magit checks these
directories for Git repositories and offers them as choices when
@code{magit-status} is used with a prefix argument.
@end defopt

@defopt magit-repository-directories-depth

The maximum depth to look for Git repositories.  When looking for
a Git repository below the directories in
@code{magit-repository-directories}, only descend this many levels deep.
@end defopt

@cindex ido-enter-magit-status
@deffn Command ido-enter-magit-status

From an Ido prompt used to open a file, instead drop into
@code{magit-status}.  This is similar to @code{ido-magic-delete-char}, which,
despite its name, usually causes a Dired buffer to be created.

To make this command available, use something like:

@lisp
(add-hook 'ido-setup-hook
          (lambda ()
            (define-key ido-completion-map
              (kbd \"C-x g\") 'ido-enter-magit-status)))
@end lisp

Starting with Emacs 25.1 that keymap can also be customized in a
sane fashion:

@lisp
(define-key ido-completion-map
   (kbd \"C-x g\") 'ido-enter-magit-status)))
@end lisp
@end deffn

@menu
* Status sections::
* Status header sections::
* Status options::
@end menu

@node Status sections
@subsection Status sections

The contents of status buffers is controlled using the hook
@code{magit-status-sections-hook}.  See @ref{Section hooks,Section hooks} to learn about such
hooks and how to customize them.

@defopt magit-status-sections-hook

Hook run to insert sections into a status buffer.
@end defopt

The first function on that hook by default is
@code{magit-insert-status-headers}; it is described in the next section.
By default the following functions are also members of that hook:

@defun magit-insert-merge-log

Insert section for the on-going merge.  Display the heads that are
being merged.  If no merge is in progress, do nothing.
@end defun

@defun magit-insert-rebase-sequence

Insert section for the on-going rebase sequence.
If no such sequence is in progress, do nothing.
@end defun

@defun magit-insert-am-sequence

Insert section for the on-going patch applying sequence.
If no such sequence is in progress, do nothing.
@end defun

@defun magit-insert-sequencer-sequence

Insert section for the on-going cherry-pick or revert sequence.
If no such sequence is in progress, do nothing.
@end defun

@defun magit-insert-bisect-output

While bisecting, insert section with output from @code{git bisect}.
@end defun

@defun magit-insert-bisect-rest

While bisecting, insert section visualizing the bisect state.
@end defun

@defun magit-insert-bisect-log

While bisecting, insert section logging bisect progress.
@end defun

@defun magit-insert-untracked-files

Maybe insert a list or tree of untracked files.
Do so depending on the value of @code{status.showUntrackedFiles}.
@end defun

@defun magit-insert-unstaged-changes

Insert section showing unstaged changes.
@end defun

@defun magit-insert-staged-changes

Insert section showing staged changes.
@end defun

@defun magit-insert-stashes &optional ref heading

Insert the @code{stashes} section showing reflog for "refs/stash".
If optional REF is non-nil show reflog for that instead.
If optional HEADING is non-nil use that as section heading
instead of "Stashes:".
@end defun

@defun magit-insert-unpulled-commits

Insert section showing unpulled commits.
@end defun

@defun magit-insert-unpushed-commits

Insert section showing unpushed commits.
@end defun

The following functions can also be added to the above hook:

@defun magit-insert-tracked-files

Insert a tree of tracked files.
@end defun

@defun magit-insert-unpulled-or-recent-commits

Insert section showing unpulled or recent commits.
If an upstream is configured for the current branch and it is
ahead of the current branch, then show the missing commits.
Otherwise, show the last @code{magit-log-section-commit-count}
commits.
@end defun

@defun magit-insert-recent-commits

Insert section showing the last @code{magit-log-section-commit-count}
commits.
@end defun

@defopt magit-log-section-commit-count

How many recent commits @code{magit-insert-recent-commits} and
@code{magit-insert-unpulled-or-recent-commits} (provided there are no
unpulled commits) show.
@end defopt

@defun magit-insert-unpulled-cherries

Insert section showing unpulled commits.
Like @code{magit-insert-unpulled-commits} but prefix each commit
that has not been applied yet (i.e. a commit with a patch-id
not shared with any local commit) with "+", and all others
with "-".
@end defun

@defun magit-insert-unpulled-module-commits

Insert sections for all submodules with unpulled commits.
These sections can be expanded to show the respective commits.
@end defun

@defun magit-insert-unpushed-cherries

Insert section showing unpushed commits.
Like @code{magit-insert-unpushed-commits} but prefix each commit
which has not been applied to upstream yet (i.e. a commit with
a patch-id not shared with any upstream commit) with "+" and
all others with "-".
@end defun

@defun magit-insert-unpushed-module-commits

Insert sections for all submodules with unpushed commits.
These sections can be expanded to show the respective commits.
@end defun

See @ref{References buffer,References buffer} for some more section inserters, which could be
used here.

@node Status header sections
@subsection Status header sections

The contents of status buffers is controlled using the hook
@code{magit-status-sections-hook}, as described in the previous section.
By default @code{magit-insert-status-headers} is the first member of that
hook variable.

@defun magit-insert-status-headers

Insert headers sections appropriate for @code{magit-status-mode} buffers.
The sections are inserted by running the functions on the hook
@code{magit-status-headers-hook}.
@end defun

@defopt magit-status-headers-hook

Hook run to insert headers sections into the status buffer.

This hook is run by @code{magit-insert-status-headers}, which in turn has
to be a member of @code{magit-insert-status-sections} to be used at all.
@end defopt

By default the following functions are members of the above hook:

@defun magit-insert-head-header

Insert a header line about the @code{HEAD} commit.
@end defun

@defun magit-insert-upstream-header

Insert a header line about the upstream branch and its tip.
@end defun

@defun magit-insert-tags-header

Insert a header line about the current and/or next tag.
@end defun

The following functions can also be added to the above hook:

@defun magit-insert-repo-header

Insert a header line showing the path to the repository top-level.
@end defun

@defun magit-insert-remote-header

Insert a header line about the remote of the current branch.
@end defun

@node Status options
@subsection Status options

@defopt magit-status-refresh-hook

Hook run after a status buffer has been refreshed.
@end defopt

@defopt magit-status-buffer-switch-function

Function used by @code{magit-status} to switch to a status buffer.
The function is given one argument, the status buffer.
@end defopt

@defopt magit-status-buffer-name-format

Name format for buffers used to display a repository's status.

The following @code{format}-like specs are supported:
@code{%a} the absolute filename of the repository top-level.
@code{%b} the basename of the repository top-level.
@end defopt

@defopt magit-log-section-args

Additional Git arguments used when creating log sections.  Only
@code{--graph}, @code{--decorate}, and @code{--show-signature} are supported.  This
option is only a temporary kludge and will be removed.

Note that due to an issue in Git the use of @code{--graph} is very slow
with long histories, so you probably don't want to add this here.
@end defopt

Also see the proceeding section for more options concerning status
buffers.

@node Logging
@section Logging

Also see 
@ifinfo
@ref{git-log,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-log">git-log(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-log(1) manpage
@end iftex
.

@table @asis
@kindex l
@cindex magit-log-popup
@item @kbd{l} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex l l
@cindex magit-log-current
@item @kbd{l l} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-current})

Show log for the current branch.  When @code{HEAD} is detached or with a
prefix argument, show log for one or more revs read from the
minibuffer.

@kindex l o
@cindex magit-log
@item @kbd{l o} @tie{}@tie{}@tie{}@tie{}(@code{magit-log})

Show log for one or more revs read from the minibuffer.  The user
can input any revision or revisions separated by a space, or even
ranges, but only branches, tags, and a representation of the
commit at point are available as completion candidates.

@kindex l h
@cindex magit-log-head
@item @kbd{l h} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-head})

Show log for @code{HEAD}.

@kindex l L
@cindex magit-log-branches
@item @kbd{l L} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-branches})

Show log for all local branches and @code{HEAD}.

@kindex l b
@cindex magit-log-all-branches
@item @kbd{l b} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-all-branches})

Show log for all local and remote branches and @code{HEAD}.

@kindex l a
@cindex magit-log-all
@item @kbd{l a} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-all})

Show log for all references and @code{HEAD}.
@end table

The following related commands are not available from the popup.

@table @asis
@kindex Y
@cindex magit-cherry
@item @kbd{Y} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry})

Show commits in a branch that are not merged in the upstream branch.

@kindex M-x magit-log-buffer-file
@cindex magit-log-buffer-file
@item @kbd{M-x magit-log-buffer-file} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-buffer-file})

Show log for the file visited in the current buffer.
@end table

@menu
* Log Buffer::
* Select from log::
* Reflog::
@end menu

@node Log Buffer
@subsection Log Buffer

@table @asis
@kindex C-c C-b
@cindex magit-go-backward
@item @kbd{C-c C-b} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-backward})

Move backward in current buffer's history.

@kindex C-c C-f
@cindex magit-go-forward
@item @kbd{C-c C-f} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-forward})

Move forward in current buffer's history.

@kindex SPC
@cindex magit-diff-show-or-scroll-up
@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-up})

Update the commit or diff buffer for the thing at point.

Either show the commit or stash at point in the appropriate buffer,
or if that buffer is already being displayed in the current frame
and contains information about that commit or stash, then instead
scroll the buffer up.  If there is no commit or stash at point, then
prompt for a commit.

@kindex DEL
@cindex magit-diff-show-or-scroll-down
@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-down})

Update the commit or diff buffer for the thing at point.

Either show the commit or stash at point in the appropriate buffer,
or if that buffer is already being displayed in the current frame
and contains information about that commit or stash, then instead
scroll the buffer down.  If there is no commit or stash at point,
then prompt for a commit.

@kindex q
@cindex magit-log-bury-buffer
@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-bury-buffer})

Bury the current buffer or the revision buffer in the same frame.
Like @code{magit-mode-bury-buffer} (which see) but with a negative prefix
argument instead bury the revision buffer, provided it is displayed
in the current frame.

@end table

@defopt magit-log-auto-more

Insert more log entries automatically when moving past the last
entry.  Only considered when moving past the last entry with
@code{magit-goto-*-section} commands.
@end defopt

@table @asis
@kindex +
@cindex magit-log-show-more-commits
@item @kbd{+} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-show-more-commits})

Increase the number of commits shown in current log.

With no prefix argument, show twice as many commits as before.
With a numerical prefix argument, show this many additional
commits.  With a non-numeric prefix argument, show all commits.

When no limit was previously imposed in the current buffer, set the
local limit to the default limit instead (or if that is nil then
100), regardless of the prefix argument.

By default @code{magit-log-cutoff-length} commits are shown.

@end table

@defopt magit-log-show-margin

Whether to initially show the margin in log buffers.

When non-nil the author name and date are initially displayed in the
margin of log buffers.  The margin can be shown or hidden in the
current buffer using the command @code{magit-toggle-margin}.

When a log buffer contains a verbose log, then the margin is never
displayed.  In status buffers this option is ignored, but it is
possible to show the margin using the mentioned command.
@end defopt

@table @asis
@kindex L
@cindex magit-toggle-margin
@item @kbd{L} @tie{}@tie{}@tie{}@tie{}(@code{magit-toggle-margin})

Show or hide the Magit margin.

@end table

@defopt magit-log-cutoff-length

The maximum number of commits to show in log and reflog buffers.
@end defopt

@node Select from log
@subsection Select from log

When the user has to select a recent commit that is reachable from
@code{HEAD}, using regular completion would be inconvenient (because most
humans cannot remember hashes or "HEAD~5", at least not without double
checking).  Instead a log buffer is used to select the commit, which
has the advantage that commits are presented in order and with the
commit message.  The following additional key bindings are available
when a log is used for selection:

@table @asis
@kindex C-c C-c
@cindex magit-log-select-pick
@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-select-pick})

Select the commit at point and act on it.  Call
@code{magit-log-select-pick-function} with the selected commit as
argument.

@kindex C-c C-k
@cindex magit-log-select-quit
@item @kbd{C-c C-k} @tie{}@tie{}@tie{}@tie{}(@code{magit-log-select-quit})

Abort selecting a commit, don't act on any commit.
@end table

This feature is used by rebase and squash commands.

@node Reflog
@subsection Reflog

Also see 
@ifinfo
@ref{git-reflog,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-reflog">git-reflog(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-reflog(1) manpage
@end iftex
.

These reflog commands are available from the log popup.  See @ref{Logging,Logging}.

@table @asis
@kindex l r
@cindex magit-reflog-current
@item @kbd{l r} @tie{}@tie{}@tie{}@tie{}(@code{magit-reflog-current})

Display the reflog of the current branch.

@kindex l O
@cindex magit-reflog-other
@item @kbd{l O} @tie{}@tie{}@tie{}@tie{}(@code{magit-reflog-other})

Display the reflog of a branch.

@kindex l H
@cindex magit-reflog-head
@item @kbd{l H} @tie{}@tie{}@tie{}@tie{}(@code{magit-reflog-head})

Display the @code{HEAD} reflog.
@end table

@node Diffing
@section Diffing

Also see 
@ifinfo
@ref{git-diff,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-diff">git-diff(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-diff(1) manpage
@end iftex
.

@table @asis
@kindex d
@cindex magit-diff-popup
@item @kbd{d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex d d
@cindex magit-diff-dwim
@item @kbd{d d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-dwim})

Show changes for the thing at point.

@kindex d r
@cindex magit-diff
@item @kbd{d r} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff})

Show differences between two commits.

RANGE should be a range (A..B or A@dots{}B) but can also be a single
commit.  If one side of the range is omitted, then it defaults to
HEAD.  If just a commit is given, then changes in the working tree
relative to that commit are shown.

@kindex d w
@cindex magit-diff-worktree
@item @kbd{d w} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-worktree})

Show changes between the current working tree and the @code{HEAD} commit.
With a prefix argument show changes between the working tree and a
commit read from the minibuffer.

@kindex d s
@cindex magit-diff-staged
@item @kbd{d s} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-staged})

Show changes between the index and the @code{HEAD} commit.  With a prefix
argument show changes between the index and a commit read from the
minibuffer.

@kindex d u
@cindex magit-diff-unstaged
@item @kbd{d u} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-unstaged})

Show changes between the working tree and the index.

@kindex d p
@cindex magit-diff-paths
@item @kbd{d p} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-paths})

Show changes between any two files on disk.

@kindex d c
@cindex magit-show-commit
@item @kbd{d c} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-commit})

Show the commit at point.  If there is no commit at point or with a
prefix argument, prompt for a commit.

@kindex d t
@cindex magit-stash-show
@item @kbd{d t} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-show})

Show all diffs of a stash in a buffer.

@kindex M-x magit-diff-unpushed
@cindex magit-diff-unpushed
@item @kbd{M-x magit-diff-unpushed} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-unpushed})

Show unpushed changes.

@kindex M-x magit-diff-unpulled
@cindex magit-diff-unpulled
@item @kbd{M-x magit-diff-unpulled} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-unpulled})

Show unpulled changes.
@end table

@menu
* Refreshing diffs::
* Diff buffer::
* Diff options::
* Revision buffer::
@end menu

@node Refreshing diffs
@subsection Refreshing diffs

The @code{magit-diff-popup} described in the previous section is used to
display a log in the current repositories diff buffer.  The following
popup is used to change the arguments used to generate the diff or
diffs in the current buffer, the status buffer or the diff buffer.

In the diff buffer you can of course just use @code{magit-diff-popup}, but
@code{magit-diff-refresh-popup} is more convenient because you don't have to
again specify which differences to show.  In the status buffer this
popup is the only way to change certain arguments.

@table @asis
@kindex D
@cindex magit-diff-refresh-popup
@item @kbd{D} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-refresh-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex D g
@cindex magit-diff-refresh
@item @kbd{D g} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-refresh})

Set the local diff arguments for the current buffer.

@kindex D s
@cindex magit-diff-set-default-arguments
@item @kbd{D s} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-set-default-arguments})

Set the global diff arguments for the current buffer.

@kindex D w
@cindex magit-diff-save-default-arguments
@item @kbd{D w} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-save-default-arguments})

Set and save the global diff arguments for the current buffer.

@kindex D t
@cindex magit-diff-toggle-refine-hunk
@item @kbd{D t} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-toggle-refine-hunk})

Toggle hunk refinement on or off.
@end table

In addition to the above popup, which allow changing any of the
supported arguments, there also exist some commands which change a
particular argument.

@table @asis
@kindex -
@cindex magit-diff-less-context
@item @kbd{-} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-less-context})

Decrease the context for diff hunks by COUNT lines.

@kindex +
@cindex magit-diff-more-context
@item @kbd{+} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-more-context})

Increase the context for diff hunks by COUNT lines.

@kindex 0
@cindex magit-diff-default-context
@item @kbd{0} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-default-context})

Reset context for diff hunks to the default height.
@end table

While all of the above commands change @strong{how} some change is being
displayed without changing @strong{what} change is being displayed, the
following commands do the opposite: they change what is being
displayed but not how.

@table @asis
@kindex C-c C-d
@cindex magit-diff-while-committing
@item @kbd{C-c C-d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-while-committing})

While committing, show the changes that are about to be committed.
While amending, invoking the command again toggles between showing
just the new changes or all the changes that will be committed.

This binding is available in the diff buffer as well as the commit
message buffer.

@kindex C-c C-b
@cindex magit-go-backward
@item @kbd{C-c C-b} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-backward})

Move backward in current buffer's history.

@kindex C-c C-f
@cindex magit-go-forward
@item @kbd{C-c C-f} @tie{}@tie{}@tie{}@tie{}(@code{magit-go-forward})

Move forward in current buffer's history.
@end table

@node Diff buffer
@subsection Diff buffer

@table @asis
@kindex RET
@cindex magit-diff-visit-file
@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-visit-file})

From a diff, visit the corresponding file at the appropriate
position.

When the file is already being displayed in another window of the
same frame, then just select that window and adjust point.  With a
prefix argument also display in another window.

If the diff shows changes in the worktree, the index, or @code{HEAD}, then
visit the actual file.  Otherwise when the diff is about an older
commit, then visit the respective blob using @code{magit-find-file}.  Also
see @code{magit-diff-visit-file-worktree}, which, as the name suggests,
always visits the actual file.

@kindex C-<return>
@cindex magit-diff-visit-file-worktree
@item @kbd{C-<return>} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-visit-file-worktree})

From a diff, visit the corresponding file at the appropriate position.

When the file is already being displayed in another window of the
same frame, then just select that window and adjust point.  With
a prefix argument also display in another window.

The actual file in the worktree is visited. The positions in the
hunk headers get less useful the "older" the changes are, and as a
result, jumping to the appropriate position gets less reliable.

Also see @code{magit-diff-visit-file-worktree}, which visits the respective
blob, unless the diff shows changes in the worktree, the index, or
@code{HEAD}.

@kindex j
@cindex magit-jump-to-diffstat-or-diff
@item @kbd{j} @tie{}@tie{}@tie{}@tie{}(@code{magit-jump-to-diffstat-or-diff})

Jump to the diffstat or diff.  When point is on a file inside the
diffstat section, then jump to the respective diff section.
Otherwise, jump to the diffstat section or a child thereof.

@kindex SPC
@cindex scroll-up
@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{scroll-up})

Scroll text upward.

@kindex DEL
@cindex scroll-down
@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{scroll-down})

Scroll text downward.
@end table

@node Diff options
@subsection Diff options

@defopt magit-diff-show-diffstat

Whether to show diffstat in diff buffers.
@end defopt

@defopt magit-diff-show-xref-buttons

Whether to show buffer history buttons in diff buffers.
@end defopt

@defopt magit-diff-auto-show

Whether to automatically show the relevant diff or commit.

When this option is non-nil certain operations cause the relevant
changes to be displayed automatically.

@itemize
@item
@code{commit}

@item
@code{stage-all}

@item
@code{log-oneline}

@item
@code{log-follow}

@item
@code{log-select}

@item
@code{blame-follow}
@end itemize
In the event that expanding very large patches takes a long time, @code{C-g}
can be used to abort that step.  This is especially useful when you
would normally not look at the changes, e.g. because you are
committing some binary files.
@end defopt

@defopt magit-diff-refine-hunk

Whether to show word-granularity differences within diff hunks.

@itemize
@item
@code{nil} never show fine differences.

@item
@code{t} show fine differences for the current diff hunk only.

@item
@code{all} show fine differences for all displayed diff hunks.
@end itemize
@end defopt

@defopt magit-diff-paint-whitespace

Specify where to highlight whitespace errors.

See @code{magit-highlight-trailing-whitespace},
@code{magit-highlight-indentation}.  The symbol @code{t} means in all diffs,
@code{status} means only in the status buffer, and nil means nowhere.
@end defopt

@defopt magit-diff-highlight-trailing

Whether to highlight whitespace at the end of a line in diffs.  Used
only when @code{magit-diff-paint-whitespace} is non-nil.
@end defopt

@defopt magit-diff-highlight-indentation

Highlight the "wrong" indentation style.  Used only when
@code{magit-diff-paint-whitespace} is non-nil.

The value is a list of cons cells.  The car is a regular expression,
and the cdr is the value that applies to repositories whose
directory matches the regular expression.  If more than one element
matches, then the @strong{last} element in the list applies.  The default
value should therefore come first in the list.

If the value is @code{tabs}, highlight indentation with tabs.  If the value
is an integer, highlight indentation with at least that many spaces.
Otherwise, highlight neither.
@end defopt

@node Revision buffer
@subsection Revision buffer

@defopt magit-revision-show-diffstat

Whether to show diffstat in revision buffers.
@end defopt

@defopt magit-revision-show-notes

Whether to show notes in revision buffers.
@end defopt

@defopt magit-revision-show-xref-buttons

Whether to show buffer history buttons in revision buffers.
@end defopt

@defopt magit-revision-insert-related-refs

Whether to show related refs in revision buffers.
@end defopt

@node Ediffing
@section Ediffing

@table @asis
@kindex e
@cindex magit-ediff-dwim
@item @kbd{e} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-dwim})

Compare, stage, or resolve using Ediff.

This command tries to guess what file, and what commit or range the
user wants to compare, stage, or resolve using Ediff.  It might only
be able to guess either the file, or range/commit, in which case
the user is asked about the other.  It might not always guess right,
in which case the appropriate @code{magit-ediff-*} command has to be used
explicitly.  If it cannot read the user's mind at all, then it asks
the user for a command to run.

@kindex E
@cindex magit-ediff-popup
@item @kbd{E} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-popup})

This prefix commands shows the following suffix commands in a popup
buffer.

@kindex E d
@cindex magit-ediff-compare
@item @kbd{E d} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-compare})

Compare two revisions of a file using Ediff, defaulting to the file
at point.

@kindex E m
@cindex magit-ediff-resolve
@item @kbd{E m} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-resolve})

Resolve outstanding conflicts in a file using Ediff, defaulting to
the file at point.

In the rare event that you want to manually resolve all conflicts,
including those already resolved by Git, use
@code{ediff-merge-revisions-with-ancestor}.

@kindex E s
@cindex magit-ediff-stage
@item @kbd{E s} @tie{}@tie{}@tie{}@tie{}(@code{magit-ediff-stage})

Stage and unstage changes to a file using Ediff, defaulting to the
file at point.
@end table

@node References buffer
@section References buffer

@table @asis
@kindex y
@cindex magit-show-refs-popup
@item @kbd{y} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs-popup})

List and compare references in a dedicated buffer.  By default all
refs are compared with @code{HEAD}, but with a prefix argument this command
instead acts as a prefix command and shows the following suffix
commands along with the appropriate infix arguments in a popup
buffer.

@kindex y y
@cindex magit-show-refs-head
@item @kbd{y y} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs-head})

List and compare references in a dedicated buffer.  Refs are
compared with @code{HEAD}.

@kindex y c
@cindex magit-show-refs-current
@item @kbd{y c} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs-current})

List and compare references in a dedicated buffer.  Refs are
compared with the current branch or @code{HEAD} if it is detached.

@kindex y o
@cindex magit-show-refs
@item @kbd{y o} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-refs})

List and compare references in a dedicated buffer.  Refs are
compared with a branch read from the user.

@end table

@defopt magit-refs-show-commit-count

Whether to show commit counts in Magit-Refs mode buffers.

@itemize
@item
@verb{~all~} Show counts for branches and tags.

@item
@code{branch} Show counts for branches only.

@item
@code{nil} Never show counts.
@end itemize
The default is @code{nil} because anything else can be very expensive.
@end defopt

@defopt magit-refs-show-margin

Whether to initially show the margin in refs buffers.

When non-nil the committer name and date are initially displayed in
the margin of refs buffers.  The margin can be shown or hidden in
the current buffer using the command @code{magit-toggle-margin}.
@end defopt

The following variables control how individual refs are displayed.  If
you change one of these variables (especially the "%c" part), then you
should also change the others to keep things aligned.  The following
%-sequences are supported:

@itemize
@item
@code{%a} Number of commits this ref has over the one we compare to.

@item
@code{%b} Number of commits the ref we compare to has over this one.

@item
@code{%c} Number of commits this ref has over the one we compare to.  For
the ref which all other refs are compared this is instead "@@", if
it is the current branch, or "#" otherwise.

@item
@code{%C} For the ref which all other refs are compared this is "@@", if it
is the current branch, or "#" otherwise.  For all other refs " ".

@item
@code{%h} Hash of this ref's tip.

@item
@code{%m} Commit summary of the tip of this ref.

@item
@code{%n} Name of this ref.

@item
@code{%u} Upstream of this local branch and additional local vs. upstream
information.

@item
@code{%U} Upstream of this local branch.

@end itemize

@defvar magit-refs-local-branch-format

Format used for local branches in refs buffers.
@end defvar

@defvar magit-refs-remote-branch-format

Format used for remote branches in refs buffers.
@end defvar

@defvar magit-refs-tags-format

Format used for tags in refs buffers.
@end defvar

@defvar magit-refs-indent-cherry-lines

Indentation of cherries in refs buffers.  This should be N-1 where N
is taken from "%Nc" in the above format strings.
@end defvar

@menu
* References sections::
@end menu

@node References sections
@subsection References sections

The contents of references buffers is controlled using the hook
@code{magit-refs-sections-hook}.  See @ref{Section hooks,Section hooks} to learn about such hooks
and how to customize them.  All of the below functions are members of
the default value.  Note that it makes much less sense to customize
this hook than it does for the respective hook used for the status
buffer.

@defopt magit-refs-sections-hook

Hook run to insert sections into a references buffer.
@end defopt

@defun magit-insert-local-branches

Insert sections showing all local branches.
@end defun

@defun magit-insert-remote-branches

Insert sections showing all remote-tracking branches.
@end defun

@defun magit-insert-tags

Insert sections showing all tags.
@end defun

@node Bisecting
@section Bisecting

Also see 
@ifinfo
@ref{git-bisect,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-bisect">git-bisect(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-bisect(1) manpage
@end iftex
.

@table @asis
@kindex B
@cindex magit-bisect-popup
@item @kbd{B} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-popup})

This prefix commands shows the following suffix commands in a
popup buffer.
@end table

When bisecting is not in progress, then the popup buffer features the
following commands.

@table @asis
@kindex B s
@cindex magit-bisect-start
@item @kbd{B s} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-start})

Start a bisect session.

Bisecting a bug means to find the commit that introduced it.
This command starts such a bisect session by asking for a known
good and a bad commit.

@kindex B u
@cindex magit-bisect-run
@item @kbd{B u} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-run})

Bisect automatically by running commands after each step.
@end table

When bisecting is in progress, then the popup buffer features these
commands instead.

@table @asis
@kindex B b
@cindex magit-bisect-bad
@item @kbd{B b} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-bad})

Mark the current commit as bad.  Use this after you have asserted
that the commit does contain the bug in question.

@kindex B g
@cindex magit-bisect-good
@item @kbd{B g} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-good})

Mark the current commit as good.  Use this after you have asserted
that the commit does not contain the bug in question.

@kindex B k
@cindex magit-bisect-skip
@item @kbd{B k} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-skip})

Skip the current commit.  Use this if for some reason the current
commit is not a good one to test.  This command lets Git choose a
different one.

@kindex B r
@cindex magit-bisect-reset
@item @kbd{B r} @tie{}@tie{}@tie{}@tie{}(@code{magit-bisect-reset})

After bisecting, cleanup bisection state and return to original
@code{HEAD}.
@end table

@node Visiting blobs
@section Visiting blobs

@table @asis
@kindex M-x magit-find-file
@cindex magit-find-file
@item @kbd{M-x magit-find-file} @tie{}@tie{}@tie{}@tie{}(@code{magit-find-file})

View FILE from REV.  Switch to a buffer visiting blob REV:FILE,
creating one if none already exists.

@kindex M-x magit-find-file-other-window
@cindex magit-find-file-other-window
@item @kbd{M-x magit-find-file-other-window} @tie{}@tie{}@tie{}@tie{}(@code{magit-find-file-other-window})

View FILE from REV, in another window.  Like @code{magit-find-file}, but
create a new window or reuse an existing one.
@end table

@node Blaming
@section Blaming

Also see 
@ifinfo
@ref{git-blame,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-blame">git-blame(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-blame(1) manpage
@end iftex
.

@table @asis
@kindex M-x magit-blame
@cindex magit-blame
@item @kbd{M-x magit-blame} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame})

Display edit history of FILE up to REVISION.

Interactively blame the file being visited in the current buffer.
If the buffer visits a revision of that file, then blame up to that
revision.  Otherwise, blame the file's full history, including
uncommitted changes.

If Magit-Blame mode is already turned on then blame recursively, by
visiting REVISION:FILE (using @code{magit-find-file}), where revision is
the revision before the revision that added the lines at point.

ARGS is a list of additional arguments to pass to @code{git blame}; only
arguments available from @code{magit-blame-popup} should be used.

@kindex M-x magit-blame-popup
@cindex magit-blame-popup
@item @kbd{M-x magit-blame-popup} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-popup})

By default this behaves just like @code{magit-blame}.  With a prefix
argument instead show a popup buffer featuring a few infix arguments
and a single suffix command (@code{magit-blame}).

@kindex RET
@cindex magit-show-commit
@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{magit-show-commit})

Show the commit at point.  If there is no commit at point or with a
prefix argument, prompt for a commit.

@kindex SPC
@cindex magit-diff-show-or-scroll-up
@item @kbd{SPC} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-up})

Update the commit or diff buffer for the thing at point.

Either show the commit or stash at point in the appropriate buffer,
or if that buffer is already being displayed in the current frame
and contains information about that commit or stash, then instead
scroll the buffer up.  If there is no commit or stash at point, then
prompt for a commit.

@kindex DEL
@cindex magit-diff-show-or-scroll-down
@item @kbd{DEL} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-show-or-scroll-down})

Update the commit or diff buffer for the thing at point.

Either show the commit or stash at point in the appropriate buffer,
or if that buffer is already being displayed in the current frame
and contains information about that commit or stash, then instead
scroll the buffer down.  If there is no commit or stash at point,
then prompt for a commit.

@kindex n
@cindex magit-blame-next-chunk
@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-next-chunk})

Move to the next chunk.

@kindex N
@cindex magit-blame-next-chunk-same-commit
@item @kbd{N} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-next-chunk-same-commit})

Move to the next chunk from the same commit.

@kindex p
@cindex magit-blame-previous-chunk
@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-previous-chunk})

Move to the previous chunk.

@kindex P
@cindex magit-blame-previous-chunk-same-commit
@item @kbd{P} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-previous-chunk-same-commit})

Move to the previous chunk from the same commit.

@kindex q
@cindex magit-blame-quit
@item @kbd{q} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-quit})

Turn off Magit-Blame mode.  If the buffer was created during a
recursive blame, then also kill the buffer.

@kindex t
@cindex magit-blame-toggle-headings
@item @kbd{t} @tie{}@tie{}@tie{}@tie{}(@code{magit-blame-toggle-headings})

Show or hide blame chunk headings.

@end table

@defopt magit-blame-heading-format

Format string used for blame headings.
@end defopt

@defopt magit-blame-time-format

Format string used for time strings in blame headings.
@end defopt

@defopt magit-blame-show-headings

Whether to initially show blame block headings.  The headings can
also be toggled locally using command @verb{~magit-blame-toggle-headings~}.
@end defopt

@defopt magit-blame-goto-chunk-hook

Hook run by @code{magit-blame-next-chunk} and @code{magit-blame-previous-chunk}.
@end defopt

@node Manipulating
@chapter Manipulating


@menu
* Repository setup::
* Staging and unstaging::
* Applying::
* Committing::
* Branching::
* Merging::
* Rebasing::
* Cherry picking::
* Resetting::
* Stashing::
@end menu

@node Repository setup
@section Repository setup

@table @asis
@kindex M-x magit-init
@cindex magit-init
@item @kbd{M-x magit-init} @tie{}@tie{}@tie{}@tie{}(@code{magit-init})

Initialize a Git repository, then show its status.

If the directory is below an existing repository, then the user has
to confirm that a new one should be created inside.  If the
directory is the root of the existing repository, then the user has
to confirm that it should be reinitialized.

@kindex M-x magit-clone
@cindex magit-clone
@item @kbd{M-x magit-clone} @tie{}@tie{}@tie{}@tie{}(@code{magit-clone})

Clone a repository.  The user is queried for a remote url and a
local directory.
@end table

@node Staging and unstaging
@section Staging and unstaging

Like Git, Magit can of course stage and unstage complete files.
Unlike Git, it also allows users to gracefully un-/stage
individual hunks and even just part of a hunk.  To stage individual
hunks and parts of hunks using Git directly, one has to use the very
modal and rather clumsy interface of a @code{git add --interactive} session.

With Magit, on the other hand, one can un-/stage individual hunks by
just moving point into the respective section inside a diff displayed
in the status buffer or a separate diff buffer and typing @code{s} or @code{u}.  To
operate on just parts of a hunk, mark the changes that should be
un-/staged using the region and then press the same key that would be
used to un-/stage.  To stage multiple files or hunks at once use a
region that starts inside the heading of such a section and ends
inside the heading of a sibling section of the same type.

Besides staging and unstaging, Magit also provides several other
"apply variants" that can also operate on a file, multiple files at
once, a hunk, multiple hunks at once, and on parts of a hunk.  These
apply variants are described in the next section.

@table @asis
@kindex s
@cindex magit-stage
@item @kbd{s} @tie{}@tie{}@tie{}@tie{}(@code{magit-stage})

Add the change at point to the staging area.

@kindex S
@cindex magit-stage-modified
@item @kbd{S} @tie{}@tie{}@tie{}@tie{}(@code{magit-stage-modified})

Stage all changes to files modified in the worktree.  Stage all new
content of tracked files and remove tracked files that no longer
exist in the working tree from the index also.  With a prefix
argument also stage previously untracked (but not ignored) files.

@kindex u
@cindex magit-unstage
@item @kbd{u} @tie{}@tie{}@tie{}@tie{}(@code{magit-unstage})

Remove the change at point from the staging area.

@kindex U
@cindex magit-reset-index
@item @kbd{U} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-index})

Reset the index to some commit.  The commit is read from the user
and defaults to the commit at point.  If there is no commit at
point, then it defaults to @code{HEAD}.

So @code{U RET} with no commit at point does the inverse of @code{S} (or actually
@code{S yes RET}), i.e. "unstage all staged changes".  If you would rather
use a command which always does just that, then rebind @code{U} to
@code{magit-unstage-all}.

@kindex M-x magit-unstage-all
@cindex magit-unstage-all
@item @kbd{M-x magit-unstage-all} @tie{}@tie{}@tie{}@tie{}(@code{magit-unstage-all})

Remove all changes from the staging area.
@end table

@menu
* Staging from file-visiting buffers::
@end menu

@node Staging from file-visiting buffers
@subsection Staging from file-visiting buffers

Fine-grained un-/staging has to be done from the status or a diff
buffer, but it's also possible to un-/stage all changes made to the
file visited in the current buffer right from inside that buffer.

@table @asis
@kindex M-x magit-stage-file
@cindex magit-stage-file
@item @kbd{M-x magit-stage-file} @tie{}@tie{}@tie{}@tie{}(@code{magit-stage-file})

When invoked inside a file-visiting buffer, then stage all changes
to that file.  In a Magit buffer, stage the file at point if any.
Otherwise prompt for a file to be staged.  With a prefix argument
always prompt the user for a file, even in a file-visiting buffer or
when there is a file section at point.

@kindex M-x magit-unstage-file
@cindex magit-unstage-file
@item @kbd{M-x magit-unstage-file} @tie{}@tie{}@tie{}@tie{}(@code{magit-unstage-file})

When invoked inside a file-visiting buffer, then unstage all changes
to that file.  In a Magit buffer, unstage the file at point if any.
Otherwise prompt for a file to be unstaged.  With a prefix argument
always prompt the user for a file, even in a file-visiting buffer or
when there is a file section at point.
@end table

@node Applying
@section Applying

Magit provides several "apply variants": stage, unstage, discard,
reverse, and "regular apply".  At least when operating on a hunk they
are all implemented using @code{git apply}, which is why they are called
"apply variants".

@itemize
@item
Stage.  Apply a change from the working tree to the index.  The change
also remains in the working tree.


@item
Unstage.  Remove a change from the index.  The change remains in the
working tree.


@item
Discard.  On a staged change, remove it from the working tree and the
index.  On an unstaged change, remove it from the working tree only.


@item
Reverse.  Reverse a change in the working tree.  Both committed and
staged changes can be reversed.  Unstaged changes cannot be
reversed.  Discard them instead.


@item
Apply.  Apply a change to the working tree.  Both committed and staged
changes can be applied.  Unstaged changes cannot be applied - as
they already have been applied.
@end itemize

The previous section described the staging and unstaging commands.
What follows are the commands which implement the remaining apply
variants.

@table @asis
@kindex a
@cindex magit-apply
@item @kbd{a} @tie{}@tie{}@tie{}@tie{}(@code{magit-apply})

Apply the change at point to the working tree.  With a prefix argument
and if necessary, attempt a 3-way merge.

@kindex k
@cindex magit-discard
@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{magit-discard})

Remove the change at point from the working tree.

@kindex v
@cindex magit-reverse
@item @kbd{v} @tie{}@tie{}@tie{}@tie{}(@code{magit-reverse})

Reverse the change at point in the working tree.
@end table

@node Committing
@section Committing

When the user initiates a commit, Magit calls @code{git commit} without any
arguments, so Git has to get it from the user.  It creates the file
@code{.git/COMMIT_EDITMSG} and then opens that file in an editor.  Magit
arranges for that editor to be the Emacsclient.  Once the user
finishes the editing session, the Emacsclient exits and Git creates the
commit using the file's content as message.

@menu
* Initiating a commit::
* Editing commit messages::
@end menu

@node Initiating a commit
@subsection Initiating a commit

Also see 
@ifinfo
@ref{git-commit,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-commit">git-commit(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-commit(1) manpage
@end iftex
.

@table @asis
@kindex c
@cindex magit-commit-popup
@item @kbd{c} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex c c
@cindex magit-commit
@item @kbd{c c} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit})

Create a new commit on @code{HEAD}.  With a prefix argument amend to the
commit at @code{HEAD} instead.

@kindex c a
@cindex magit-commit-amend
@item @kbd{c a} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-amend})

Amend the last commit.

@kindex c e
@cindex magit-commit-extend
@item @kbd{c e} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-extend})

Amend the last commit, without editing the message.  With a prefix
argument change the committer date.  The option
@code{magit-commit-extend-override-date} can be used to inverse the
meaning of the prefix argument.

@kindex c r
@cindex magit-commit-reword
@item @kbd{c r} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-reword})

Reword the last commit, ignoring staged changes.

With a prefix argument change the committer date.  The option
@code{magit-commit-rewrite-override-date} can be used to inverse the
meaning of the prefix argument.

Non-interactively respect the optional OVERRIDE-DATE argument and
ignore the option.

@kindex c f
@cindex magit-commit-fixup
@item @kbd{c f} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-fixup})

Create a fixup commit.  With a prefix argument the target commit has
to be confirmed.  Otherwise the commit at point may be used without
confirmation depending on the value of option
@code{magit-commit-squash-confirm}.

@kindex c F
@cindex magit-commit-instant-fixup
@item @kbd{c F} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-instant-fixup})

Create a fixup commit and instantly rebase.

@kindex c s
@cindex magit-commit-squash
@item @kbd{c s} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-squash})

Create a squash commit.  With a prefix argument the target commit
has to be confirmed.  Otherwise the commit at point may be used
without confirmation depending on the value of option
@code{magit-commit-squash-confirm}.

@kindex c S
@cindex magit-commit-instant-squash
@item @kbd{c S} @tie{}@tie{}@tie{}@tie{}(@code{magit-commit-instant-squash})

Create a squash commit and instantly rebase.

@end table

@defopt magit-commit-ask-to-stage

Whether to ask to stage everything when committing and nothing is
staged.
@end defopt

@defopt magit-commit-extend-override-date

Whether using @code{magit-commit-extend} changes the committer date.
@end defopt

@defopt magit-commit-reword-override-date

Whether using @code{magit-commit-reword} changes the committer date.
@end defopt

@defopt magit-commit-squash-confirm

Whether the commit targeted by squash and fixup has to be confirmed.
When non-nil then the commit at point (if any) is used as default
choice.  Otherwise it has to be confirmed.  This option only affects
@code{magit-commit-squash} and @code{magit-commit-fixup}.  The "instant" variants
always require confirmation because making an error while using
those is harder to recover from.
@end defopt

@node Editing commit messages
@subsection Editing commit messages

After initiating a commit as described in the previous section, two new
buffers appear.  One shows the changes that are about to committed,
while the other is used to write the message.  All regular editing
commands are available in the commit message buffer.  This section
only describes the additional commands.

Commit messages are edited in an edit session - in the background Git
is waiting for the editor, in our case the Emacsclient, to save the
commit message in a file (in most cases @code{.git/COMMIT_EDITMSG}) and then
return.  If the Emacsclient returns with a non-zero exit status then
Git does not create the commit.  So the most important commands are
those for finishing and aborting the commit.

@table @asis
@kindex C-c C-c
@cindex with-editor-finish
@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-finish})

Finish the current editing session by returning with exit code 0.
Git then creates the commit using the message it finds in the file.

@kindex C-c C-k
@cindex with-editor-cancel
@item @kbd{C-c C-k} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-cancel})

Cancel the current editing session by returning with exit code 1.
Git then cancels the commit, but leaves the file untouched.
@end table

In additon to being used by Git, these messages may also be stored in
a ring that persists until Emacs is closed.  By default the message is
stored at the beginning and the end of an edit session (regardless of
whether the session is finished successfully or was canceled).  It is
sometimes useful to bring back messages from that ring.

@table @asis
@kindex C-s M-s
@cindex git-commit-save-message
@item @kbd{C-s M-s} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-save-message})

Save the current buffer content to the commit message ring.

@kindex M-p
@cindex git-commit-prev-message
@item @kbd{M-p} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-prev-message})

Cycle backward through the commit message ring, after saving the
current message to the ring.  With a numeric prefix ARG, go back
ARG comments.

@kindex M-n
@cindex git-commit-next-message
@item @kbd{M-n} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-next-message})

Cycle forward through the commit message ring, after saving the
current message to the ring.  With a numeric prefix ARG, go back
ARG comments.
@end table

By default the diff for the changes that are about to be committed are
automatically shown when invoking the commit.  When amending to an
existing commit it may be useful to show either the changes that are
about to be added to that commit or to show those changes together
with those that are already committed.

@table @asis
@kindex C-c C-d
@cindex magit-diff-while-committing
@item @kbd{C-c C-d} @tie{}@tie{}@tie{}@tie{}(@code{magit-diff-while-committing})

While committing, show the changes that are about to be committed.
While amending, invoking the command again toggles between showing
just the new changes or all the changes that will be committed.
@end table

Some projects use pseudo headers in commit messages.  Magit colorizes
such headers and provides some commands to insert such headers.

@defopt git-commit-known-pseudo-headers

A list of Git pseudo headers to be highlighted.
@end defopt

@table @asis
@kindex C-c C-a
@cindex git-commit-ack
@item @kbd{C-c C-a} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-ack})

Insert a header acknowledging that you have looked at the commit.

@kindex C-c C-r
@cindex git-commit-review
@item @kbd{C-c C-r} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-review})

Insert a header acknowledging that you have reviewed the commit.

@kindex C-c C-s
@cindex git-commit-signoff
@item @kbd{C-c C-s} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-signoff})

Insert a header to sign off the commit.

@kindex C-c C-t
@cindex git-commit-test
@item @kbd{C-c C-t} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-test})

Insert a header acknowledging that you have tested the commit.

@kindex C-c C-o
@cindex git-commit-cc
@item @kbd{C-c C-o} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-cc})

Insert a header mentioning someone who might be interested.

@kindex C-c C-p
@cindex git-commit-reported
@item @kbd{C-c C-p} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-reported})

Insert a header mentioning the person who reported the issue being
fixed by the commit.

@kindex C-c C-i
@cindex git-commit-suggested
@item @kbd{C-c C-i} @tie{}@tie{}@tie{}@tie{}(@code{git-commit-suggested})

Insert a header mentioning the person who suggested the change.
@end table

@code{git-commit-mode} is a minor mode that is only used to establish
the above key bindings.  This allows using an arbitrary major mode
when editing the commit message.  It's even possible to use a
different major mode in different repositories, which is useful when
different projects impose different commit message conventions.

@defopt git-commit-major-mode

The value of this option is the major mode used to edit Git commit
messages.
@end defopt

Because @code{git-commit-mode} is a minor mode, we don't use its mode hook
to setup the buffer, except for the key bindings.  All other setup
happens in the function @code{git-commit-setup}, which among other things runs
the hook @code{git-commit-setup-hook}.  The following functions are suitable
for that hook.

@defopt git-commit-setup-hook

Hook run at the end of @code{git-commit-setup}.
@end defopt

@defun magit-revert-buffers &optional force

Revert unmodified file-visiting buffers of the current repository.

If either @code{magit-revert-buffers} is non-nil and @code{inhibit-magit-revert}
is nil, or if optional FORCE is non-nil, then revert all unmodified
buffers that visit files being tracked in the current repository.
@end defun

@defun git-commit-save-message

Save the current buffer content to the commit message ring.
@end defun

@defun git-commit-setup-changelog-support

After this function is called, ChangeLog entries are treated as
paragraphs.
@end defun

@defun git-commit-turn-on-auto-fill

Turn on @code{auto-fill-mode} and set @code{fill-column} to the value of
@code{git-commit-fill-column}.
@end defun

@defun git-commit-turn-on-flyspell

Turn on Flyspell mode.  Also prevent comments from being checked and
finally check current non-comment text.
@end defun

@defun git-commit-propertize-diff

Propertize the diff shown inside the commit message buffer.  Git
inserts such diffs into the commit message template when the
@code{--verbose} argument is used.  Magit's commit popup by default does
not offer that argument because the diff that is shown in a separate
buffer is more useful.  But some users disagree, which is why this
function exists.
@end defun

@defun with-editor-usage-message

Show usage information in the echo area.
@end defun

Magit also helps with writing @strong{good} commit messages by complaining when
certain rules are violated.

@defopt git-commit-summary-max-length

The intended maximal length of the summary line of commit messages.
Characters beyond this column are colorized to indicate that this
preference has been violated.
@end defopt

@defopt git-commit-fill-column

Column beyond which automatic line-wrapping should happen in commit
message buffers.
@end defopt

@defopt git-commit-finish-query-functions

List of functions called to query before performing commit.

The commit message buffer is current while the functions are called.
If any of them returns nil, then the commit is not performed and the
buffer is not killed.  The user should then fix the issue and try
again.

The functions are called with one argument.  If it is non-nil then
that indicates that the user used a prefix argument to force
finishing the session despite issues.  Functions should usually
honor this wish and return non-nil.
@end defopt

@defun git-commit-check-style-conventions

Check for violations of certain basic style conventions.  For each
violation ask the user if she wants to proceed anyway.  This makes
sure the summary line isn't too long and that the second line is
empty.
@end defun

To show no diff while committing remove @code{magit-commit-diff} from
@code{server-switch-hook}.

@node Branching
@section Branching

Also see 
@ifinfo
@ref{git-branch,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-branch">git-branch(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-branch(1) manpage
@end iftex
 and 
@ifinfo
@ref{git-checkout,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-checkout">git-checkout(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-checkout(1) manpage
@end iftex
.

@table @asis
@kindex b
@cindex magit-branch-popup
@item @kbd{b} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex b b
@cindex magit-checkout
@item @kbd{b b} @tie{}@tie{}@tie{}@tie{}(@code{magit-checkout})

Checkout a revision read in the minibuffer and defaulting to the
branch or arbitrary revision at point.  If the revision is a local
branch then that becomes the current branch.  If it is something
else then @code{HEAD} becomes detached.  Checkout fails if the working tree
or the staging area contain changes.

@kindex b c
@cindex magit-branch
@item @kbd{b c} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch})

Create a new branch.  The user is asked for a branch or arbitrary
revision to use as the starting point of the new branch.  When a
branch name is provided, then that becomes the upstream branch of
the new branch.  The name of the new branch is also read in the
minibuffer.

@kindex b B
@cindex magit-branch-and-checkout
@item @kbd{b B} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-and-checkout})

This command creates a new branch like @code{magit-branch}, but then also
checks it out.

@kindex b d
@cindex magit-branch-delete
@item @kbd{b d} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-delete})

Delete one or multiple branches.  If the region marks multiple
branches, then offer to delete those.  Otherwise, prompt for a single
branch to be deleted, defaulting to the branch at point.

@kindex b u
@cindex magit-branch-set-upstream
@item @kbd{b u} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-set-upstream})

Change the upstream branch of a branch.  Both branches are read in
the minibuffer, while providing reasonable defaults.

@kindex b U
@cindex magit-branch-unset-upstream
@item @kbd{b U} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-unset-upstream})

Unset the upstream branch of a branch read in the minibuffer and
defaulting to the branch at point or the current branch.

@kindex b r
@cindex magit-branch-rename
@item @kbd{b r} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-rename})

Rename a branch.  The branch and the new name are read in the
minibuffer.  With prefix argument the branch is renamed even if that
name conflicts with an existing branch.

@kindex b e
@cindex magit-branch-edit-description
@item @kbd{b e} @tie{}@tie{}@tie{}@tie{}(@code{magit-branch-edit-description})

Edit the description of a branch.  The branch is read in the
minibuffer defaulting to the branch at point or the current branch.
The description is edited in a regular buffer similar to how commit
messages are edited.
@end table

@node Merging
@section Merging

Also see 
@ifinfo
@ref{git-merge,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-merge">git-merge(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-merge(1) manpage
@end iftex
.

@table @asis
@kindex m
@cindex magit-merge-popup
@item @kbd{m} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.
@end table

When no merge is in progress, then the popup buffer features the
following commands.

@table @asis
@kindex m m
@cindex magit-merge
@item @kbd{m m} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge})

Merge another branch or an arbitrary revision into the current
branch.  The branch or revision to be merged is read in the
minibuffer and defaults to the one at point.

Unless there are conflicts or a prefix argument is used, the
resulting merge commit uses a generic commit message, and the user
does not get a chance to inspect or change it before the commit is
created.  With a prefix argument this does not actually create the
merge commit, which makes it possible to inspect how conflicts were
resolved and to adjust the commit message.

@kindex m e
@cindex magit-merge-editmsg
@item @kbd{m e} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-editmsg})

Merge another branch or an arbitrary revision into the current
branch and open a commit message buffer, so that the user can make
adjustments.  The commit is not actually created until the user
finishes with @code{C-c C-c}.

@kindex m n
@cindex magit-merge-nocommit
@item @kbd{m n} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-nocommit})

Merge another branch or an arbitrary revision into the current
branch, but do not actually create the commit.  The user can then
further adjust the merge, even when automatic conflict resolution
succeeded and/or adjust the commit message.

@kindex m p
@cindex magit-merge-preview
@item @kbd{m p} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-preview})

Preview result of merging another branch or an arbitrary revision
into the current branch.
@end table

When a merge is in progress, then the popup buffer features these
commands instead.

@table @asis
@kindex m m
@cindex magit-merge
@item @kbd{m m} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge})

After resolving conflicts, proceed with the merge.  If there are
still conflicts, then this fails.

@kindex m a
@cindex magit-merge-abort
@item @kbd{m a} @tie{}@tie{}@tie{}@tie{}(@code{magit-merge-abort})

Abort the current merge operation.
@end table

@node Rebasing
@section Rebasing

Also see 
@ifinfo
@ref{git-rebase,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-rebase">git-rebase(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-rebase(1) manpage
@end iftex
.

@table @asis
@kindex r
@cindex magit-rebase-popup
@item @kbd{r} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.
@end table

When no rebase is in progress, then the popup buffer features the
following commands.

@table @asis
@kindex r r
@cindex magit-rebase
@item @kbd{r r} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase})

Start a non-interactive rebase sequence.  All commits not in
UPSTREAM are rebased.

@kindex r o
@cindex magit-rebase-from
@item @kbd{r o} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-from})

Start a non-interactive rebase sequence with commits from START to
@code{HEAD} onto NEWBASE.  START has to be selected from a list of recent
commits.

@kindex r e
@cindex magit-rebase-interactive
@item @kbd{r e} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-interactive})

Start an interactive rebase sequence.

@kindex r f
@cindex magit-rebase-autosquash
@item @kbd{r f} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-autosquash})

Combine squash and fixup commits with their intended targets.

@kindex r s
@cindex magit-rebase-edit-commit
@item @kbd{r s} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-edit-commit})

Edit a single older commit using rebase.

@kindex r w
@cindex magit-rebase-reword-commit
@item @kbd{r w} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-reword-commit})

Reword a single older commit using rebase.
@end table

When a rebase is in progress, then the popup buffer features these
commands instead.

@table @asis
@kindex r r
@cindex magit-rebase-continue
@item @kbd{r r} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-continue})

Restart the current rebasing operation.

@kindex r s
@cindex magit-rebase-skip
@item @kbd{r s} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-skip})

Skip the current commit and restart the current rebase operation.

@kindex r e
@cindex magit-rebase-edit
@item @kbd{r e} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-edit})

Edit the todo list of the current rebase operation.

@kindex r a
@cindex magit-rebase-abort
@item @kbd{r a} @tie{}@tie{}@tie{}@tie{}(@code{magit-rebase-abort})

Abort the current rebase operation, restoring the original branch.
@end table

@menu
* Editing rebase sequences::
@end menu

@node Editing rebase sequences
@subsection Editing rebase sequences

@table @asis
@kindex C-c C-c
@cindex with-editor-finish
@item @kbd{C-c C-c} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-finish})

Finish the current editing session by returning with exit code 0.
Git then creates the commit using the message it finds in the file.

@kindex C-c C-k
@cindex with-editor-cancel
@item @kbd{C-c C-k} @tie{}@tie{}@tie{}@tie{}(@code{with-editor-cancel})

Cancel the current editing session by returning with exit code 1.
Git then cancels the commit, but leaves the file untouched.

@kindex RET
@cindex git-rebase-show-commit
@item @kbd{RET} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-show-commit})

Show the commit on the current line if any.

@kindex p
@cindex git-rebase-backward-line
@item @kbd{p} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-backward-line})

Move to previous line.

@kindex n
@cindex forward-line
@item @kbd{n} @tie{}@tie{}@tie{}@tie{}(@code{forward-line})

Move to next line.

@kindex M-p
@cindex git-rebase-move-line-up
@item @kbd{M-p} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-move-line-up})

Move the current commit (or command) up.

@kindex M-n
@cindex git-rebase-move-line-down
@item @kbd{M-n} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-move-line-down})

Move the current commit (or command) down.

@kindex r
@cindex git-rebase-reword
@item @kbd{r} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-reword})

Edit message of commit on current line.

@kindex e
@cindex git-rebase-edit
@item @kbd{e} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-edit})

Stop at the commit on the current line.

@kindex s
@cindex git-rebase-squash
@item @kbd{s} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-squash})

Meld commit on current line into previous commit, and edit message.

@kindex f
@cindex git-rebase-fixup
@item @kbd{f} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-fixup})

Meld commit on current line into previous commit, discarding the
current commit's message.

@kindex k
@cindex git-rebase-kill-line
@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-kill-line})

Kill the current action line.

@kindex c
@cindex git-rebase-pick
@item @kbd{c} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-pick})

Use commit on current line.

@kindex x
@cindex git-rebase-exec
@item @kbd{x} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-exec})

Insert a shell command to be run after the proceeding commit.

If there already is such a command on the current line, then edit
that instead.  With a prefix argument insert a new command even when
there already is one on the current line.  With empty input remove
the command on the current line, if any.

@kindex y
@cindex git-rebase-insert
@item @kbd{y} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-insert})

Read an arbitrary commit and insert it below current line.

@kindex C-x u
@cindex git-rebase-undo
@item @kbd{C-x u} @tie{}@tie{}@tie{}@tie{}(@code{git-rebase-undo})

Undo some previous changes.  Like @code{undo} but works in read-only
buffers.

@end table

@defopt git-rebase-auto-advance

Whether to move to next line after changing a line.
@end defopt

@defopt git-rebase-show-instructions

Whether to show usage instructions inside the rebase buffer.
@end defopt

@defopt git-rebase-confirm-cancel

Whether confirmation is required to cancel.
@end defopt

@node Cherry picking
@section Cherry picking

Also see 
@ifinfo
@ref{git-cherry-pick,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-cherry-pick">git-cherry-pick(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-cherry-pick(1) manpage
@end iftex
.

@table @asis
@kindex A
@cindex magit-cherry-pick-popup
@item @kbd{A} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-pick-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.
@end table

When no cherry-pick or revert is in progress, then the popup buffer
features the following commands.

@table @asis
@kindex A A
@cindex magit-cherry-pick
@item @kbd{A A} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-pick})

Cherry-pick a commit.  Prompt for a commit, defaulting to the commit
at point.  If the region selects multiple commits, then pick all of
them, without prompting.

@kindex A a
@cindex magit-cherry-apply
@item @kbd{A a} @tie{}@tie{}@tie{}@tie{}(@code{magit-cherry-apply})

Apply the changes in a commit to the working tree, but do not commit
them.  Prompt for a commit, defaulting to the commit at point.  If
the region selects multiple commits, then apply all of them, without
prompting.

This command also has a top-level binding, which can be invoked without
using the popup by typing @code{a} at the top-level.
@end table

When a cherry-pick or revert is in progress, then the popup buffer
features these commands instead.

@table @asis
@kindex A A
@cindex magit-sequence-continue
@item @kbd{A A} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-continue})

Resume the current cherry-pick or revert sequence.

@kindex A s
@cindex magit-sequence-skip
@item @kbd{A s} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-skip})

Skip the stopped at commit during a cherry-pick or revert sequence.

@kindex A a
@cindex magit-sequence-abort
@item @kbd{A a} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-abort})

Abort the current cherry-pick or revert sequence.  This discards all
changes made since the sequence started.
@end table

@menu
* Reverting::
@end menu

@node Reverting
@subsection Reverting

@table @asis
@kindex V
@cindex magit-revert-popup
@item @kbd{V} @tie{}@tie{}@tie{}@tie{}(@code{magit-revert-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.
@end table

When no cherry-pick or revert is in progress, then the popup buffer
features the following commands.

@table @asis
@kindex V V
@cindex magit-revert
@item @kbd{V V} @tie{}@tie{}@tie{}@tie{}(@code{magit-revert})

Revert a commit by creating a new commit.  Prompt for a commit,
defaulting to the commit at point.  If the region selects multiple
commits, then revert all of them, without prompting.

@kindex V v
@cindex magit-revert-no-commit
@item @kbd{V v} @tie{}@tie{}@tie{}@tie{}(@code{magit-revert-no-commit})

Revert a commit by applying it in reverse to the working tree.
Prompt for a commit, defaulting to the commit at point.  If the
region selects multiple commits, then revert all of them, without
prompting.
@end table

When a cherry-pick or revert is in progress, then the popup buffer
features these commands instead.

@table @asis
@kindex V A
@cindex magit-sequence-continue
@item @kbd{V A} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-continue})

Resume the current cherry-pick or revert sequence.

@kindex V s
@cindex magit-sequence-skip
@item @kbd{V s} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-skip})

Skip the stopped at commit during a cherry-pick or revert sequence.

@kindex V a
@cindex magit-sequence-abort
@item @kbd{V a} @tie{}@tie{}@tie{}@tie{}(@code{magit-sequence-abort})

Abort the current cherry-pick or revert sequence.  This discards all
changes made since the sequence started.
@end table

@node Resetting
@section Resetting

Also see 
@ifinfo
@ref{git-reset,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-reset">git-reset(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-reset(1) manpage
@end iftex
.

@table @asis
@kindex x
@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.

@kindex U
@cindex magit-reset-index
@item @kbd{U} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-index})

Reset the index to some commit read from the user and defaulting to
the commit at point.  Keep the @code{HEAD} and working tree as-is, so if
the commit refers to the @code{HEAD}, then this effectively unstages all
changes.

@kindex M-x magit-reset-head
@cindex magit-reset-head
@item @kbd{M-x magit-reset-head} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-head})

Reset the @code{HEAD} and index to some commit read from the user and
defaulting to the commit at point.  The working tree is kept as-is.

@kindex M-x magit-reset-soft
@cindex magit-reset-soft
@item @kbd{M-x magit-reset-soft} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-soft})

Reset the @code{HEAD} to some commit read from the user and defaulting
to the commit at point.  The index and the working tree are kept
as-is.

@kindex M-x magit-reset-hard
@cindex magit-reset-hard
@item @kbd{M-x magit-reset-hard} @tie{}@tie{}@tie{}@tie{}(@code{magit-reset-hard})

Reset the @code{HEAD}, index, and working tree to some commit read from the
user and defaulting to the commit at point.
@end table

@node Stashing
@section Stashing

Also see 
@ifinfo
@ref{git-stash,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-stash">git-stash(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-stash(1) manpage
@end iftex
.

@table @asis
@kindex z
@cindex magit-stash-popup
@item @kbd{z} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex z z
@cindex magit-stash
@item @kbd{z z} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash})

Create a stash of the index and working tree.  Untracked files are
included according to popup arguments.  One prefix argument is
equivalent to @code{--include-untracked} while two prefix arguments are
equivalent to @code{--all}.

@kindex z i
@cindex magit-stash-index
@item @kbd{z i} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-index})

Create a stash of the index only.  Unstaged and untracked changes
are not stashed.

@kindex z w
@cindex magit-stash-worktree
@item @kbd{z w} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-worktree})

Create a stash of the working tree only.  Untracked files are
included according to popup arguments.  One prefix argument is
equivalent to @code{--include-untracked} while two prefix arguments are
equivalent to @code{--all}.

@kindex z x
@cindex magit-stash-keep-index
@item @kbd{z x} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-keep-index})

Create a stash of the index and working tree, keeping index intact.
Untracked files are included according to popup arguments.  One
prefix argument is equivalent to @code{--include-untracked} while two
prefix arguments are equivalent to @code{--all}.

@kindex z Z
@cindex magit-snapshot
@item @kbd{z Z} @tie{}@tie{}@tie{}@tie{}(@code{magit-snapshot})

Create a snapshot of the index and working tree.  Untracked files
are included according to popup arguments.  One prefix argument is
equivalent to @code{--include-untracked} while two prefix arguments are
equivalent to @code{--all}.

@kindex z I
@cindex magit-snapshot-index
@item @kbd{z I} @tie{}@tie{}@tie{}@tie{}(@code{magit-snapshot-index})

Create a snapshot of the index only.  Unstaged and untracked changes
are not stashed.

@kindex z W
@cindex magit-snapshot-worktree
@item @kbd{z W} @tie{}@tie{}@tie{}@tie{}(@code{magit-snapshot-worktree})

Create a snapshot of the working tree only.  Untracked files are
included according to popup arguments.  One prefix argument is
equivalent to @code{--include-untracked} while two prefix arguments are
equivalent to @code{--all}-.

@kindex z a
@cindex magit-stash-apply
@item @kbd{z a} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-apply})

Apply a stash to the working tree.  Try to preserve the stash index.
If that fails because there are staged changes, apply without
preserving the stash index.

@kindex z p
@cindex magit-stash-pop
@item @kbd{z p} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-pop})

Apply a stash to the working tree and remove it from stash list.
Try to preserve the stash index.  If that fails because there are
staged changes, apply without preserving the stash index and forgo
removing the stash.

@kindex z d
@cindex magit-stash-drop
@item @kbd{z d} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-drop})

Remove a stash from the stash list.  When the region is active, offer
to drop all contained stashes.

@kindex z l
@cindex magit-stash-list
@item @kbd{z l} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-list})

List all stashes in a buffer.

@kindex z v
@cindex magit-stash-show
@item @kbd{z v} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-show})

Show all diffs of a stash in a buffer.

@kindex z b
@cindex magit-stash-branch
@item @kbd{z b} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-branch})

Create and checkout a new BRANCH from STASH.

@kindex k
@cindex magit-stash-clear
@item @kbd{k} @tie{}@tie{}@tie{}@tie{}(@code{magit-stash-clear})

Remove all stashes saved in REF's reflog by deleting REF.
@end table

@node Transferring
@chapter Transferring


@menu
* Remotes::
* Fetching::
* Pulling::
* Pushing::
* Creating and sending patches::
* Applying patches::
@end menu

@node Remotes
@section Remotes

Also see 
@ifinfo
@ref{git-remote,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-remote">git-remote(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-remote(1) manpage
@end iftex
.

@table @asis
@kindex M
@cindex magit-remote-popup
@item @kbd{M} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex M a
@cindex magit-remote-add
@item @kbd{M a} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-add})

Add a remote and fetch it.  The remote name and url are read in the
minibuffer.

@kindex M r
@cindex magit-remote-rename
@item @kbd{M r} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-rename})

Rename a remote.  Both the old and the new names are read in the
minibuffer.

@kindex M u
@cindex magit-remote-set-url
@item @kbd{M u} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-set-url})

Change the url of a remote.  Both the remote and the new url are
read in the minibuffer.

@kindex M k
@cindex magit-remote-remove
@item @kbd{M k} @tie{}@tie{}@tie{}@tie{}(@code{magit-remote-remove})

Delete a remote, read from the minibuffer.
@end table

@node Fetching
@section Fetching

Also see 
@ifinfo
@ref{git-fetch,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-fetch">git-fetch(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-fetch(1) manpage
@end iftex
.

@table @asis
@kindex f
@cindex magit-fetch-popup
@item @kbd{f} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex f f
@cindex magit-fetch-current
@item @kbd{f f} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-current})

Fetch from the upstream repository of the current branch.  If @code{HEAD}
is detached or if the upstream is not configured, then read the
remote.

@kindex f o
@cindex magit-fetch
@item @kbd{f o} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch})

Fetch from another repository.

@kindex f a
@cindex magit-fetch-all
@item @kbd{f a} @tie{}@tie{}@tie{}@tie{}(@code{magit-fetch-all})

Fetch from all configured remotes.

@kindex f m
@cindex magit-submodule-fetch
@item @kbd{f m} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-fetch})

Fetch all submodules.  With a prefix argument fetch all remotes or
all submodules.
@end table

@node Pulling
@section Pulling

Also see 
@ifinfo
@ref{git-pull,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-pull">git-pull(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-pull(1) manpage
@end iftex
.

@table @asis
@kindex F
@cindex magit-pull-popup
@item @kbd{F} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex F F
@cindex magit-pull-current
@item @kbd{F F} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull-current})

Fetch and merge into current branch.

@kindex F o
@cindex magit-pull
@item @kbd{F o} @tie{}@tie{}@tie{}@tie{}(@code{magit-pull})

Fetch from another repository and merge a fetched branch.
@end table

@node Pushing
@section Pushing

Also see 
@ifinfo
@ref{git-push,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-push">git-push(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-push(1) manpage
@end iftex
.

@table @asis
@kindex P
@cindex magit-push-popup
@item @kbd{P} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex P P
@cindex magit-push-current
@item @kbd{P P} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-current})

Push the current branch to its upstream branch.  If the upstream
isn't set, then read the remote branch.

@kindex P o
@cindex magit-push
@item @kbd{P o} @tie{}@tie{}@tie{}@tie{}(@code{magit-push})

Push a branch to its upstream branch.  If the upstream isn't set,
then read the remote branch.

@kindex P e
@cindex magit-push-elsewhere
@item @kbd{P e} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-elsewhere})

Push a branch or commit to some remote branch.  Read the local and
remote branch.

@kindex P m
@cindex magit-push-matching
@item @kbd{P m} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-matching})

Push all matching branches to another repository.  If multiple
remotes exit, then read one from the user.  If just one exists, use
that without requiring confirmation.

@kindex P t
@cindex magit-push-tags
@item @kbd{P t} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-tags})

Push all tags to another repository.  If only one remote exists,
then push to that.  Otherwise prompt for a remote, offering the
remote configured for the current branch as default.

@kindex P T
@cindex magit-push-tag
@item @kbd{P T} @tie{}@tie{}@tie{}@tie{}(@code{magit-push-tag})

Push a tag to another repository.
@end table

@node Creating and sending patches
@section Creating and sending patches

@table @asis
@kindex W
@cindex magit-patch-popup
@item @kbd{W} @tie{}@tie{}@tie{}@tie{}(@code{magit-patch-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex W p
@cindex magit-format-patch
@item @kbd{W p} @tie{}@tie{}@tie{}@tie{}(@code{magit-format-patch})

Create patches for a set commits.  If the region marks commits, then
create patches for those.  Otherwise prompt for a range or a single
commit, defaulting to the commit at point.

@kindex W r
@cindex magit-request-pull
@item @kbd{W r} @tie{}@tie{}@tie{}@tie{}(@code{magit-request-pull})

Request that upstream pulls from your public repository.
@end table

@node Applying patches
@section Applying patches

Also see 
@ifinfo
@ref{git-am,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-am">git-am(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-am(1) manpage
@end iftex
.

@table @asis
@kindex w
@cindex magit-am-popup
@item @kbd{w} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex w w
@cindex magit-am-apply-patches
@item @kbd{w w} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-apply-patches})

Apply one or more patches.  If the region marks files, then apply
those patches.  Otherwise read a file name in the minibuffer
defaulting to the file at point.

@kindex w m
@cindex magit-am-apply-maildir
@item @kbd{w m} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-apply-maildir})

Apply the patches from a maildir.

@kindex w w
@cindex magit-am-continue
@item @kbd{w w} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-continue})

Resume the current patch applying sequence.

@kindex w s
@cindex magit-am-skip
@item @kbd{w s} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-skip})

Skip the stopped at patch during a patch applying sequence.

@kindex w a
@cindex magit-am-abort
@item @kbd{w a} @tie{}@tie{}@tie{}@tie{}(@code{magit-am-abort})

Abort the current patch applying sequence.  This discards all
changes made since the sequence started.
@end table

@node Miscellaneous
@chapter Miscellaneous


@menu
* Tagging::
* Notes::
* Submodules::
* Wip Modes::
@end menu

@node Tagging
@section Tagging

Also see 
@ifinfo
@ref{git-tag,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-tag">git-tag(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-tag(1) manpage
@end iftex
.

@table @asis
@kindex t
@cindex magit-tag-popup
@item @kbd{t} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex t t
@cindex magit-tag
@item @kbd{t t} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag})

Create a new tag with the given NAME at REV.  With a prefix argument
annotate the tag.

@kindex t k
@cindex magit-tag-delete
@item @kbd{t k} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-delete})

Delete one or more tags.  If the region marks multiple tags (and
nothing else), then offer to delete those.  Otherwise, prompt for a
single tag to be deleted, defaulting to the tag at point.

@kindex t p
@cindex magit-tag-prune
@item @kbd{t p} @tie{}@tie{}@tie{}@tie{}(@code{magit-tag-prune})

Offer to delete tags missing locally from REMOTE, and vice versa.
@end table

@node Notes
@section Notes

Also see 
@ifinfo
@ref{git-notes,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-notes">git-notes(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-notes(1) manpage
@end iftex
.

@table @asis
@kindex T
@cindex magit-notes-popup
@item @kbd{T} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex T T
@cindex magit-notes-edit
@item @kbd{T T} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-edit})

Edit the note attached to a commit, defaulting to the commit at
point.

By default use the value of Git variable @code{core.notesRef} or
"refs/notes/commits" if that is undefined.

@kindex T r
@cindex magit-notes-remove
@item @kbd{T r} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-remove})

Remove the note attached to a commit, defaulting to the commit at
point.

By default use the value of Git variable @code{core.notesRef} or
"refs/notes/commits" if that is undefined.

@kindex T p
@cindex magit-notes-prune
@item @kbd{T p} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-prune})

Remove notes about unreachable commits.

@kindex T s
@cindex magit-notes-set-ref
@item @kbd{T s} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-set-ref})

Set the current notes ref to a the value read from the user.  The
ref is made current by setting the value of the Git variable
@code{core.notesRef}.  With a prefix argument change the global value
instead of the value in the current repository.  When this is
undefined, then "refs/notes/commit" is used.

Other @code{magit-notes-*} commands, as well as the sub-commands of Git's
@code{note} command, default to operate on that ref.

@kindex T S
@cindex magit-notes-set-display-refs
@item @kbd{T S} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-set-display-refs})

Set notes refs to be display in addition to "core.notesRef".  This
reads a colon separated list of notes refs from the user.  The
values are stored in the Git variable @code{notes.displayRef}.  With a
prefix argument GLOBAL change the global values instead of the
values in the current repository.
@end table

It is possible to merge one note ref into another.  That may result in
conflicts which have to resolved in the temporary worktree
".git/NOTES@math{_MERGE}@math{_WORKTREE}".

@table @asis
@kindex T m
@cindex magit-notes-merge
@item @kbd{T m} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-merge})

Merge the notes of a ref read from the user into the current notes
ref.  The current notes ref is the value of Git variable
@code{core.notesRef} or "refs/notes/commits" if that is undefined.
@end table

When a notes merge is in progress then the popup features the
following suffix commands, instead of those listed above.

@table @asis
@kindex T c
@cindex magit-notes-merge-commit
@item @kbd{T c} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-merge-commit})

Commit the current notes ref merge, after manually resolving
conflicts.

@kindex T a
@cindex magit-notes-merge-abort
@item @kbd{T a} @tie{}@tie{}@tie{}@tie{}(@code{magit-notes-merge-abort})

Abort the current notes ref merge.
@end table

@node Submodules
@section Submodules

Also see 
@ifinfo
@ref{git-submodule,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-submodule">git-submodule(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-submodule(1) manpage
@end iftex
.

@table @asis
@kindex o
@cindex magit-submodule-popup
@item @kbd{o} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-popup})

This prefix commands shows the following suffix commands along with
the appropriate infix arguments in a popup buffer.

@kindex o a
@cindex magit-submodule-add
@item @kbd{o a} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-add})

Add the repository at URL as a submodule.  Optional PATH is the path
to the submodule relative to the root of the super-project. If it is
nil then the path is determined based on URL.

@kindex o b
@cindex magit-submodule-setup
@item @kbd{o b} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-setup})

Clone and register missing submodules and checkout appropriate
commits.

@kindex o i
@cindex magit-submodule-init
@item @kbd{o i} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-init})

Register submodules listed in ".gitmodules" into ".git/config".

@kindex o u
@cindex magit-submodule-update
@item @kbd{o u} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-update})

Clone missing submodules and checkout appropriate commits.  With a
prefix argument also register submodules in ".git/config".

@kindex o s
@cindex magit-submodule-sync
@item @kbd{o s} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-sync})

Update each submodule's remote URL according to ".gitmodules".

@kindex o f
@cindex magit-submodule-fetch
@item @kbd{o f} @tie{}@tie{}@tie{}@tie{}(@code{magit-submodule-fetch})

Fetch submodule.  With a prefix argument fetch all remotes.
@end table

@node Wip Modes
@section Wip Modes

Git keeps @strong{committed} changes around long enough for users to recover
changes they have accidentally deleted.  It does so by not garbage
collecting any committed but no longer referenced objects for a
certain period of time, by default 30 days.

But Git does @strong{not} keep track of @strong{uncommitted} changes in the working tree
and not even the index (the staging area).  Because Magit makes it so
convenient to modify uncommitted changes, it also makes it easy to
shoot yourself in the foot in the process.

For that reason Magit provides three global modes that save @strong{tracked}
files to work-in-progress references after or before certain actions.
(Untracked files are never saved and these modes also only work after
the first commit has been created).

Two separate work-in-progress references are used to track the state
of the index and of the working tree: "refs/wip/index/<branchref>" and
"refs/wip/wtree/<branchref>", where @code{<branchref>} is the full ref of the
current branch, e.g. "refs/heads/master".  When the @code{HEAD} is detached
then "HEAD" is in place of @code{<branchref>}.

Checking out another branch (or detaching @code{HEAD}) causes the use of
different wip refs for subsequent changes, but the old refs are not
deleted.

Creating a commit and then making a change causes the wip refs to be
recreated to fork from the new commit.  But the old commits on the wip
refs are not lost.  They are still available from the reflog.  To make
it easier to see when the fork point of a wip ref was changed, an
additional commit with the message "restart autosaving" is created on
it (@code{xxO} commits below are such boundary commits).

Starting with

@verbatim
      BI0---BI1    refs/wip/index/refs/heads/master
     /
A---B              refs/heads/master
     \
      BW0---BW1    refs/wip/wtree/refs/heads/master
@end verbatim

and committing the staged changes and editing and saving a file would
result in

@verbatim
      BI0---BI1        refs/wip/index/refs/heads/master
     /
A---B---C              refs/heads/master
     \   \
      \   CW0---CW1    refs/wip/wtree/refs/heads/master
       \
        BW0---BW1      refs/wip/wtree/refs/heads/master@{2}
@end verbatim

The fork-point of the index wip ref is not changed until some change
is being staged.  Likewise just checking out a branch or creating a
commit does not change the fork-point of the working tree wip ref.  The
fork-points are not adjusted until there actually is a change that
should be committed to the respective wip ref.

To recover a lost change from a wip ref, use the reflog.  To show the
reflog, use e.g. @code{lO refs/wip/index/refs/heads/master RET} and then move
around until you find the commit which has the lost change.  You might
then be able to simply apply it using @code{a} (@code{magit-apply}).

There exists a total of three global modes that save to the wip refs,
which might seem excessive, but allows fine tuning of when exactly
changes are being committed to the wip refs.  Enabling all modes makes
it less likely that a change slips through the cracks.

@defopt magit-wip-after-save-mode

When this mode is enabled, then saving a buffer that visits a file
tracked in a Git repository causes its current state to be committed
to the working tree wip ref for the current branch.
@end defopt

@defopt magit-wip-after-apply-mode

When this mode is enabled, then applying (i.e. staging, unstaging,
discarding, reversing, and regularly applying) a change to a file
tracked in a Git repository causes its current state to be committed
to the index and/or working tree wip refs for the current branch.
@end defopt

If you only ever edit files using Emacs and only ever interact with
Git using Magit, then the above two modes should be enough to protect
each and every change from accidental loss.  In practice nobody does
that.  So an additional mode exists that does commit to the wip refs
before making changes that could cause the loss of earlier changes.

@defopt magit-wip-before-change-mode

When this mode is enabled, then certain commands commit the existing
changes to the files they are about to make changes to.
@end defopt

Note that even if you enable all three modes this won't give you
perfect protection.  The most likely scenario for losing changes
despite the use of these modes is making a change outside Emacs and
then destroying it also outside Emacs.  In such a scenario, Magit,
being an Emacs package, didn't get the opportunity to keep you from
shooting yourself in the foot.

When you are unsure whether Magit did commit a change to the wip refs,
then you can explicitly request that all changes to all tracked files
are being committed.

@table @asis
@kindex M-x magit-wip-commit
@cindex magit-wip-commit
@item @kbd{M-x magit-wip-commit} @tie{}@tie{}@tie{}@tie{}(@code{magit-wip-commit})

This command commits all changes to all tracked files to the index
and working tree work-in-progress refs.  Like the modes described above,
it does not commit untracked files, but it does check all tracked
files for changes.  Use this command when you suspect that the modes
might have overlooked a change made outside Emacs/Magit.

@end table

@defopt magit-wip-after-save-local-mode-lighter

Mode-line lighter for @code{magit-wip-after-save-local-mode}.
@end defopt

@defopt magit-wip-after-apply-mode-lighter

Mode-line lighter for @code{magit-wip-after-apply-mode}.
@end defopt

@defopt magit-wip-before-change-mode-lighter

Mode-line lighter for @code{magit-wip-before-change-mode}.
@end defopt

@defopt magit-wip-namespace

The namespace used for work-in-progress refs.  It has to end with a
slash.  The wip refs are named "<namespace>index/<branchref>" and
"<namespace>wtree/<branchref>".  When snapshots are created while
the @code{HEAD} is detached then "HEAD" is used in place of @code{<branchref>}.
@end defopt

@node Customizing
@chapter Customizing

Both Git and Emacs are highly customizable.  Magit is both a Git
porcelain as well as an Emacs package, so it makes sense to customize
it using both Git variables as well as Emacs options.  However this
flexibility doesn't come without problems, including but not limited
to the following.

@itemize
@item
Some Git variables automatically have an effect in Magit without
requiring any explicit support.  Sometimes that is desirable - in
other cases, it breaks Magit.

When a certain Git setting breaks Magit but you want to keep using
that setting on the command line, then that can be accomplished by
overriding the value for Magit only by appending something like
@code{("-c" "some.variable=compatible-value")} to
@code{magit-git-global-arguments}.


@item
Certain settings like @code{fetch.prune=true} are respected by Magit
commands (because they simply call the respective Git command) but
their value is not reflected in the respective popup buffers.  In
this case the @code{--prune} argument in @code{magit-fetch-popup} might be active
or inactive depending on the value of @code{magit-fetch-arguments} only,
but that doesn't keep the Git variable from being honored by the
suffix commands anyway.  So pruning might happen despite the the
@code{--prune} arguments being displayed in a way that seems to indicate
that no pruning will happen.
@end itemize

I intend to address these and similar issues in a future release.

@menu
* Per-repository configuration::
* Essential settings::
@end menu

@node Per-repository configuration
@section Per-repository configuration

Magit can be configured on a per-repository level using both Git
variables as well as Emacs options.

To set a Git variable for one repository only, simply set it in
@code{/path/to/repo/.git/config} instead of @code{$HOME/.gitconfig} or
@code{/etc/gitconfig}.  See 
@ifinfo
@ref{git-config,,,gitman,}
@end ifinfo
@ifhtml
@html
the <a href="http://git-scm.com/docs/git-config">git-config(1)</a> manpage
@end html
@end ifhtml
@iftex
the git-config(1) manpage
@end iftex
.

Similarly, Emacs options can be set for one repository only by editing
@code{/path/to/repo/.dir-locals.el}.  See @ref{Directory Variables,,,emacs,}.
For example to disable automatic refreshes of file-visiting buffers in
just one huge repository use this:

@itemize
@item
@code{/path/to/huge/repo/.dir-locals.el}

@lisp
((nil . ((magit-refresh-buffers . nil))
@end lisp
@end itemize

If you want to apply the same settings to several, but not all,
repositories then keeping the repository-local config files in sync
would quickly become annoying.  To avoid that you can create config
files for certain classes of repositories (e.g. "huge repositories")
and then include those files in the per-repository config files.
For example:

@itemize
@item
@code{/path/to/huge/repo/.git/config}

@example
[include]
        path = /path/to/huge-gitconfig
@end example


@item
@code{/path/to/huge-gitconfig}

@example
[status]
        showUntrackedFiles = no
@end example


@item
@code{$HOME/.emacs.d/init.el}

@lisp
(dir-locals-set-class-variables 'huge-git-repository
   '((nil . ((magit-refresh-buffers . nil)))))

(dir-locals-set-directory-class
   "/path/to/huge/repo/" 'huge-git-repository)
@end lisp
@end itemize

@node Essential settings
@section Essential settings

The next two sections list and discuss several variables that many
users might want to customize, for safety and/or performance reasons.

@menu
* Safety::
* Performance::
@end menu

@node Safety
@subsection Safety

This section discusses various variables that you might want to
change (or @strong{not} change) for safety reasons.

Git keeps @strong{committed} changes around long enough for users to recover
changes they have accidentally deleted.  It does not do the same for
@strong{uncommitted} changes in the working tree and not even the index (the
staging area).  Because Magit makes it so easy to modify uncommitted
changes, it also makes it easy to shoot yourself in the foot in the
process.  For that reason Magit provides three global modes that save
@strong{tracked} files to work-in-progress references after or before certain
actions.  See @ref{Wip Modes,Wip Modes}.

These modes are not enabled by default because of performance
concerns.  Instead a lot of potentially destructive commands require
confirmation every time they are used.  In many cases this can be
disabled by adding a symbol to @code{magit-no-confirm} (see @ref{Completion and confirmation,Completion and confirmation}).  If you enable the various wip modes then you should
add @code{safe-with-wip} to this list.

Similarly it isn't necessary to require confirmation before moving a
file to the system trash - if you trashed a file by mistake then you
can recover it from the there.  Option @code{magit-delete-by-moving-to-trash}
controls whether the system trash is used, which is the case by default.
Nevertheless, @code{trash} isn't a member of @code{magit-no-confirm} - you
might want to change that.

Buffers visiting files tracked in the current repository are being
refreshed before certain actions.  See @ref{Automatic refresh and revert,Automatic refresh and revert}.
This isn't as risky as it might seem.  If a buffer is modified
(i.e. it contains changes that haven't been saved yet), then
Emacs/Magit would refuse to revert it.  If the buffer has been saved
resulting in what is seen by Git as an uncommitted change, then Git in
turn would refuse to carry out the action that would cause these
changes to be lost.  Since Git doesn't do anything, the file doesn't
change on disk, and Emacs/Magit has nothing to revert.

However if you do modify some files, visit the respective files in
Emacs, somehow discard the changes (not using Magit and probably even
outside Emacs), and then expect the respective file-visiting buffers
to retain the uncommitted changes, then the automatic reverting would
actually be harmful.  In other words if you use file-visiting buffers
as a sort of "staging area", then you should set @code{magit-revert-buffers}
to @code{nil}.

So far I have only heard from one user who uses such a workflow.  But
because there might be some other users doing such things, and I don't
want to be responsible for data loss, these reverts by default happen
quite verbosely, allowing these few users to undo the reverts using
the @code{undo} command and then disabling the automatic reverts for the
future.  Most users should however keep automatic reverts turned on
and instead configure it to be less verbose by setting
@code{magit-revert-buffers} to @code{t} or even @code{silent}.

@node Performance
@subsection Performance

Magit is slower than raw Git because it does more.  For example @code{git
commit} creates a commit and that's it.  @code{magit-commit} also updates the
current Magit buffer to make sure you are not looking at outdated
information without noticing it.  To refresh the status buffer, Magit
has to run Git a dozen times or more, making it slower than @code{git
status}, but also much more informative.  Magit also optionally reverts
file-visiting buffers, creates backups, runs hooks where third-party
extensions can do their slow thing, etc.

I do care about performance and try to optimize for it as much as
possible, but many features simply come with an inherent performance
penalty.  When a feature is just too slow given certain usage and
repository characteristics, then it often can be disabled, globally or
on a per-repository basis.

But first a short list of performance issues that cannot easily be
worked around:

@itemize
@item
Creating a new process on MS Windows is much slower than on
POSIX-compatible systems.  This is a problem because Magit creates a
lot of child processes to retrieve information from Git.  In the
short run, only switching to a POSIX system can fix this.  Of course
this could also be fixed in Windows itself, but I am just one unpaid
person while Microsoft is a billion dollar company, so I will leave
it to them to fix this grave flaw in their OS.


@item
When showing logs, Magit limits the number of commits initially
shown in the hope that this avoids unnecessary work.  When using
@code{--graph} this unfortunately does not have the desired effect for
large histories.  Junio said on the git mailing list
(@uref{http://www.spinics.net/lists/git/msg232230.html}): "@code{--graph} wants to
compute the whole history and the max-count only affects the output
phase after @code{--graph} does its computation".

In other words, it's not that Git is slow at outputting the
differences, or that Magit is slow at parsing the output - the
problem is that Git first goes outside and has a smoke.  This has to
be fixed in Git but so far nobody volunteered to do it.  Maybe you
could do that?


@item
Whenever "something changes", Magit "refreshes" the status buffer and
the current Magit buffer by recreating them from scratch.  This is
an old design decision that we couldn't depart from easily.  And it
has its benefits too - most importantly it's much simpler and less
error prone to do it this way than to only refreshing "what actually
has changed" (that would basically be a huge collection of special
cases).  So for now at least, we don't avoid recreating the buffer
content and instead focus on making doing so faster.
@end itemize

Now for the things that you can do to improve performance:

Most optional features which can have a negative effect on performance
are disabled by default.  So start by checking the options you have
customized.  Even the potentially slow features are expected to only
lead to barely noticeable delays, but your mileage may vary.  Also
note that it is now possible to set options on a per-repository or
per-repository-class basis.  See @ref{Per-repository configuration,Per-repository configuration}.

You should check the values of at least the following variables:

@itemize
@item
@code{magit-after-revert-hook}

@item
@code{magit-diff-auto-show}

@item
@code{magit-diff-highlight-hunk-body}

@item
@code{magit-diff-highlight-indentation}

@item
@code{magit-diff-highlight-whitespace}

@item
@code{magit-diff-paint-whitespace}

@item
@code{magit-diff-refine-hunk}

@item
@code{magit-not-reverted-hook}

@item
@code{magit-refresh-buffer-hook}

@item
@code{magit-status-refresh-hook}

@item
@code{magit-wip-after-apply-mode}

@item
@code{magit-wip-after-save-mode}

@item
@code{magit-wip-before-change-mode}
@end itemize

Also note that everything involving "cherry commits" is slow.

If nothing helps, then feel free to open a new issue.  Please provide
benchmarks.

@node Plumbing
@chapter Plumbing

The following sections describe how to use several of Magit's core
abstractions to extend Magit itself or implement a separate extension.

A few of the low-level features used by Magit have been factored out
into separate libraries/packages, so that they can be used by other
packages, without having to depend on Magit.  These libraries are
described in separate manuals, see @ref{Top,,,with-editor,} and
@ref{Top,,,magit-popup,}.

@menu
* Calling Git::
* Section plumbing::
* Refreshing buffers::
* Conventions::
@end menu

@node Calling Git
@section Calling Git

Magit provides many specialized functions for calling Git.  All of
these functions are defined in either @code{magit-git.el} or @code{magit-process.el}
and have one of the prefixes @code{magit-run-}, @code{magit-call-}, @code{magit-start-},
or @code{magit-git-} (which is also used for other things).

All of these functions accept an indefinite number of arguments, which
are strings that specify command line arguments for git (or in some
cases an arbitrary executable).  These arguments are flattened before
being passed on to the executable; so instead of strings they can also
be lists of strings and arguments that are @code{nil} are silently dropped.
Some of these functions also require a single mandatory argument
before these command line arguments.

Roughly speaking these functions run Git either to get some value or
for side-effect.  The functions that return a value are useful to
collect the information necessary to populate a Magit buffer, while
the others are used to implement Magit commands.

The functions in the value-only group always run synchronously, and
they never trigger a refresh.  The function in the side-effect group
can be further divided into subgroups depending on whether they run
Git synchronously or asynchronously, and depending on whether they
trigger a refresh when the executable has finished.

@menu
* Getting a value from Git::
* Calling Git for effect::
@end menu

@node Getting a value from Git
@subsection Getting a value from Git

These functions run Git in order to get a value, either its exit
status or its output.  Of course you could also use them to run Git
commands that have side-effects, but that should be avoided.

@defun magit-git-exit-code &rest args

Executes git with ARGS and returns its exit code.
@end defun

@defun magit-git-success &rest args

Executes git with ARGS and returns @code{t} if the exit code is @code{0}, @code{nil}
otherwise.
@end defun

@defun magit-git-failure &rest args

Executes git with ARGS and returns @code{t} if the exit code is @code{1}, @code{nil}
otherwise.
@end defun

@defun magit-git-true &rest args

Executes git with ARGS and returns @code{t} if the first line printed by
git is the string "true", @code{nil} otherwise.
@end defun

@defun magit-git-false &rest args

Executes git with ARGS and returns @code{t} if the first line printed by
git is the string "false", @code{nil} otherwise.
@end defun

@defun magit-git-insert &rest args

Executes git with ARGS and inserts its output at point.
@end defun

@defun magit-git-string &rest args

Executes git with ARGS and returns the first line of its output.  If
there is no output or if it begins with a newline character, then
this returns @code{nil}.
@end defun

@defun magit-git-lines &rest args

Executes git with ARGS and returns its output as a list of lines.
Empty lines anywhere in the output are omitted.
@end defun

@defun magit-git-items &rest args

Executes git with ARGS and returns its null-separated output as a
list.  Empty items anywhere in the output are omitted.

If the value of option @code{magit-git-debug} is non-nil and git exits with
a non-zero exit status, then warn about that in the echo area and
add a section containing git's standard error in the current
repository's process buffer.
@end defun

When an error occurs when using one of the above functions, then that
is usually due to a bug, i.e. the use of an argument which is not
actually supported.  Such errors are usually not reported, but when
they occur we need to be able to debug them.

@defopt magit-git-debug

Whether to report errors that occur when using @code{magit-git-insert},
@code{magit-git-string}, @code{magit-git-lines}, or @code{magit-git-items}.  This does
not actually raise an error.  Instead a message is shown in the echo
area, and git's standard error is insert into a new section in the
current repository's process buffer.
@end defopt

@defun magit-git-str &rest args

This is a variant of @code{magit-git-string} that ignores the option
@code{magit-git-debug}.  It is mainly intended to be used while handling
errors in functions that do respect that option.  Using such a
function while handing an error could cause yet another error and
therefore lead to an infinite recursion.  You probably won't ever
need to use this function.
@end defun

@node Calling Git for effect
@subsection Calling Git for effect

These functions are used to run git to produce some effect.  Most
Magit commands that actually run git do so by using such a function.

Because we do not need to consume git's output when using these
functions, their output is instead logged into a per-repository
buffer, which can be shown using @code{$} from a Magit buffer or @code{M-x
magit-process} elsewhere.

These functions can have an effect in two distinct ways.  Firstly,
running git may change something, i.e. create or push a new commit.
Secondly, that change may require that Magit buffers are refreshed to
reflect the changed state of the repository.  But refreshing isn't
always desirable, so only some of these functions do perform such a
refresh after git has returned.

Sometimes it is useful to run git asynchronously.  For example, when
the user has just initiated a push, then there is no reason to make
her wait until that has completed.  In other cases it makes sense to
wait for git to complete before letting the user do something else.
For example after staging a change it is useful to wait until after
the refresh because that also automatically moves to the next change.

@defun magit-call-git &rest args

Calls git synchronously with ARGS.
@end defun

@defun magit-call-process program &rest args

Calls PROGRAM synchronously with ARGS.
@end defun

@defun magit-run-git &rest args

Calls git synchronously with ARGS and then refreshes.
@end defun

@defun magit-run-git-with-input input &rest args

Calls git synchronously with ARGS and sends it INPUT on standard
input.

INPUT should be a buffer or the name of an existing buffer.  The
content of that buffer is used as the process' standard input.
After the process returns a refresh is performed.

As a special case, INPUT may also be nil.  In that case the content
of the current buffer is used as standard input and @strong{no} refresh is
performed.

This function actually runs git asynchronously.  But then it waits
for the process to return, so the function itself is synchronous.
@end defun

@defun magit-run-git-with-logfile file &rest args

Calls git synchronously with ARGS.  The process' output is saved in
FILE.  This is rarely useful and so this function might be removed
in the future.

This function actually runs git asynchronously.  But then it waits
for the process to return, so the function itself is synchronous.
@end defun

@defun magit-git &rest args

Calls git synchronously with ARGS for side-effects only.  This
function does not refresh the buffer.
@end defun

@defun magit-git-wash washer &rest args

Execute Git with ARGS, inserting washed output at point.  Actually
first insert the raw output at point.  If there is no output call
@code{magit-cancel-section}.  Otherwise temporarily narrow the buffer to
the inserted text, move to its beginning, and then call function
WASHER with no argument.
@end defun

And now for the asynchronous variants.

@defun magit-run-git-async &rest args

Start Git, prepare for refresh, and return the process object.
ARGS is flattened and then used as arguments to Git.

Display the command line arguments in the echo area.

After Git returns some buffers are refreshed: the buffer that was
current when this function was called (if it is a Magit buffer and
still alive), as well as the respective Magit status buffer.
Unmodified buffers visiting files that are tracked in the current
repository are reverted if @code{magit-revert-buffers} is non-nil.
@end defun

@defun magit-run-git-with-editor &rest args

Export GIT@math{_EDITOR} and start Git.  Also prepare for refresh and
return the process object.  ARGS is flattened and then used as
arguments to Git.

Display the command line arguments in the echo area.

After Git returns some buffers are refreshed: the buffer that was
current when this function was called (if it is a Magit buffer and
still alive), as well as the respective Magit status buffer.
@end defun

@defun magit-start-git &rest args

Start Git, prepare for refresh, and return the process object.

If INPUT is non-nil, it has to be a buffer or the name of an
existing buffer.  The buffer content becomes the processes
standard input.

Option @code{magit-git-executable} specifies the Git executable and option
@code{magit-git-global-arguments} specifies constant arguments.  The
remaining arguments ARGS specify arguments to Git.  They are
flattened before use.

After Git returns, some buffers are refreshed: the buffer that was
current when this function was called (if it is a Magit buffer and
still alive), as well as the respective Magit status buffer.
Unmodified buffers visiting files that are tracked in the current
repository are reverted if @code{magit-revert-buffers} is non-nil.
@end defun

@defun magit-start-process &rest args

Start PROGRAM, prepare for refresh, and return the process object.

If optional argument INPUT is non-nil, it has to be a buffer or
the name of an existing buffer.  The buffer content becomes the
processes standard input.

The process is started using @code{start-file-process} and then setup to
use the sentinel @code{magit-process-sentinel} and the filter
@code{magit-process-filter}.  Information required by these functions is
stored in the process object.  When this function returns the
process has not started to run yet so it is possible to override the
sentinel and filter.

After the process returns, @code{magit-process-sentinel} refreshes the
buffer that was current when @code{magit-start-process} was called (if it
is a Magit buffer and still alive), as well as the respective Magit
status buffer.  Unmodified buffers visiting files that are tracked
in the current repository are reverted if @code{magit-revert-buffers} is
non-nil.
@end defun

@defvar magit-this-process

The child process which is about to start.  This can be used to
change the filter and sentinel.
@end defvar

@defvar magit-process-raise-error

When this is non-nil, then @code{magit-process-sentinel} raises an error if
git exits with a non-zero exit status.  For debugging purposes.
@end defvar

@node Section plumbing
@section Section plumbing


@menu
* Creating sections::
* Section selection::
* Matching sections::
@end menu

@node Creating sections
@subsection Creating sections

@defmac magit-insert-section &rest args

Insert a section at point.

TYPE is the section type, a symbol.  Many commands that act on the
current section behave differently depending on that type.  Also if
a variable @code{magit-TYPE-section-map} exists, then use that as the
text-property @code{keymap} of all text belonging to the section (but this
may be overwritten in subsections).

Optional VALUE is the value of the section, usually a string that is
required when acting on the section.

When optional HIDE is non-nil collapse the section body by default,
i.e. when first creating the section, but not when refreshing the
buffer.  Otherwise, expand it by default.  This can be overwritten using
@code{magit-section-set-visibility-hook}.  When a section is recreated
during a refresh, then the visibility of predecessor is inherited
and HIDE is ignored (but the hook is still honored).

BODY is any number of forms that actually insert the section's
heading and body.  Optional NAME, if specified, has to be a symbol,
which is then bound to the struct of the section being inserted.

Before BODY is evaluated the @code{start} of the section object is set to
the value of @code{point} and after BODY was evaluated its @code{end} is set to
the new value of @code{point}; BODY is responsible for moving @code{point}
forward.

If it turns out inside BODY that the section is empty, then
@code{magit-cancel-section} can be used to abort and remove all traces of
the partially inserted section.  This can happen when creating a
section by washing Git's output and Git didn't actually output
anything this time around.
@end defmac

@defun magit-insert-heading &rest args

Insert the heading for the section currently being inserted.

This function should only be used inside @code{magit-insert-section}.

When called without any arguments, then just set the @code{content} slot of
the object representing the section being inserted to a marker at
@code{point}.  The section should only contain a single line when this
function is used like this.

When called with arguments ARGS, which have to be strings, then
insert those strings at point.  The section should not contain any
text before this happens and afterwards it should again only contain
a single line.  If the @code{face} property is set anywhere inside any of
these strings, then insert all of them unchanged.  Otherwise use the
@code{magit-section-heading} face for all inserted text.

The @code{content} property of the section struct is the end of the heading
(which lasts from @code{start} to @code{content}) and the beginning of the body
(which lasts from @code{content} to @code{end}).  If the value of @code{content} is nil,
then the section has no heading and its body cannot be collapsed.
If a section does have a heading then its height must be exactly one
line, including a trailing newline character.  This isn't enforced;
you are responsible for getting it right.  The only exception is
that this function does insert a newline character if necessary.
@end defun

@defun magit-cancel-section

Cancel the section currently being inserted.  This exits the
innermost call to @code{magit-insert-section} and removes all traces of
what has already happened inside that call.
@end defun

@defun magit-define-section-jumper sym title &optional value

Define an interactive function to go to section SYM.  TITLE is the
displayed title of the section.
@end defun

@node Section selection
@subsection Section selection

@defun magit-current-section

Return the section at point.
@end defun

@defun magit-region-sections

Return a list of the selected sections.

When the region is active and constitutes a valid section selection,
then return a list of all selected sections.  This is the case when
the region begins in the heading of a section and ends in the
heading of a sibling of that first section.  When the selection is
not valid then return nil.  Most commands that can act on the
selected sections, then instead just act on the current section, the
one point is in.

When the region looks like it would in any other buffer then the
selection is invalid.  When the selection is valid then the region
uses the @code{magit-section-highlight}.  This does not apply to diffs where
things get a bit more complicated, but even here if the region looks
like it usually does, then that's not a valid selection as far as
this function is concerned.
@end defun

@defun magit-region-values &rest types

Return a list of the values of the selected sections.

Also see @code{magit-region-sections} whose doc-string explains when a
region is a valid section selection.  If the region is not active
or is not a valid section selection, then return nil.  If optional
TYPES is non-nil then the selection not only has to be valid; the
types of all selected sections additionally have to match one of
TYPES, or nil is returned.
@end defun

@node Matching sections
@subsection Matching sections

@table @asis
@kindex M-x magit-describe-section
@cindex magit-describe-section
@item @kbd{M-x magit-describe-section} @tie{}@tie{}@tie{}@tie{}(@code{magit-describe-section})

Show information about the section at point.  This command is
intended for debugging purposes.

@end table

@defun magit-section-ident

Return an unique identifier for SECTION.  The return value has the
form @code{((TYPE . VALUE)...)}.
@end defun

@defun magit-get-section

Return the section identified by IDENT.  IDENT has to be a list as
returned by @code{magit-section-ident}.
@end defun

@defun magit-section-match condition &optional section

Return @code{t} if SECTION matches CONDITION.  SECTION defaults to the
section at point.

Conditions can take the following forms:
@itemize
@item
@code{(CONDITION...)}

matches if any of the CONDITIONs matches.


@item
@code{[TYPE...]}

matches if the first TYPE matches the type of the section at
point, the second matches that of its parent, and so on.


@item
@code{[* TYPE...]}

matches sections that match [TYPE@dots{}] and also recursively all
their child sections.


@item
@code{TYPE}

matches TYPE regardless of its parents.
@end itemize
Each TYPE is a symbol.  Note that is not necessary to specify all
TYPEs up to the root section as printed by @code{magit-describe-type},
unless of course your want to be that precise.
@end defun

@defun magit-section-when condition &rest body

If the section at point matches CONDITION evaluate BODY.

If the section matches evaluate BODY forms sequentially and return
the value of the last one, or if there are no BODY forms return the
value of the section.  If the section does not match return nil.

See @code{magit-section-match} for the forms CONDITION can take.
@end defun

@defun magit-section-case &rest clauses

Choose among clauses on the type of the section at point.

Each clause looks like (CONDITION BODY@dots{}).  The type of the
section is compared against each CONDITION; the BODY forms of the
first match are evaluated sequentially and the value of the last
form is returned.  Inside BODY the symbol @code{it} is bound to the
section at point.  If no clause succeeds or if there is no
section at point return nil.

See @code{magit-section-match} for the forms CONDITION can take.
Additionally a CONDITION of t is allowed in the final clause and
matches if no other CONDITION match, even if there is no section at
point.
@end defun

@defvar magit-root-section

The root section in the current buffer.  All other sections are
descendants of this section.  The value of this variable is set by
@code{magit-insert-section} and you should never modify it.
@end defvar

For diff related sections a few additional tools exist.

@defun magit-diff-type &optional section

Return the diff type of SECTION.

The returned type is one of the symbols @code{staged}, @code{unstaged}, @code{committed},
or @code{undefined}.  This type serves a similar purpose as the general
type common to all sections (which is stored in the @code{type} slot of the
corresponding @code{magit-section} struct) but takes additional information
into account.  When the SECTION isn't related to diffs and the
buffer containing it also isn't a diff-only buffer, then return nil.

Currently the type can also be one of @code{tracked} and @code{untracked}, but
these values are not handled explicitly in every place they should
be.  A possible fix could be to just return nil here.

The section has to be a @code{diff} or @code{hunk} section, or a section whose
children are of type @code{diff}.  If optional SECTION is nil, return the
diff type for the current section.  In buffers whose major mode is
@code{magit-diff-mode} SECTION is ignored and the type is determined using
other means.  In @code{magit-revision-mode} buffers the type is always
@code{committed}.
@end defun

@defun magit-diff-scope &optional section strict

Return the diff scope of SECTION or the selected section(s).

A diff's "scope" describes what part of a diff is selected, it is a
symbol, one of @code{region}, @code{hunk}, @code{hunks}, @code{file}, @code{files}, or @code{list}.  Do not
confuse this with the diff "type", as returned by @code{magit-diff-type}.

If optional SECTION is non-nil, then return the scope of that,
ignoring the sections selected by the region.  Otherwise return the
scope of the current section, or if the region is active and selects
a valid group of diff related sections, the type of these sections,
i.e. @code{hunks} or @code{files}.  If SECTION (or if the current section that
is nil) is a @code{hunk} section and the region starts and ends inside
the body of a that section, then the type is @code{region}.

If optional STRICT is non-nil then return nil if the diff type of
the section at point is @code{untracked} or the section at point is not
actually a @code{diff} but a @code{diffstat} section.
@end defun

@node Refreshing buffers
@section Refreshing buffers

All commands that create a new Magit buffer or change what is being
displayed in an existing buffer do so by calling @code{magit-mode-setup}.
Among other things, that function sets the buffer local values of
@code{default-directory} (to the top-level of the repository),
@code{magit-refresh-function}, and @code{magit-refresh-args}.

Buffers are refreshed by calling the function that is the local value
of @code{magit-refresh-function} (a function named @code{magit-*-refresh-buffer},
where @code{*} may be something like @code{diff}) with the value of
@code{magit-refresh-args} as arguments.

@defmac magit-mode-setup buffer switch-func mode refresh-func &optional refresh-args

This function displays and selects BUFFER, turns on MODE, and
refreshes a first time.

This function displays and optionally selects BUFFER by calling
@code{magit-mode-display-buffer} with BUFFER, MODE and SWITCH-FUNC as
arguments.  Then it sets the local value of @code{magit-refresh-function}
to REFRESH-FUNC and that of @code{magit-refresh-args} to REFRESH-ARGS.
Finally it creates the buffer content by calling REFRESH-FUNC with
REFRESH-ARGS as arguments.

All arguments are evaluated before switching to BUFFER.
@end defmac

@defun magit-mode-display-buffer buffer mode &optional switch-function

This function display BUFFER in some window and select it.  BUFFER
may be a buffer or a string, the name of a buffer.  The buffer is
returned.

Unless BUFFER is already displayed in the selected frame, store the
previous window configuration as a buffer local value, so that it
can later be restored by @code{magit-mode-bury-buffer}.

The buffer is displayed and selected using SWITCH-FUNCTION.  If that
is @code{nil} then @code{pop-to-buffer} is used if the current buffer's major mode
derives from @code{magit-mode}.  Otherwise @code{switch-to-buffer} is used.
@end defun

@defvar magit-refresh-function

The value of this buffer-local variable is the function used to
refresh the current buffer.  It is called with @code{magit-refresh-args} as
arguments.
@end defvar

@defvar magit-refresh-args

The list of arguments used by @code{magit-refresh-function} to refresh the
current buffer.  @code{magit-refresh-function} is called with these
arguments.

The value is usually set using @code{magit-mode-setup}, but in some cases
it's also useful to provide commands which can change the value.  For
example, the @code{magit-diff-refresh-popup} can be used to change any of
the arguments used to display the diff, without having to specify
again which differences should be shown.  @code{magit-diff-more-context},
@code{magit-diff-less-context}, and @code{magit-diff-default-context} change just
the @code{-U<N>} argument.  In both case this is done by changing the value
of this variable and then calling this @code{magit-refresh-function}.
@end defvar

@node Conventions
@section Conventions


@menu
* Confirmation and completion::
* Theming Faces::
@end menu

@node Confirmation and completion
@subsection Confirmation and completion

Dangerous operations that may lead to data loss have to be confirmed
by default.  With a multi-section selection, this is done using
questions that can be answered with "yes" or "no".  When the region isn't
active, or if it doesn't constitute a valid section selection, then
such commands instead read a single item in the minibuffer.  When the
value of the current section is among the possible choices, then that
is presented as default choice.  To confirm the action on a single
item, the user has to answer @code{RET} (instead of "yes"), and to abort, @code{C-g}
(instead of "no").  But alternatively the user may also select another
item, just like if the command had been invoked with no suitable
section at point at all.

@node Theming Faces
@subsection Theming Faces

The default theme uses blue for local branches, green for remote
branches, and goldenrod (brownish yellow) for tags.  When creating a
new theme, you should probably follow that example.  If your theme
already uses other colors, then stick to that.

In older releases these reference faces used to have a background
color and a box around them.  The basic default faces no longer do so,
to make Magit buffers much less noisy, and you should follow that
example at least with regards to boxes.  (Boxes were used in the past
to work around a conflict between the highlighting overlay and text
property backgrounds.  That's no longer necessary because highlighting no
longer causes other background colors to disappear.)  Alternatively
you can keep the background color and/or box, but then have to take
special care to adjust @code{magit-branch-current} accordingly.  By default
it looks mostly like @code{magit-branch-local}, but with a box (by default
the former is the only face that uses a box, exactly so that it sticks
out).  If the former also uses a box, then you have to make sure that
it differs in some other way from the latter.

The most difficult faces to theme are those related to diffs,
headings, highlighting, and the region.  There are faces that fall
into all four groups - expect to spend some time getting this right.

The @code{region} face in the default theme, in both the light and dark
variants, as well as in many other themes, distributed with Emacs or
by third-parties, is very ugly.  It is common to use a background
color that really sticks out, which is ugly but if that were the only
problem then it would be acceptable.  Unfortunately many themes also
set the foreground color, which ensures that all text within the
region is readable.  Without doing that there might be cases where
some foreground color is too close to the region background color to
still be readable.  But it also means that text within the region
loses all syntax highlighting.

I consider the work that went into getting the @code{region} face right to be
a good indicator for the general quality of a theme.  My
recommendation for the @code{region} face is this: use a background color
slightly different from the background color of the @code{default} face, and
do not set the foreground color at all.  So for a light theme you
might use a light (possibly tinted) gray as the background color of
@code{default} and a somewhat darker gray for the background of @code{region}.
That should usually be enough to not collide with the foreground color
of any other face.  But if some other faces also set a light gray as
background color, then you should also make sure it doesn't collide
with those (in some cases it might be acceptable though).

Magit only uses the @code{region} face when the region is "invalid" by its
own definition.  In a Magit buffer the region is used to either select
multiple sibling sections, so that commands which support it act on
all of these sections instead of just the current section, or to
select lines within a single hunk section.  In all other cases, the
section is considered invalid and Magit won't act on it.  But such
invalid sections happen, either because the user has not moved point
enough yet to make it valid or because she wants to use a non-magit
command to act on the region, e.g. @code{kill-region}.

So using the regular @code{region} face for invalid sections is a feature.  It
tells the user that Magit won't be able to act on it.  It's acceptable
if that face looks a bit odd and even (but less so) if it collides
with the background colors of section headings and other things that
have a background color.

Magit highlights the current section.  If a section has subsections,
then all of them are highlighted.  This is done using faces that have
"highlight" in their names.  For most sections, @code{magit-section-highlight}
is used for both the body and the heading.  Like the @code{region} face, it
should only set the background color to something similar to that of
@code{default}.  The highlight background color must be different from both
the @code{region} background color and the @code{default} background color.

For diff related sections Magit uses various faces to
highlight different parts of the selected section(s).  Note that hunk
headings, unlike all other section headings, by default have a
background color, because it is useful to have very visible separators
between hunks.  That face @code{magit-diff-hunk-heading}, should be different
from both @code{magit-diff-hunk-heading-highlight} and
@code{magit-section-highlight}, as well as from @code{magit-diff-context} and
@code{magit-diff-context-highlight}.  By default we do that by changing the
foreground color.  Changing the background color would lead to
complications, and there are already enough we cannot get around.
(Also note that it is generally a good idea for section headings to
always be bold, but only for sections that have subsections).

When there is a valid region selecting diff-related sibling sections,
i.e. multiple files or hunks, then the bodies of all these sections
use the respective highlight faces, but additionally the headings
instead use one of the faces @code{magit-diff-file-heading-selection} or
@code{magit-diff-hunk-heading-selection}.  These faces have to be different
from the regular highlight variants to provide explicit visual
indication that the region is active.

When theming diff related faces, start by setting the option
@code{magit-diff-refine-hunk} to @code{all}.  You might personally prefer to only
refine the current hunk or not use hunk refinement at all, but some of
the users of your theme want all hunks to be refined, so you have to
cater to that.

(Also turn on @code{magit-diff-highlight-indentation},
@code{magit-diff-highlight-trailing}, and @code{magit-diff-paint-whitespace}; and
insert some whitespace errors into the code you use for testing.)

For e.g. "added lines" you have to adjust three faces:
@code{magit-diff-added}, @code{magit-diff-added-highlight}, and
@code{smerge-refined-added}.  Make sure that the latter works well with both
of the former, as well as @code{smerge-other} and @code{diff-added}.  Then do the
same for the removed lines, context lines, lines added by us, and
lines added by them.  Also make sure the respective added, removed,
and context faces use approximately the same saturation for both the
highlighted and unhighlighted variants.  Also make sure the file and
diff headings work nicely with context lines (e.g. make them look
different).  Line faces should set both the foreground and the
background color.  For example, for added lines use two different
greens.

It's best if the foreground color of both the highlighted and the
unhighlighted variants are the same, so you will need to have to find
a color that works well on the highlight and unhighlighted background,
the refine background, and the highlight context background.  When
there is an hunk internal region, then the added- and removed-lines
background color is used only within that region.  Outside the region
the highlighted context background color is used.  This makes it
easier to see what is being staged.  With an hunk internal region the
hunk heading is shown using @code{magit-diff-hunk-heading-selection}, and so
are the thin lines that are added around the lines that fall within
the region.  The background color of that has to be distinct enough
from the various other involved background colors.

Nobody said this would be easy.  If your theme restricts itself to a
certain set of colors, then you should make an exception here.
Otherwise it would be impossible to make the diffs look good in each
and every variation.  Actually you might want to just stick to the
default definitions for these faces.  You have been warned.  Also
please note that if you do not get this right, this will in some cases
look to users like bugs in Magit - so please do it right or not at
all.

@node FAQ
@appendix FAQ

Below you find a list of frequently asked questions.  For a list of
frequently @strong{and recently} asked questions, i.e. questions that haven't
made it into the manual yet, see @uref{https://github.com/magit/magit/wiki/FAQ}.

@menu
* Magit is slow::
* I am having problems committing::
* I am using an Emacs release older than 24.4: I am using an Emacs release older than 244. 
* I am using a Git release older than 1.9.4: I am using a Git release older than 194. 
* I am using MS Windows and cannot push with Magit::
* How to install the gitman info manual?::
* How can I show Git's output?::
* Expanding a file to show the diff causes it to disappear::
* Magit claims repository accessed using Tramp does not exist::
* Can Magit be used as ediff-version-control-package?::
* How to show diffs for gpg-encrypted files?::
* Emacs 24.5 hangs when loading Magit: Emacs 245 hangs when loading Magit. 
@end menu

@node Magit is slow
@section Magit is slow

See @ref{Performance,Performance}.

@node I am having problems committing
@section I am having problems committing

That likely means that Magit is having problems finding an appropriate
emacsclient executable.  See @ref{Configuring With-Editor,,,with-editor,}
and @ref{Debugging,,,with-editor,}.

@node I am using an Emacs release older than 244
@section I am using an Emacs release older than 24.4

At least version 24.4 is required.  There is no way around it.

If you own the machine you work on, then consider updating to the
latest release provided by your distribution.  If it doesn't feature a
recent enough release, then you will have to use a backport package or
build Emacs from source.

Installing Emacs from source is quite simple. See the instructions at
@uref{http://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL} and
@uref{http://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL.REPO} to get an
idea of that this involves.  But when you perform the installation
then use the instructions for the release you are actually installing.

Unfortunately these instructions do not cover the hardest part (which
is the hardest part exactly because it is not covered there):
installing the build time dependencies.

For that you'll need to perform a web search and find an appropriate
tutorial for your distribution.  If you think you should not have had
to do that yourself, then consider informing me about the resources
that helped you figure what to do for your specific setup, so that I
can post a link here.  That way those coming after you have it easier.

@node I am using a Git release older than 194
@section I am using a Git release older than 1.9.4

At least version 1.9.4 is required.  There is no way around it.

If you own the machine, then consider updating to the latest release
provided by your distribution.  If it doesn't feature a recent enough
release, then you will have to use a backport package or build Git
from source.

Installing Git from source is quite simple. See the instructions at
@uref{https://github.com/git/git/blob/master/INSTALL} to get an idea of that
this involves.  But when you perform the installation then use the
instructions for the release you are actually installing.

@node I am using MS Windows and cannot push with Magit
@section I am using MS Windows and cannot push with Magit

It's almost certain that Magit is only incidental to this issue.  It
is much more likely that this is a configuration issue, even if you
can push on the command line.

Detailed setup instructions can be found at
@uref{https://github.com/magit/magit/wiki/Pushing-with-Magit-from-Windows}.

@node How to install the gitman info manual?
@section How to install the gitman info manual?

Git's manpages can be exported as an info manual called @code{gitman}.
Magit's own info manual links to nodes in that manual instead of the
actual manpages because texinfo sadly doesn't support linking to
manpages.

Unfortunately many distributions do not install the @code{gitman} manual by
default.  Some distributions may provide a separate package containing
the info manual.  Please let me know the name of that package for your
distribution, so that I can mention here.

If the distribution you are using does not offer a package that
contains the @code{gitman} manual, then you have to install it manually.
Clone Git's own Git repository, checkout the tag corresponding to the
Git release you have installed, and follow the instructions in
@code{INSTALL}.  The relevant make targets are @code{info} and @code{install-info}.

Alternatively you may add this advice to your @code{init.el} file.

@lisp
(defadvice Info-follow-nearest-node (around gitman activate)
  "When encountering a cross reference to the `gitman' info
manual, then instead of following that cross reference show
the actual manpage using the function `man'."
  (let ((node (Info-get-token
               (point) "\\*note[ \n\t]+"
               "\\*note[ \n\t]+\\([^:]*\\):\\(:\\|[ \n\t]*(\\)?")))
    (if (and node (string-match "^(gitman)\\(.+\\)" node))
        (progn (require 'man)
               (man (match-string 1 node)))
      ad-do-it)))
@end lisp

Or if you are using MS Windows and @code{man} is not available, use this
variation with used the Emacs Lisp implementation provided by the
@code{woman} package.

@lisp
(defadvice Info-follow-nearest-node (around gitman activate)
  "When encountering a cross reference to the `gitman' info
manual, then instead of following that cross reference show
the actual manpage using the function `woman'."
  (let ((node (Info-get-token
               (point) "\\*note[ \n\t]+"
               "\\*note[ \n\t]+\\([^:]*\\):\\(:\\|[ \n\t]*(\\)?")))
    (if (and node (string-match "^(gitman)\\(.+\\)" node))
        (progn (require 'woman)
               (woman (match-string 1 node)))
      ad-do-it)))
@end lisp

Did I mention that texinfo cross reference are just awful?  (This is
just one of many issues.)

@node How can I show Git's output?
@section How can I show Git's output?

To show the output of recently run git commands, press @code{$} (or, if that
isn't available, @code{M-x magit-process-buffer}).  This will show a buffer
containing a section per git invocation; as always press @code{TAB} to expand
or collapse them.

By default git's output is only inserted into the process buffer if it
is run for side-effects.  When the output is consumed in some way then
also inserting it into the process buffer would be to expensive.  For
debugging purposes it's possible to do so anyway by setting
@code{magit-git-debug} to @code{t}.

@node Expanding a file to show the diff causes it to disappear
@section Expanding a file to show the diff causes it to disappear

This is probably caused by a change of a @code{diff.*} Git variable.  You
probably set that variable for a reason, and should therefore
only undo that setting in Magit by customizing
@code{magit-git-global-arguments}.

@node Magit claims repository accessed using Tramp does not exist
@section Magit claims repository accessed using Tramp does not exist

"There is no Git repository in /ssh:host:/path/to/repository".

Magit requires at least version @code{1.9.4}.  When connecting to a remote
machine using Tramp it requires that same version on that remote.

By default Tramp searches for programs in the directories given by the
output of @code{getconf PATH} on the remote host.  Therefore, if the remote
git version that you intend to use lives in a non-standard location,
you may need to alter @code{tramp-remote-path}.  Consult the Tramp
documentation on remote programs
@uref{http://www.gnu.org/software/emacs/manual/html_node/tramp/Remote-Programs.html}
for details.

There are others reasons why Magit/Git might think that there is no
repository where there actually is one, but when this is being
reported then it's usually the above.

@node Can Magit be used as ediff-version-control-package?
@section Can Magit be used as ediff-version-control-package?

No, it cannot.  For that to work the functions @code{ediff-magit-internal}
and @code{ediff-magit-merge-internal} would have to be implemented, and they
are not.  These two functions are only used by the three commands
@code{ediff-revision}, @code{ediff-merge-revisions-with-ancestor}, and
@code{ediff-merge-revisions}.

These commands only delegate the task of populating buffers with
certain revisions to the "internal" functions.  The equally important
task of determining which revisions are to be compared/merged is not
delegated.  Instead this is done without any support whatsoever, from
the version control package/system - meaning that the user has to
enter the revisions explicitly.  Instead of implementing
@code{ediff-magit-internal} we provide @code{magit-ediff-compare}, which handles
both tasks like it is 2005.

The other commands @code{ediff-merge-revisions} and
@code{ediff-merge-revisions-with-ancestor} are normally not what you want
when using a modern version control system like Git.  Instead of
letting the user resolve only those conflicts which Git could not
resolve on its own, they throw away all work done by Git and then
expect the user to manually merge all conflicts, including those that
had already been resolved.  That made sense back in the days when
version control systems couldn't merge (or so I have been told), but
not anymore.  Once in a blue moon you might actually want to see all
conflicts, in which case you @strong{can} use these commands, which then use
@code{ediff-vc-merge-internal}.  So we don't actually have to implement
@code{ediff-magit-merge-internal}.  Instead we provide the more useful
command @code{magit-ediff-resolve} which only shows yet-to-be resolved
conflicts.

@node How to show diffs for gpg-encrypted files?
@section How to show diffs for gpg-encrypted files?

Git supports showing diffs for encrypted files, but has to be told to
do so.  Since Magit just uses Git to get the diffs, configuring Git
also affects the diffs displayed inside Magit.

@example
git config --global diff.gpg.textconv "gpg --no-tty --decrypt"
echo "*.gpg filter=gpg diff=gpg" > .gitattributes
@end example

@node Emacs 245 hangs when loading Magit
@section Emacs 24.5 hangs when loading Magit

This is actually triggered by loading Tramp.  See
@uref{https://debbugs.gnu.org/cgi/bugreport.cgi?bug~20015} for details. You
can work around the problem by setting
@code{tramp-ssh-controlmaster-options}. Changing your DNS server (e.g. to
Google's @code{8.8.8.8}) may also be sufficient to work around the issue.

@node Keystroke Index
@appendix Keystroke Index

@printindex ky

@node Command Index
@appendix Command Index

@printindex cp

@node Function Index
@appendix Function Index

@printindex fn

@node Variable Index
@appendix Variable Index

@printindex vr

@bye