averello/git-mirror
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2025-12-12 20:36:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: check for absence of the form --[no-]parameter

Browse Source 
For better searchability, this commit adds a check to ensure that parameters
expressed in the form of `--[no-]parameter` are not used in the
documentation.  In the place of such parameters, the documentation should
list two separate parameters: `--parameter` and `--no-parameter`.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jean-Noël Avila
2025-08-11 20:53:18 +00:00
committed by Junio C Hamano
parent ed26022094
commit 03a353bb97
36 changed files with 159 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-gc.adoc
View File

@@ -53,11 +53,13 @@ configuration options such as `gc.auto` and `gc.autoPackLimit`, all
other housekeeping tasks (e.g. rerere, working trees, reflog...) will
be performed as well.
--[no-]detach::
--detach::
--no-detach::
Run in the background if the system supports it. This option overrides
the `gc.autoDetach` config.
--[no-]cruft::
--cruft::
--no-cruft::
When expiring unreachable objects, pack them separately into a
cruft pack instead of storing them as loose objects. `--cruft`
is on by default.