summaryrefslogtreecommitdiffstats
path: root/site/projects/git-auto-commit-mode.org
blob: d39cadb1893217c34e9ca964f474ced4bcd36bf6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#+TITLE: git-auto-commit-mode
#+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
#+LINK: readme http://code.ryuslash.org/cgit.cgi/emacs/git-auto-commit-mode/about/
#+LINK: manual http://ryulash.org/projects/git-auto-commit-mode/manual/
#+STARTUP: showall

#+begin_html
  <script src="/keyjs.js" type="text/javascript"></script>
  <script type="text/javascript">
    keyjs_initialize({ "u": [ "keyjs_goto", "../index.html" ],
                       "h": [ "keyjs_goto", "http://ryuslash.org" ] });
  </script>
#+end_html

#+INCLUDE: "dlmenu.inc"

* What does it do?

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

* Why was it written?

  Some projects / files don't need a very fancy commit log or anything
  and are typically only modified in small ways. Configuration files
  are a good example, where most changes are just single lines added,
  removed or changed. In these projects it can save some effort to
  just automatically commit them after every change.

* Who is it for?

  Anyone who makes a lot of small, separate, changes to a bunch if
  git-tracked files and is tired of always having to go through the
  =git add; git commit -m description= process.

* Data

  | Version  | 0 (development only) |
  | Language | Emacs Lisp           |
  | License  | GPLv3                |

** Features

   - Automatically commit changes to a file after each save.
     - The commit message will contain the file name relative to the
       repository root.
   - Optionally, automatically push commits to the default upstream.

** Dependencies

   - [[http://gnu.org/software/emacs][GNU Emacs]] :: It is developed using Emacs 24, though I am not
                  averse to supporting older versions.
   - [[http://git-scm.com][git]] :: I am not aware of any version restrictions.

* More...

  For further instructinos I would refer you to the [[readme][README]] and [[manual]].