[PATCH] whitespace: correct bit assignment comments

[PATCH] whitespace: correct bit assignment comments

[Junio C Hamano]

A comment in diff.c claimed that bits up to 12th (counting from 0th)
are whitespace rules, and 13th thru 15th are for new/old/context,
but it turns out it was miscounting.  Correct the comment.

Also update the way these bit constants are defined to use (1
shifted by count) notation, instead of octal constants, as it tends
to make it easier to notice a breakage like this.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

 * I happened to be looking at this code today, and noticed this,
   but I very often make stupid mistakes while counting things, so
   sending it out (which should not change any behaviour) in the
   hope that somebody would (again) notice that I cannot count.

   Next step would be to make a gap between whitespace rules bits
   and WSEH_NEW/CONTEXT/OLD bits, so that we can smoothly add new
   whitespace rules later.

 diff.c |  4 ++--
 diff.h |  6 +++---
 ws.h   | 20 ++++++++++----------
 3 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/diff.c b/diff.c
index a74e701806..08136ad5c5 100644
--- a/diff.c
+++ b/diff.c
@@ -803,8 +803,8 @@ enum diff_symbol {
 };
 /*
  * Flags for content lines:
- * 0..12 are whitespace rules
- * 13-15 are WSEH_NEW | WSEH_OLD | WSEH_CONTEXT
+ * 0..11 are whitespace rules
+ * 12-14 are WSEH_NEW | WSEH_CONTEXT | WSEH_OLD
  * 16 is marking if the line is blank at EOF
  */
 #define DIFF_SYMBOL_CONTENT_BLANK_LINE_EOF	(1<<16)
diff --git a/diff.h b/diff.h
index 2fa256c3ef..60749154e7 100644
--- a/diff.h
+++ b/diff.h
@@ -331,9 +331,9 @@ struct diff_options {
 
 	int ita_invisible_in_index;
 /* white-space error highlighting */
-#define WSEH_NEW (1<<12)
-#define WSEH_CONTEXT (1<<13)
-#define WSEH_OLD (1<<14)
+#define WSEH_NEW	(1<<12)
+#define WSEH_CONTEXT	(1<<13)
+#define WSEH_OLD	(1<<14)
 	unsigned ws_error_highlight;
 	const char *prefix;
 	int prefix_length;
diff --git a/ws.h b/ws.h
index 5ba676c559..611c6b6d50 100644
--- a/ws.h
+++ b/ws.h
@@ -7,19 +7,19 @@ struct strbuf;
 /*
  * whitespace rules.
  * used by both diff and apply
- * last two digits are tab width
+ * last two octal-digits are tab width (we support only up to 63).
  */
-#define WS_BLANK_AT_EOL         0100
-#define WS_SPACE_BEFORE_TAB     0200
-#define WS_INDENT_WITH_NON_TAB  0400
-#define WS_CR_AT_EOL           01000
-#define WS_BLANK_AT_EOF        02000
-#define WS_TAB_IN_INDENT       04000
-#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
+#define WS_BLANK_AT_EOL         (1<<6)
+#define WS_SPACE_BEFORE_TAB     (1<<7)
+#define WS_INDENT_WITH_NON_TAB  (1<<8)
+#define WS_CR_AT_EOL            (1<<9)
+#define WS_BLANK_AT_EOF         (1<<10)
+#define WS_TAB_IN_INDENT        (1<<11)
+#define WS_TRAILING_SPACE       (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
-#define WS_TAB_WIDTH_MASK        077
+#define WS_TAB_WIDTH_MASK       ((1<<6)-1)
 /* All WS_* -- when extended, adapt diff.c emit_symbol */
-#define WS_RULE_MASK           07777
+#define WS_RULE_MASK            ((1<<12)-1)
 extern unsigned whitespace_rule_cfg;
 unsigned whitespace_rule(struct index_state *, const char *);
 unsigned parse_whitespace_rule(const char *);
-- 
2.51.2-686-gf92ff40d17

Re: [PATCH] whitespace: correct bit assignment comments

[Patrick Steinhardt]

On Mon, Oct 27, 2025 at 01:36:46PM -0700, Junio C Hamano wrote:
> diff --git a/diff.h b/diff.h
> index 2fa256c3ef..60749154e7 100644
> --- a/diff.h
> +++ b/diff.h
> @@ -331,9 +331,9 @@ struct diff_options {
>  
>  	int ita_invisible_in_index;
>  /* white-space error highlighting */
> -#define WSEH_NEW (1<<12)
> -#define WSEH_CONTEXT (1<<13)
> -#define WSEH_OLD (1<<14)
> +#define WSEH_NEW	(1<<12)
> +#define WSEH_CONTEXT	(1<<13)
> +#define WSEH_OLD	(1<<14)
>  	unsigned ws_error_highlight;
>  	const char *prefix;
>  	int prefix_length;

Here you're using tabs for indentation, whereas below you use spaces. We
should probably be consistent.

> diff --git a/ws.h b/ws.h
> index 5ba676c559..611c6b6d50 100644
> --- a/ws.h
> +++ b/ws.h
> @@ -7,19 +7,19 @@ struct strbuf;
>  /*
>   * whitespace rules.
>   * used by both diff and apply
> - * last two digits are tab width
> + * last two octal-digits are tab width (we support only up to 63).
>   */
> -#define WS_BLANK_AT_EOL         0100
> -#define WS_SPACE_BEFORE_TAB     0200
> -#define WS_INDENT_WITH_NON_TAB  0400
> -#define WS_CR_AT_EOL           01000
> -#define WS_BLANK_AT_EOF        02000
> -#define WS_TAB_IN_INDENT       04000
> -#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
> +#define WS_BLANK_AT_EOL         (1<<6)
> +#define WS_SPACE_BEFORE_TAB     (1<<7)
> +#define WS_INDENT_WITH_NON_TAB  (1<<8)
> +#define WS_CR_AT_EOL            (1<<9)
> +#define WS_BLANK_AT_EOF         (1<<10)
> +#define WS_TAB_IN_INDENT        (1<<11)
> +#define WS_TRAILING_SPACE       (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
>  #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)

The "8" here is a bit curious, but this matches what the comment says:
the last two digits are the tab width, and there of course is no macro
for that.

> -#define WS_TAB_WIDTH_MASK        077
> +#define WS_TAB_WIDTH_MASK       ((1<<6)-1)
>  /* All WS_* -- when extended, adapt diff.c emit_symbol */
> -#define WS_RULE_MASK           07777
> +#define WS_RULE_MASK            ((1<<12)-1)
>  extern unsigned whitespace_rule_cfg;
>  unsigned whitespace_rule(struct index_state *, const char *);
>  unsigned parse_whitespace_rule(const char *);

All of these conversion look correct to me, and I agree that this is
easier to read.

Thanks!

Patrick

Re: [PATCH] whitespace: correct bit assignment comments

[Junio C Hamano]

Patrick Steinhardt <ps@pks.im> writes:

> On Mon, Oct 27, 2025 at 01:36:46PM -0700, Junio C Hamano wrote:
>> diff --git a/diff.h b/diff.h
>> index 2fa256c3ef..60749154e7 100644
>> --- a/diff.h
>> +++ b/diff.h
>> @@ -331,9 +331,9 @@ struct diff_options {
>>  
>>  	int ita_invisible_in_index;
>>  /* white-space error highlighting */
>> -#define WSEH_NEW (1<<12)
>> -#define WSEH_CONTEXT (1<<13)
>> -#define WSEH_OLD (1<<14)
>> +#define WSEH_NEW	(1<<12)
>> +#define WSEH_CONTEXT	(1<<13)
>> +#define WSEH_OLD	(1<<14)
>>  	unsigned ws_error_highlight;
>>  	const char *prefix;
>>  	int prefix_length;
>
> Here you're using tabs for indentation, whereas below you use spaces. We
> should probably be consistent.

Thanks for sharp eyes.

>> +#define WS_TAB_IN_INDENT        (1<<11)
>> +#define WS_TRAILING_SPACE       (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
>>  #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
>
> The "8" here is a bit curious, but this matches what the comment says:
> the last two digits are the tab width, and there of course is no macro
> for that.

Yeah, we may need to do something about it later if we further touch
the code around here.

> All of these conversion look correct to me, and I agree that this is
> easier to read.

Thanks.

[PATCH v2] whitespace: correct bit assignment comments

[Junio C Hamano]

A comment in diff.c claimed that bits up to 12th (counting from 0th)
are whitespace rules, and 13th thru 15th are for new/old/context,
but it turns out it was miscounting.  Correct them, and clarify
where the whitespace rule bits come from in the comment.  Extend bit
assignment comments to cover bits used for color-moved, which
weren't described.

Also update the way these bit constants are defined to use (1 << N)
notation, instead of octal constants, as it tends to make it easier
to notice a breakage like this.

Sprinkle a few blank lines between logically distinct groups of CPP
macro definitions to make them easier to read.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

 * The next step would be to reserve the low 16 bits for ws.h and
   then shift everything else up; we'd then have 4 extra bits to
   play with, and I'll take one for \No newline at the end of file.

 diff.c |  7 +++++--
 diff.h |  6 +++---
 ws.h   | 25 ++++++++++++++-----------
 3 files changed, 22 insertions(+), 16 deletions(-)

diff --git a/diff.c b/diff.c
index a74e701806..74261b332a 100644
--- a/diff.c
+++ b/diff.c
@@ -801,16 +801,19 @@ enum diff_symbol {
 	DIFF_SYMBOL_CONTEXT_MARKER,
 	DIFF_SYMBOL_SEPARATOR
 };
+
 /*
  * Flags for content lines:
- * 0..12 are whitespace rules
- * 13-15 are WSEH_NEW | WSEH_OLD | WSEH_CONTEXT
+ * 0..11 are whitespace rules (see ws.h)
+ * 12..14 are WSEH_NEW | WSEH_CONTEXT | WSEH_OLD
  * 16 is marking if the line is blank at EOF
+ * 17..19 are used for color-moved.
  */
 #define DIFF_SYMBOL_CONTENT_BLANK_LINE_EOF	(1<<16)
 #define DIFF_SYMBOL_MOVED_LINE			(1<<17)
 #define DIFF_SYMBOL_MOVED_LINE_ALT		(1<<18)
 #define DIFF_SYMBOL_MOVED_LINE_UNINTERESTING	(1<<19)
+
 #define DIFF_SYMBOL_CONTENT_WS_MASK (WSEH_NEW | WSEH_OLD | WSEH_CONTEXT | WS_RULE_MASK)
 
 /*
diff --git a/diff.h b/diff.h
index 2fa256c3ef..cbd355cf50 100644
--- a/diff.h
+++ b/diff.h
@@ -331,9 +331,9 @@ struct diff_options {
 
 	int ita_invisible_in_index;
 /* white-space error highlighting */
-#define WSEH_NEW (1<<12)
-#define WSEH_CONTEXT (1<<13)
-#define WSEH_OLD (1<<14)
+#define WSEH_NEW        (1<<12)
+#define WSEH_CONTEXT    (1<<13)
+#define WSEH_OLD        (1<<14)
 	unsigned ws_error_highlight;
 	const char *prefix;
 	int prefix_length;
diff --git a/ws.h b/ws.h
index 5ba676c559..23708efb73 100644
--- a/ws.h
+++ b/ws.h
@@ -7,19 +7,22 @@ struct strbuf;
 /*
  * whitespace rules.
  * used by both diff and apply
- * last two digits are tab width
+ * last two octal-digits are tab width (we support only up to 63).
  */
-#define WS_BLANK_AT_EOL         0100
-#define WS_SPACE_BEFORE_TAB     0200
-#define WS_INDENT_WITH_NON_TAB  0400
-#define WS_CR_AT_EOL           01000
-#define WS_BLANK_AT_EOF        02000
-#define WS_TAB_IN_INDENT       04000
-#define WS_TRAILING_SPACE      (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
+#define WS_BLANK_AT_EOL         (1<<6)
+#define WS_SPACE_BEFORE_TAB     (1<<7)
+#define WS_INDENT_WITH_NON_TAB  (1<<8)
+#define WS_CR_AT_EOL            (1<<9)
+#define WS_BLANK_AT_EOF         (1<<10)
+#define WS_TAB_IN_INDENT        (1<<11)
+
+#define WS_TRAILING_SPACE       (WS_BLANK_AT_EOL|WS_BLANK_AT_EOF)
 #define WS_DEFAULT_RULE (WS_TRAILING_SPACE|WS_SPACE_BEFORE_TAB|8)
-#define WS_TAB_WIDTH_MASK        077
-/* All WS_* -- when extended, adapt diff.c emit_symbol */
-#define WS_RULE_MASK           07777
+#define WS_TAB_WIDTH_MASK       ((1<<6)-1)
+
+/* All WS_* -- when extended, adapt constants defined after diff.c:diff_symbol */
+#define WS_RULE_MASK            ((1<<12)-1)
+
 extern unsigned whitespace_rule_cfg;
 unsigned whitespace_rule(struct index_state *, const char *);
 unsigned parse_whitespace_rule(const char *);
-- 
2.51.2-681-g0e6cd5c3b3

Re: [PATCH v2] whitespace: correct bit assignment comments

[Patrick Steinhardt]

On Tue, Oct 28, 2025 at 09:33:01AM -0700, Junio C Hamano wrote:
> A comment in diff.c claimed that bits up to 12th (counting from 0th)
> are whitespace rules, and 13th thru 15th are for new/old/context,
> but it turns out it was miscounting.  Correct them, and clarify
> where the whitespace rule bits come from in the comment.  Extend bit
> assignment comments to cover bits used for color-moved, which
> weren't described.
> 
> Also update the way these bit constants are defined to use (1 << N)
> notation, instead of octal constants, as it tends to make it easier
> to notice a breakage like this.
> 
> Sprinkle a few blank lines between logically distinct groups of CPP
> macro definitions to make them easier to read.

Thanks, this version looks good to me!

Patrick

Re: [PATCH v2] whitespace: correct bit assignment comments

[Junio C Hamano]

Patrick Steinhardt <ps@pks.im> writes:

> On Tue, Oct 28, 2025 at 09:33:01AM -0700, Junio C Hamano wrote:
>> A comment in diff.c claimed that bits up to 12th (counting from 0th)
>> are whitespace rules, and 13th thru 15th are for new/old/context,
>> but it turns out it was miscounting.  Correct them, and clarify
>> where the whitespace rule bits come from in the comment.  Extend bit
>> assignment comments to cover bits used for color-moved, which
>> weren't described.
>> 
>> Also update the way these bit constants are defined to use (1 << N)
>> notation, instead of octal constants, as it tends to make it easier
>> to notice a breakage like this.
>> 
>> Sprinkle a few blank lines between logically distinct groups of CPP
>> macro definitions to make them easier to read.
>
> Thanks, this version looks good to me!
>
> Patrick

Thanks.