Skip to content

Commit

Permalink
api-builtin.txt: update and fix typo
Browse files Browse the repository at this point in the history
Mention NEED_WORK_TREE flag and command-list.txt.
Fix "bulit-in" typo and AsciiDoc-formatting of a paragraph.

Signed-off-by: Stephan Beyer <s-beyer@gmx.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Stephan Beyer authored and Junio C Hamano committed Jun 23, 2008
1 parent 3b2bbe9 commit 82936f2
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions Documentation/technical/api-builtin.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ builtin API
Adding a new built-in
---------------------

There are 4 things to do to add a bulit-in command implementation to
There are 4 things to do to add a built-in command implementation to
git:

. Define the implementation of the built-in command `foo` with
Expand All @@ -18,8 +18,8 @@ git:
defined in `git.c`. The entry should look like:

{ "foo", cmd_foo, <options> },

where options is the bitwise-or of:
+
where options is the bitwise-or of:

`RUN_SETUP`::

Expand All @@ -33,6 +33,12 @@ git:
If the standard output is connected to a tty, spawn a pager and
feed our output to it.

`NEED_WORK_TREE`::

Make sure there is a work tree, i.e. the command cannot act
on bare repositories.
This makes only sense when `RUN_SETUP` is also set.

. Add `builtin-foo.o` to `BUILTIN_OBJS` in `Makefile`.

Additionally, if `foo` is a new command, there are 3 more things to do:
Expand All @@ -41,8 +47,7 @@ Additionally, if `foo` is a new command, there are 3 more things to do:

. Write documentation in `Documentation/git-foo.txt`.

. Add an entry for `git-foo` to the list at the end of
`Documentation/cmd-list.perl`.
. Add an entry for `git-foo` to `command-list.txt`.


How a built-in is called
Expand Down

0 comments on commit 82936f2

Please sign in to comment.