diff options
| author | Stephan Beyer <s-beyer@gmx.net> | 2008-06-22 01:54:36 +0200 | 
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2008-06-22 18:14:17 -0700 | 
| commit | 82936f295f803a8f1fbe2d89856e9371baa3536c (patch) | |
| tree | 041daf3fa91239ae84d793caccfbc9537ed365ad | |
| parent | 3b2bbe9b8584947e33e9149f605149530faa7361 (diff) | |
| download | git-82936f295f803a8f1fbe2d89856e9371baa3536c.tar.gz | |
api-builtin.txt: update and fix typo
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>
| -rw-r--r-- | Documentation/technical/api-builtin.txt | 15 | 
1 files changed, 10 insertions, 5 deletions
| diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt index 52cdb4c520..7ede1e64e5 100644 --- a/Documentation/technical/api-builtin.txt +++ b/Documentation/technical/api-builtin.txt @@ -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 @@ -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`:: @@ -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: @@ -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 | 
