mirrors/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-08 10:13:18 +01:00
Code Activity

api-builtin.txt: update and fix typo

Browse source 
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>
This commit is contained in:
Stephan Beyer 2008-06-22 01:54:36 +02:00 committed by Junio C Hamano
parent 73f03627f4
commit 8c6cfcddce
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Documentation/technical/api-builtin.txt
View file

@ -4,7 +4,7 @@ builtin API
Adding a new built-in 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: git:
. Define the implementation of the built-in command `foo` with . Define the implementation of the built-in command `foo` with
@ -18,8 +18,8 @@ git:
defined in `git.c`. The entry should look like: defined in `git.c`. The entry should look like:
{ "foo", cmd_foo, <options> }, { "foo", cmd_foo, <options> },
+
where options is the bitwise-or of: where options is the bitwise-or of:
`RUN_SETUP`:: `RUN_SETUP`::
@ -33,6 +33,12 @@ git:
If the standard output is connected to a tty, spawn a pager and If the standard output is connected to a tty, spawn a pager and
feed our output to it. 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`. . Add `builtin-foo.o` to `BUILTIN_OBJS` in `Makefile`.
Additionally, if `foo` is a new command, there are 3 more things to do: Additionally, if `foo` is a new command, there are 3 more things to do:
@ -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`. . Write documentation in `Documentation/git-foo.txt`.
. Add an entry for `git-foo` to the list at the end of . Add an entry for `git-foo` to `command-list.txt`.
`Documentation/cmd-list.perl`.
How a built-in is called How a built-in is called