emacs.d/elpa/magit-20150608.1139

It's Magit! A Git Porcelain inside Emacs

Magit is an interface to the version control system Git, implemented as an Emacs package.

Unlike the VC package which is part of Emacs and strives to provide a unified interface to various version control systems, Magit only supports Git and can therefore better take advantage of its native features.

Magit supports GNU Emacs 23.2 or later; 24.1 or later is recommended. Magit supports Git 1.7.2.5 or later; 1.8.2 or later is recommended.

Table of Contents

• Installation
• Getting Started
• Getting Help
• Contributions
• Dependencies

Installation

We recommend that you use Emacs' package manager (package.el), to install Magit from your preferred Elpa archive (Melpa, Melpa-Stable, or Marmalade). If you haven't used the package manager before, or would like to install directly from Magit's Git repository, then consult the detailed installation instructions.

Getting Started

To get started with Magit show a summary of its status in a new buffer using M-x magit-status RET. Navigate the buffer using n and p, and toggle sections using TAB. Edit and save some files, refresh the status buffer using g, stage files or individual hunks using s and initiate a commit using c c the staged changes. When done writing the commit message use C-c C-c to actually create the commit.

For more details consult the user manual. You can read it with C-u C-h i magit.info RET or on the web. Magit also has a website.

Getting Help

When something doesn't work as expected please see the FAQ, and the list of open issues, and use the search box at the top of the latter to find older related issues. If everything else fails ask for help on the Emacs Stackexchange site or the mailing list.

Contributions

Magit is hosted on Github. Please contribute by reporting bugs and suggesting features on the issue tracker or by making code contributions using pull requests. Before opening a pull request read the brief contribution guidelines.

Please also consider supporting development by making a monetary donation. Thank you!

Magit was started by Marius Vollmer and is now maintained by Jonas Bernoulli. Other Magitians (former maintainers) are Nicolas Dudebout, Peter J. Weisberg, Phil Jackson, Rémi Vanicat, and Yann Hodique.

Many more people have contributed code and suggested features.

Thanks to all of you, may (the history of) the source be with you!

Dependencies

If you install Magit using Emacs' package manager then dependencies are automatically being taken care of. Otherwise you have to track down dependencies and install them manually.

Magit requires the libraries git-commit-mode and git-rebase-mode which are part of the magit/git-modes repository and are distributed as separate packages.

The library magit-wip additionally requires the git-wip script, which you have to install manually.