diff options
Diffstat (limited to 'site/projects/git-auto-commit-mode.org')
| -rw-r--r-- | site/projects/git-auto-commit-mode.org | 129 |
1 files changed, 80 insertions, 49 deletions
diff --git a/site/projects/git-auto-commit-mode.org b/site/projects/git-auto-commit-mode.org index c7b0b99..16ff986 100644 --- a/site/projects/git-auto-commit-mode.org +++ b/site/projects/git-auto-commit-mode.org @@ -1,10 +1,7 @@ #+TITLE: git-auto-commit-mode -#+STYLE: <link rel="stylesheet" type="text/css" href="../../stylesheet.css" /> -#+LINK_UP: ../index.html -#+LINK_HOME: http://ryuslash.org -#+LINK: src https://github.com/ryuslash/git-auto-commit-mode -#+LINK: tar_gz https://github.com/ryuslash/git-auto-commit-mode/tarball/master -#+LINK: zip https://github.com/ryuslash/git-auto-commit-mode/zipball/master +#+LINK: src http://code.ryuslash.org/cgit.cgi/emacs/git-auto-commit-mode/ +#+LINK: tar_gz http://code.ryuslash.org/cgit.cgi/emacs/git-auto-commit-mode/snapshot/git-auto-commit-mode-master.tar.gz +#+LINK: zip http://code.ryuslash.org/cgit.cgi/emacs/git-auto-commit-mode/snapshot/git-auto-commit-mode-master.zip #+STARTUP: showall #+begin_html @@ -19,73 +16,107 @@ * About - ~git-auto-commit-mode~ is a minor mode for GNU - Emacs[fn::http://gnu.org/software/emacs/] that, when enabled, tries - to commit changes to a file after every save. It can also try to - push to the default upstream. + ~git-auto-commit-mode~ is a minor mode for GNU Emacs that, when + enabled, tries to commit changes to a file after every save. It can + also try to push to the default upstream. -** Features + | Status | On-hold | + | Language | Emacs Lisp | + | Licennse | GPLv3 | - - Automatically commit changes to a file after each save. +* Features - - The commit message will contain the file name relative to the - repository root. + - Automatically commit changes to a file after each save. - - Optionally, automatically push commits to the default upstream. + - The commit message will contain the file name relative to the + repository root. -** Requirements + - Optionally, automatically push commits to the default upstream. - These should be mostly obvious. +* Requirements - - [[http://gnu.org/software/emacs][GNU Emacs]] - - [[http://git-scm.com][git]] + - [[http://gnu.org/software/emacs][GNU Emacs]] + - [[http://git-scm.com][git]] -* Usage +* Download + + There are download links for a ~tar.gz~ and a ~zip~ file of the latest + development version at the top of this page. + + ~git-auto-commit-mode~ is in the [[http://marmalade-repo.org/][Marmalade]] repo. + +* Install + + Once you have [[Download][downloaded]] ~git-auto-commit-mode~ you have at least 2 + choices for installation. + +** package.el + + If you have Emacs v24+ or [[http://tromey.com/elpa/install.html][package.el]] and Marmalade configured, you + can just: + + #+BEGIN_SRC emacs-lisp + (package-install "git-auto-commit-mode") + #+END_SRC - To be able to use it you need to put it somewhere in your - ~load-path~ and load it, for example: +** manual - #+begin_src emacs-lisp - (add-to-list 'load-path "~/path/to/git-auto-commit-mode.el") - (auto load 'git-auto-commit-mode "git-auto-commit-mode") - #+end_src + Otherwise you have to [[Download][dowload]] it and then put it somewhere in your + =load-path=, or add that location to your =load-path=: -** Automatically commit + #+begin_src emacs-lisp + (add-to-list 'load-path "~/location/of/git-auto-commit-mode") + #+end_src + + After which you can either ~require~ the package in your Emacs init + file: + + #+BEGIN_SRC emacs-lisp + (require 'git-auto-commit-mode) + #+END_SRC + + Or set-up some autoloads: + + #+BEGIN_SRC emacs-lisp + (autoload 'git-auto-commit-mode "git-auto-commit-mode" nil t) + #+END_SRC + +* Usage There are a few ways this could be used: -*** As file-local variable +** As file-local variable - This is the way I use it and I wanted to use it. Any file that you - would like to have automatically committed upon saving gets this - prop-line: + This is the way I use it and I wanted to use it. Any file that you + would like to have automatically committed upon saving gets this + prop-line: - #+BEGIN_SRC emacs-lisp - ;; -*- eval: (git-auto-commit-mode 1) -*- - #+END_SRC + #+BEGIN_SRC emacs-lisp + ;; -*- eval: (git-auto-commit-mode 1) -*- + #+END_SRC - Or, if you're in anything older than emacs 24: + Or, if you're in anything older than emacs 24: - #+BEGIN_SRC emacs-lisp - ;; -*- mode: git-auto-commit -*- - #+END_SRC + #+BEGIN_SRC emacs-lisp + ;; -*- mode: git-auto-commit -*- + #+END_SRC -*** As a directory-local variable +** As a directory-local variable - Put the following in a ~.dir-locals.el~ file in any directory where - you want to enable ~git-auto-commit-mode~ for *all* files: + Put the following in a ~.dir-locals.el~ file in any directory where + you want to enable ~git-auto-commit-mode~ for *all* files: - #+BEGIN_SRC emacs-lisp - ((nil . ((git-auto-commit-mode . t)))) - #+END_SRC + #+BEGIN_SRC emacs-lisp + ((nil . ((git-auto-commit-mode . t)))) + #+END_SRC -*** As a hook +** As a hook - I doubt this will ever really be useful, but it is possible: + I doubt this will ever really be useful, but it is possible: - #+BEGIN_SRC emacs-lisp - (add-hook 'some-hook 'git-auto-commit-mode) - #+END_SRC + #+BEGIN_SRC emacs-lisp + (add-hook 'some-hook 'git-auto-commit-mode) + #+END_SRC ** Automatically push |