public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] CodingGuidelines: document // comments
@ 2026-02-11 19:17 Junio C Hamano
  2026-02-12  7:05 ` Patrick Steinhardt
  0 siblings, 1 reply; 2+ messages in thread
From: Junio C Hamano @ 2026-02-11 19:17 UTC (permalink / raw)
  To: git

We do not use // comments in our C code, which is implied by the
description of multi-line comment rule and its examples, but is not
explicitly spelled out.  Spell it out.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/CodingGuidelines | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index b358d6bfb8..507d52b0d3 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -439,6 +439,8 @@ For C programs:
 	 */
 	_("Here is a translatable string explained by the above.");
 
+   We do not use // comments.
+
  - Double negation is often harder to understand than no negation
    at all.
 
-- 
2.53.0-247-g50a2c88be3


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] CodingGuidelines: document // comments
  2026-02-11 19:17 [PATCH] CodingGuidelines: document // comments Junio C Hamano
@ 2026-02-12  7:05 ` Patrick Steinhardt
  0 siblings, 0 replies; 2+ messages in thread
From: Patrick Steinhardt @ 2026-02-12  7:05 UTC (permalink / raw)
  To: Junio C Hamano; +Cc: git

On Wed, Feb 11, 2026 at 11:17:48AM -0800, Junio C Hamano wrote:
> We do not use // comments in our C code, which is implied by the
> description of multi-line comment rule and its examples, but is not
> explicitly spelled out.  Spell it out.
> 
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/CodingGuidelines | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index b358d6bfb8..507d52b0d3 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -439,6 +439,8 @@ For C programs:
>  	 */
>  	_("Here is a translatable string explained by the above.");
>  
> +   We do not use // comments.
> +
>   - Double negation is often harder to understand than no negation
>     at all.

Makes sense and looks good to me. Thanks!

Patrick

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-02-12  7:05 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-02-11 19:17 [PATCH] CodingGuidelines: document // comments Junio C Hamano
2026-02-12  7:05 ` Patrick Steinhardt

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox