git/Documentation/CodingGuidelines, branch v2.52.0

Documentation: note styling for bit fields

2025-08-26T22:46:03Z

Our codebase uses a lot of bit field variables, generally to mark boolean type variables. While there is a formatting rule in the '.clang-format', there is no guideline specified in the 'CodingGuidelines'. Since the '.clang-format' is not yet enforced, let's also add a guideline with the same rule as mentioned in the '.clang-format', which is to not use any spaces around the colon, like so: unsigned my_field:1; unsigned other_field:1; unsigned field_with_longer_name:1; This would allow us not to modify the clang-format file, and more importantly, discourage people from doing ugly alignment with spaces, i.e. unsigned my_field : 1; unsigned other_field : 1; unsigned field_with_longer_name : 1; Helped-by: Junio C Hamano Signed-off-by: Karthik Nayak Signed-off-by: Junio C Hamano

Merge branch 'jc/doc-release-vs-clear'

2025-08-04T15:10:35Z

Doc update. * jc/doc-release-vs-clear: CodingGuidelines: clarify that S_release() does not reinitialize

Merge branch 'jc/document-test-balloons-in-flight'

2025-08-01T18:27:13Z

To help our developers, document what C99 language features are being considered for adoption, in addition to what past experiments have already decided. * jc/document-test-balloons-in-flight: CodingGuidelines: document test balloons in flight

CodingGuidelines: clarify that S_release() does not reinitialize

2025-08-01T17:08:17Z

In the section for naming various API functions, the fact that S_release() only releases the resources without preparing the structure for immediate reuse becomes only apparent when you readentries for S_release() and S_clear(). Clarify the description of S_release() a bit to make the entry self sufficient. Signed-off-by: Junio C Hamano

Merge branch 'pw/adopt-c99-bool-officially'

2025-07-24T23:03:55Z

Declare weather-balloon we raised for "bool" type 18 months ago a success and officially allow using the type in our codebase. * pw/adopt-c99-bool-officially: strbuf: convert predicates to return bool git-compat-util: convert string predicates to return bool CodingGuidelines: allow the use of bool

CodingGuidelines: document test balloons in flight

2025-07-24T16:23:59Z

Due to portability concerns, we do not blindly say "It is in [[this standard]], so we will make liberal use of it" for many features, and use of C99 language features follow this same principle. When we contemplate adopting a language feature that we haven't used in our codebase, we typically first raise a test balloon, which - is a piece of code that exercises the language feature we are trying to see if it is OK to adopt - is in a small section of code that we know everybody who cares about having a working Git must be compiling - is in a fairly stable part of the code, to allow reverting it easily if some platforms do not understand it yet. After a few years, with no breakage report from the community, we'd declare that the feature is now safe to use in our codebase. Before that, we forbid the use of the language construct except for the designated test balloon code site. The CodingGuidelines document lists these selected features that we already have determined that they are safe, and also those features that we know some platforms had trouble with. Let's also start listing ongoing test balloons and expected timeline for adoption. Recently phillip proposed to adopt the syntax to spell a structure literally (i.e. compound literal) with a new test balloon, which Patrick made redundant by pointing out an existing one we had already.but without documenting it. Start the new section with an entry for that test balloon. Helped-by: Patrick Steinhardt Helped-by: Phillip Wood Signed-off-by: Junio C Hamano

CodingGuidelines: allow the use of bool

2025-07-16T15:18:05Z

We have had a test balloon for C99's bool type since 8277dbe987 (git-compat-util: convert skip_{prefix,suffix}{,_mem} to bool, 2023-12-16). As we've had it over 18 months without any complaints let's declare it a success. Signed-off-by: Phillip Wood Signed-off-by: Junio C Hamano

Merge branch 'jc/cg-let-bss-do-its-job'

2025-06-24T16:48:50Z

Clarify "do not explicitly initialize to zero" rule in the CodingGuidelines document. * jc/cg-let-bss-do-its-job: CodingGuidelines: let BSS do its job

Merge branch 'cf/guideline-documenting-config-vars'

2025-06-18T20:53:33Z

CodingGuidelines update. * cf/guideline-documenting-config-vars: CodingGuidelines: document formatting of similar config variables.

CodingGuidelines: document formatting of similar config variables.

2025-06-18T20:48:11Z

Document that related `git config` variables should be placed one-per-line instead of separated by commas. Suggested-by: Junio C Hamano Signed-off-by: Collin Funk Signed-off-by: Junio C Hamano