Files
git/Documentation/config/sideband.adoc
Junio C Hamano 9754b0acda sideband: conditional documentation fix
Duplicate a bit of text on either side of the ifdef/ifndef
conditional documentation in order to avoid "sentence assembly" that
does not fit well with translations, taking hint from the discussion
on a recent topic.

cf. https://lore.kernel.org/git/ff86f877-4b75-403d-a5a4-10ab528a9691@free.fr/

Signed-off-by: Junio C Hamano <gitster@pobox.com>
2026-03-02 10:20:32 -08:00

36 lines
1.3 KiB
Plaintext

sideband.allowControlCharacters::
ifdef::with-breaking-changes[]
By default, control characters that are delivered via the sideband
are masked, except ANSI color sequences. This prevents potentially
unwanted ANSI escape sequences from being sent to the terminal.
endif::with-breaking-changes[]
ifndef::with-breaking-changes[]
By default, no control characters delivered via the sideband
are masked. This is unsafe and will change in Git v3.* to only
allow ANSI color sequences by default, preventing potentially
unwanted ANSI escape sequences from being sent to the terminal.
endif::with-breaking-changes[]
Use this config setting to override this behavior (the value can be
a comma-separated list of the following keywords):
+
--
`color`::
Allow ANSI color sequences, line feeds and horizontal tabs,
but mask all other control characters. This is the default.
`cursor:`:
Allow control sequences that move the cursor. This is
disabled by default.
`erase`::
Allow control sequences that erase charactrs. This is
disabled by default.
`false`::
Mask all control characters other than line feeds and
horizontal tabs.
`true`::
Allow all control characters to be sent to the terminal.
--
sideband.<url>.*::
Apply the `sideband.*` option selectively to specific URLs. The
same URL matching logic applies as for `http.<url>.*` settings.