Merge branch 'jc/parseopt-command-modes'
[gitweb.git] / Documentation / technical / api-builtin.txt
index 5cb2b0590abb1fc4e4685097ba3cdd3d0683a95f..f3c1357b7cc037681b5d0f28974b199e326f8c2d 100644 (file)
@@ -5,7 +5,7 @@ Adding a new built-in
 ---------------------
 
 There are 4 things to do to add a built-in command implementation to
-git:
+Git:
 
 . Define the implementation of the built-in command `foo` with
   signature:
@@ -23,7 +23,7 @@ where options is the bitwise-or of:
 
 `RUN_SETUP`::
 
-       Make sure there is a git directory to work on, and if there is a
+       Make sure there is a Git directory to work on, and if there is a
        work tree, chdir to the top of it if the command was invoked
        in a subdirectory.  If there is no work tree, no chdir() is
        done.
@@ -39,7 +39,7 @@ where options is the bitwise-or of:
        on bare repositories.
        This only makes sense when `RUN_SETUP` is also set.
 
-. Add `builtin-foo.o` to `BUILTIN_OBJS` in `Makefile`.
+. Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
 
 Additionally, if `foo` is a new command, there are 3 more things to do:
 
@@ -49,6 +49,8 @@ Additionally, if `foo` is a new command, there are 3 more things to do:
 
 . Add an entry for `git-foo` to `command-list.txt`.
 
+. Add an entry for `/git-foo` to `.gitignore`.
+
 
 How a built-in is called
 ------------------------