Re: [PATCH] Documentation: indent-with-non-tab uses tabwidth setting, not just 8
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:54:46
"Wesley J. Landaker" [off-list ref] writes:
quoted hunk
From: "Wesley J. Landaker" <redacted> Update the documentation of the core.whitespace option "indent-with-non-tab" to correctly reflect that it uses the currently set tab width, set by the "tabwidth" option, rather than a fixed number. Signed-off-by: Wesley J. Landaker <redacted> --- Documentation/config.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)diff --git a/Documentation/config.txt b/Documentation/config.txt index 6416cae..113a196 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt@@ -559,8 +559,8 @@ core.whitespace:: * `space-before-tab` treats a space character that appears immediately before a tab character in the initial indent part of the line as an error (enabled by default). -* `indent-with-non-tab` treats a line that is indented with 8 or more - space characters as an error (not enabled by default). +* `indent-with-non-tab` treats a line that is indented with `tabwidth` space + characters or more as an error (not enabled by default).
I would rather see this part left untouched. Your new text will force people who are not interested in using non-standard tab width to read through the bulletted list, only to find "The default tab width is 8". I think that is a regression in the documentation for more common readers. When somebody wants to use `indent-with-non-tab` and gets offended by the seemingly hardcoded "8" in the description, the reader has incentive to find out if there is a way to change that 8, and will find `tabwidth=<n>` in the same bulletted list described, with the effect it has on both `indent-with-non-tab` and `tab-in-indent`. I think that should be sufficient for people who do use non-standard tab width using tabwidth=<n>.