From: "Martin Ågren" <martin.agren@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>
Subject: [PATCH v3 1/7] builtin.h: take over documentation from api-builtin.txt
Date: Wed, 2 Aug 2017 21:40:49 +0200 [thread overview]
Message-ID: <e660a9cdaff6d114305a475f9a12876b56b473d1.1501701128.git.martin.agren@gmail.com> (raw)
In-Reply-To: <cover.1501701128.git.martin.agren@gmail.com>
Delete Documentation/technical/api-builtin.txt and move its content
into builtin.h. Format it as a comment. Remove a '+' which was needed
when the information was formatted for AsciiDoc. Similarly, change
"::" to ":".
Document SUPPORT_SUPER_PREFIX, thereby bringing the documentation up to
date with the available flags.
While at it, correct '3 more things to do' to '4 more things to do'.
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
---
I'm still documenting SUPPORT_SUPER_PREFIX. As Junio pointed out, a
nearby patch series is working on losing it (or one user of it). I tried
removing that part, but felt like I was leaving things incomplete.
Documentation/technical/api-builtin.txt | 73 ------------------------------
builtin.h | 80 +++++++++++++++++++++++++++++++++
2 files changed, 80 insertions(+), 73 deletions(-)
delete mode 100644 Documentation/technical/api-builtin.txt
diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt
deleted file mode 100644
index 22a39b929..000000000
--- a/Documentation/technical/api-builtin.txt
+++ /dev/null
@@ -1,73 +0,0 @@
-builtin API
-===========
-
-Adding a new built-in
----------------------
-
-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
- signature:
-
- int cmd_foo(int argc, const char **argv, const char *prefix);
-
-. Add the external declaration for the function to `builtin.h`.
-
-. Add the command to the `commands[]` table defined in `git.c`.
- The entry should look like:
-
- { "foo", cmd_foo, <options> },
-+
-where options is the bitwise-or of:
-
-`RUN_SETUP`::
- If there is not a Git directory to work on, abort. 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.
-
-`RUN_SETUP_GENTLY`::
- If there is a Git directory, chdir as per RUN_SETUP, otherwise,
- don't chdir anywhere.
-
-`USE_PAGER`::
-
- 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 only makes 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:
-
-. Add tests to `t/` directory.
-
-. Write documentation in `Documentation/git-foo.txt`.
-
-. Add an entry for `git-foo` to `command-list.txt`.
-
-. Add an entry for `/git-foo` to `.gitignore`.
-
-
-How a built-in is called
-------------------------
-
-The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
-and `prefix`. The first two are similar to what `main()` of a
-standalone command would be called with.
-
-When `RUN_SETUP` is specified in the `commands[]` table, and when you
-were started from a subdirectory of the work tree, `cmd_foo()` is called
-after chdir(2) to the top of the work tree, and `prefix` gets the path
-to the subdirectory the command started from. This allows you to
-convert a user-supplied pathname (typically relative to that directory)
-to a pathname relative to the top of the work tree.
-
-The return value from `cmd_foo()` becomes the exit status of the
-command.
diff --git a/builtin.h b/builtin.h
index 498ac80d0..8d87d06da 100644
--- a/builtin.h
+++ b/builtin.h
@@ -6,6 +6,86 @@
#include "cache.h"
#include "commit.h"
+/*
+ * builtin API
+ * ===========
+ *
+ * Adding a new built-in
+ * ---------------------
+ *
+ * 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
+ * signature:
+ *
+ * int cmd_foo(int argc, const char **argv, const char *prefix);
+ *
+ * . Add the external declaration for the function to `builtin.h`.
+ *
+ * . Add the command to the `commands[]` table defined in `git.c`.
+ * The entry should look like:
+ *
+ * { "foo", cmd_foo, <options> },
+ *
+ * where options is the bitwise-or of:
+ *
+ * `RUN_SETUP`:
+ * If there is not a Git directory to work on, abort. 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.
+ *
+ * `RUN_SETUP_GENTLY`:
+ * If there is a Git directory, chdir as per RUN_SETUP, otherwise,
+ * don't chdir anywhere.
+ *
+ * `USE_PAGER`:
+ *
+ * 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 only makes sense when `RUN_SETUP` is also set.
+ *
+ * `SUPPORT_SUPER_PREFIX`:
+ *
+ * The built-in supports `--super-prefix`.
+ *
+ * . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
+ *
+ * Additionally, if `foo` is a new command, there are 4 more things to do:
+ *
+ * . Add tests to `t/` directory.
+ *
+ * . Write documentation in `Documentation/git-foo.txt`.
+ *
+ * . Add an entry for `git-foo` to `command-list.txt`.
+ *
+ * . Add an entry for `/git-foo` to `.gitignore`.
+ *
+ *
+ * How a built-in is called
+ * ------------------------
+ *
+ * The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
+ * and `prefix`. The first two are similar to what `main()` of a
+ * standalone command would be called with.
+ *
+ * When `RUN_SETUP` is specified in the `commands[]` table, and when you
+ * were started from a subdirectory of the work tree, `cmd_foo()` is called
+ * after chdir(2) to the top of the work tree, and `prefix` gets the path
+ * to the subdirectory the command started from. This allows you to
+ * convert a user-supplied pathname (typically relative to that directory)
+ * to a pathname relative to the top of the work tree.
+ *
+ * The return value from `cmd_foo()` becomes the exit status of the
+ * command.
+ */
+
#define DEFAULT_MERGE_LOG_LEN 20
extern const char git_usage_string[];
--
2.14.0.rc1.12.ge2d9c4613
next prev parent reply other threads:[~2017-08-02 19:41 UTC|newest]
Thread overview: 69+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-07-10 21:55 [PATCH 0/7] tag: more fine-grained pager-configuration Martin Ågren
2017-07-10 21:55 ` [PATCH 1/7] api-builtin.txt: document SUPPORT_SUPER_PREFIX Martin Ågren
2017-07-10 22:50 ` Brandon Williams
2017-07-11 6:32 ` Martin Ågren
2017-07-11 18:23 ` Brandon Williams
2017-07-10 21:55 ` [PATCH 2/7] git.c: let builtins opt for handling `pager.foo` themselves Martin Ågren
2017-07-11 10:24 ` Jeff King
2017-07-11 13:46 ` Martin Ågren
2017-07-11 13:54 ` Jeff King
2017-07-10 21:55 ` [PATCH 3/7] git.c: provide setup_auto_pager() Martin Ågren
2017-07-11 10:37 ` Jeff King
2017-07-11 13:47 ` Martin Ågren
2017-07-10 21:55 ` [PATCH 4/7] t7006: add tests for how git tag paginates Martin Ågren
2017-07-10 21:55 ` [PATCH 5/7] tag: handle `pager.tag`-configuration within the builtin Martin Ågren
2017-07-11 10:38 ` Jeff King
2017-07-10 21:55 ` [PATCH 6/7] tag: make git tag -l consider new config `pager.tag.list` Martin Ågren
2017-07-11 10:41 ` Jeff King
2017-07-11 13:48 ` Martin Ågren
2017-07-10 21:55 ` [PATCH 7/7] tag: make git tag -l use pager by default Martin Ågren
2017-07-11 10:44 ` Jeff King
2017-07-10 22:42 ` [PATCH 0/7] tag: more fine-grained pager-configuration Junio C Hamano
2017-07-11 10:47 ` Jeff King
2017-07-11 16:05 ` Junio C Hamano
2017-07-12 7:29 ` Martin Ågren
2017-07-11 10:19 ` Jeff King
2017-07-11 13:50 ` Martin Ågren
2017-07-11 14:08 ` Jeff King
2017-07-17 20:10 ` [PATCH v2 00/10] tag: only respect `pager.tag` in list-mode Martin Ågren
2017-07-17 20:10 ` [PATCH v2 01/10] builtin.h: take over documentation from api-builtin.txt Martin Ågren
2017-07-17 20:10 ` [PATCH v2 02/10] builtin.h: format documentation-comment properly Martin Ågren
2017-07-17 20:10 ` [PATCH v2 03/10] builtin.h: document SUPPORT_SUPER_PREFIX Martin Ågren
2017-07-17 20:10 ` [PATCH v2 04/10] git.c: let builtins opt for handling `pager.foo` themselves Martin Ågren
2017-07-17 20:10 ` [PATCH v2 05/10] git.c: provide setup_auto_pager() Martin Ågren
2017-07-31 3:34 ` Jeff King
2017-07-31 16:32 ` Junio C Hamano
2017-07-17 20:10 ` [PATCH v2 06/10] t7006: add tests for how git tag paginates Martin Ågren
2017-07-31 3:38 ` Jeff King
2017-07-31 16:37 ` Junio C Hamano
2017-07-31 17:50 ` Martin Ågren
2017-07-17 20:10 ` [PATCH v2 07/10] tag: handle `pager.tag`-configuration within the builtin Martin Ågren
2017-07-17 20:10 ` [PATCH v2 08/10] tag: respect `pager.tag` in list-mode only Martin Ågren
2017-07-31 3:40 ` Jeff King
2017-07-17 20:10 ` [PATCH v2 09/10] tag: change default of `pager.tag` to "on" Martin Ågren
2017-07-17 20:10 ` [PATCH v2 10/10] git.c: ignore pager.* when launching builtin as dashed external Martin Ågren
2017-07-31 3:45 ` Jeff King
2017-07-31 17:42 ` Martin Ågren
2017-07-18 19:13 ` [PATCH v2 00/10] tag: only respect `pager.tag` in list-mode Junio C Hamano
2017-07-20 22:27 ` Junio C Hamano
2017-07-23 18:17 ` Martin Ågren
2017-07-31 3:46 ` Jeff King
2017-07-31 17:44 ` Martin Ågren
2017-07-31 17:45 ` Jeff King
2017-07-31 20:10 ` Junio C Hamano
2017-08-02 19:40 ` [PATCH v3 0/7] " Martin Ågren
2017-08-02 19:40 ` Martin Ågren [this message]
2017-08-03 17:44 ` [PATCH v3 1/7] builtin.h: take over documentation from api-builtin.txt Junio C Hamano
2017-08-04 4:18 ` Martin Ågren
2017-08-04 16:00 ` Junio C Hamano
2017-08-04 16:42 ` Martin Ågren
2017-08-02 19:40 ` [PATCH v3 2/7] git.c: let builtins opt for handling `pager.foo` themselves Martin Ågren
2017-08-02 19:40 ` [PATCH v3 3/7] git.c: provide setup_auto_pager() Martin Ågren
2017-08-02 19:40 ` [PATCH v3 4/7] t7006: add tests for how git tag paginates Martin Ågren
2017-08-02 19:40 ` [PATCH v3 5/7] tag: respect `pager.tag` in list-mode only Martin Ågren
2017-08-02 19:40 ` [PATCH v3 6/7] tag: change default of `pager.tag` to "on" Martin Ågren
2017-08-02 19:40 ` [PATCH v3 7/7] git.c: ignore pager.* when launching builtin as dashed external Martin Ågren
2017-08-03 18:20 ` [PATCH v3 0/7] tag: only respect `pager.tag` in list-mode Junio C Hamano
2017-08-03 19:29 ` Jeff King
2017-08-04 4:21 ` Martin Ågren
2017-08-04 4:59 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e660a9cdaff6d114305a475f9a12876b56b473d1.1501701128.git.martin.agren@gmail.com \
--to=martin.agren@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).