]> git.ipfire.org Git - thirdparty/git.git/commit
api-parse-options.adoc: document hidden and OPT_*_F option macros
authorChristian Couder <christian.couder@gmail.com>
Thu, 16 Jul 2026 16:55:13 +0000 (18:55 +0200)
committerJunio C Hamano <gitster@pobox.com>
Thu, 16 Jul 2026 21:11:13 +0000 (14:11 -0700)
commit1589064f3301e7a7066a08063469da7e4014c128
treedb3c9ffe6494328675a8bd007e44213b6f57d71a
parentbdc8088f44fa9e289ad8714d1c8a29a0001f4239
api-parse-options.adoc: document hidden and OPT_*_F option macros

In "Documentation/technical/api-parse-options.adoc", the list of option
macros does not mention the `OPT_*_F()` macro variants that take a
trailing `flags` argument, nor the `OPT_HIDDEN_GROUP()` and
`OPT_HIDDEN_BOOL()` convenience macros.

Now that a previous commit documents the per-option flags, let's
document these macros too:

  - Add a paragraph explaining the `OPT_*_F` convention and how it
    relates to the per-option flags.

  - Document `OPT_HIDDEN_GROUP()`, introduced in a previous commit,
    right after `OPT_GROUP()`.

  - Document `OPT_HIDDEN_BOOL()` right after `OPT_BOOL()`.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-parse-options.adoc