Re: [PATCH 1/7] api-builtin.txt: document SUPPORT_SUPER_PREFIX

On 11 July 2017 at 00:50, Brandon Williams [off-list ref] wrote:

On 07/10, Martin Ågren wrote:

quoted

Commit 74866d75 ("git: make super-prefix option", 2016-10-07) introduced
SUPPORT_SUPER_PREFIX as a builtin flag without documenting it in
api-builtin.txt. The next patch will add another flag, so document
SUPPORT_SUPER_PREFIX, thereby bringing the documentation up to date with
the available flags.

Signed-off-by: Martin Ågren <redacted>
---
 Documentation/technical/api-builtin.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt
index 22a39b929..60f442822 100644
--- a/Documentation/technical/api-builtin.txt
+++ b/Documentation/technical/api-builtin.txt

@@ -42,6 +42,10 @@ where options is the bitwise-or of:
      on bare repositories.
      This only makes sense when `RUN_SETUP` is also set.

+`SUPPORT_SUPER_PREFIX`::
+
+     The builtin supports --super-prefix.
+
 . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.

 Additionally, if `foo` is a new command, there are 3 more things to do:

I added SUPER_PREFIX as an implementation detail when trying to recurse
submodules using multiple processes.  Now that we have a 'struct
repository' my plan is to remove SUPER_PREFIX in its entirety.  Since
this won't happen overnight it may still take a bit till its removed so
maybe it makes sense to better document it until that happens?

I could add something about how this is "temporary" although I have no
idea about the timeframe. ;-)

Either way I think that this sort of Documention better lives in the
code as it is easier to keep up to date.

Agreed and I believe that's the long-term goal. I could replace this
preparatory patch with another one where I move api-builtin.txt into
builtin.h or git.c (and document SUPPORT_SUPER_PREFIX if that's
wanted). That's probably better, since right now, patch 2/7 adds
basically the same documentation for the new flag in two places.

Martin