Branch: refs/heads/reformat-style-guide-copyright
Home: https://github.com/kronosnet/kronosnet
Commit: 37490792ac81877bda2c5b0c8bab6e554a3a2f31
https://github.com/kronosnet/kronosnet/commit/37490792ac81877bda2c5b0c8bab6…
Author: google-labs-jules[bot] <161369871+google-labs-jules[bot](a)users.noreply.github.com>
Date: 2025-06-04 (Wed, 04 Jun 2025)
Changed paths:
A STYLE_GUIDE.md
Log Message:
-----------
Create and refine STYLE_GUIDE.md for project contributions
This commit introduces STYLE_GUIDE.md, a comprehensive document
outlining coding standards and best practices for the Kronosnet project.
This guide aims to ensure consistency and clarity in contributions.
The following key areas are covered:
1. **C Language Style**:
* Minimum Dialect: C99.
* Indentation: Tabs (not spaces).
* Curly Braces:
* Control flow (if, for, while): Opening brace on the same line.
* Function definitions: Opening brace on the next line.
* Always use braces, even for single-line blocks.
* Variable Declaration: At the beginning of their scope.
* Line Length: Preferred maximum of 120 characters, flexible for
readability (e.g., nested structs).
2. **Naming Conventions**:
* General: `snake_case` for internal variables and function names.
* Public API Elements:
* `knet_` or `nozzle_` prefix for functions, structs, typedefs
(e.g., `knet_get_host_list`, `nozzle_device_config`).
* `KNET_` or `NOZZLE_` prefix for enums and defines (macros),
followed by uppercase `SNAKE_CASE` (e.g., `KNET_MAX_CLIENTS`,
`NOZZLE_BUFFER_SIZE_DEFAULT`).
* Internal Elements:
* Names should be descriptive, indicating purpose and subsystem.
* Functions shared across multiple threads: Prefix with `_`
(e.g., `_shared_data_access`).
3. **Comments**:
* `//` for single-line, `/* ... */` for multi-line.
* Emphasizes clear and concise comments for non-obvious code.
4. **Best Practices**:
* API Changes Require Tests: Any internal or external API
modification must be accompanied by corresponding tests in the
test suite.
5. **Copyright**:
* A copyright notice specific to `STYLE_GUIDE.md` (Year 2025,
Author: Jules <AI Agent>) has been included and formatted as
plain Markdown text.
This initial version of the style guide addresses issue #22 and incorporates
iterative feedback on formatting, content, and specificity. A trivial
change (extra newline at EOF) was included in this commit to facilitate
this comprehensive message.
Signed-off-by: Fabio M. Di Nitto <fdinitto(a)redhat.com>
To unsubscribe from these emails, change your notification settings at https://github.com/kronosnet/kronosnet/settings/notifications
Branch: refs/heads/main
Home: https://github.com/kronosnet/kronosnet
Commit: 18c6cc955a33c1a20cb33be27cb62ecdfcb5948a
https://github.com/kronosnet/kronosnet/commit/18c6cc955a33c1a20cb33be27cb62…
Author: Christine Caulfield <ccaulfie(a)redhat.com>
Date: 2025-06-04 (Wed, 04 Jun 2025)
Changed paths:
M libknet/bindings/rust/src/knet_bindings.rs
M libknet/bindings/rust/src/lib.rs
M libknet/bindings/rust/tests/src/bin/knet-test.rs
M libnozzle/bindings/rust/src/lib.rs
M libnozzle/bindings/rust/src/nozzle_bindings.rs
M libnozzle/bindings/rust/tests/src/bin/nozzle-test.rs
Log Message:
-----------
Fix rust 1.87 clippies
Apparently I was doing things the hard way
Commit: 5e9007681710b67af14d1ab8156f8de997f81b1b
https://github.com/kronosnet/kronosnet/commit/5e9007681710b67af14d1ab8156f8…
Author: Fabio M. Di Nitto <fdinitto(a)redhat.com>
Date: 2025-06-04 (Wed, 04 Jun 2025)
Changed paths:
M libknet/bindings/rust/src/knet_bindings.rs
M libknet/bindings/rust/src/lib.rs
M libknet/bindings/rust/tests/src/bin/knet-test.rs
M libnozzle/bindings/rust/src/lib.rs
M libnozzle/bindings/rust/src/nozzle_bindings.rs
M libnozzle/bindings/rust/tests/src/bin/nozzle-test.rs
Log Message:
-----------
Merge pull request #445 from kronosnet/rust-187
Fix rust 1.87 clippies
Compare: https://github.com/kronosnet/kronosnet/compare/4581c36dceb5...5e9007681710
To unsubscribe from these emails, change your notification settings at https://github.com/kronosnet/kronosnet/settings/notifications
Branch: refs/heads/rust-187
Home: https://github.com/kronosnet/kronosnet
Commit: 18c6cc955a33c1a20cb33be27cb62ecdfcb5948a
https://github.com/kronosnet/kronosnet/commit/18c6cc955a33c1a20cb33be27cb62…
Author: Christine Caulfield <ccaulfie(a)redhat.com>
Date: 2025-06-04 (Wed, 04 Jun 2025)
Changed paths:
M libknet/bindings/rust/src/knet_bindings.rs
M libknet/bindings/rust/src/lib.rs
M libknet/bindings/rust/tests/src/bin/knet-test.rs
M libnozzle/bindings/rust/src/lib.rs
M libnozzle/bindings/rust/src/nozzle_bindings.rs
M libnozzle/bindings/rust/tests/src/bin/nozzle-test.rs
Log Message:
-----------
Fix rust 1.87 clippies
Apparently I was doing things the hard way
To unsubscribe from these emails, change your notification settings at https://github.com/kronosnet/kronosnet/settings/notifications
Branch: refs/heads/reformat-style-guide-copyright
Home: https://github.com/kronosnet/kronosnet
Commit: 11a8f26b03a8059acfde26071d660a41445120c8
https://github.com/kronosnet/kronosnet/commit/11a8f26b03a8059acfde26071d660…
Author: google-labs-jules[bot] <161369871+google-labs-jules[bot](a)users.noreply.github.com>
Date: 2025-06-04 (Wed, 04 Jun 2025)
Changed paths:
A STYLE_GUIDE.md
Log Message:
-----------
Create and refine STYLE_GUIDE.md for project contributions
This commit introduces STYLE_GUIDE.md, a comprehensive document
outlining coding standards and best practices for the Kronosnet project.
This guide aims to ensure consistency and clarity in contributions.
The following key areas are covered:
1. **C Language Style**:
* Minimum Dialect: C99.
* Indentation: Tabs (not spaces).
* Curly Braces:
* Control flow (if, for, while): Opening brace on the same line.
* Function definitions: Opening brace on the next line.
* Always use braces, even for single-line blocks.
* Variable Declaration: At the beginning of their scope.
* Line Length: Preferred maximum of 120 characters, flexible for
readability (e.g., nested structs).
2. **Naming Conventions**:
* General: `snake_case` for internal variables and function names.
* Public API Elements:
* `knet_` or `nozzle_` prefix for functions, structs, typedefs
(e.g., `knet_get_host_list`, `nozzle_device_config`).
* `KNET_` or `NOZZLE_` prefix for enums and defines (macros),
followed by uppercase `SNAKE_CASE` (e.g., `KNET_MAX_CLIENTS`,
`NOZZLE_BUFFER_SIZE_DEFAULT`).
* Internal Elements:
* Names should be descriptive, indicating purpose and subsystem.
* Functions shared across multiple threads: Prefix with `_`
(e.g., `_shared_data_access`).
3. **Comments**:
* `//` for single-line, `/* ... */` for multi-line.
* Emphasizes clear and concise comments for non-obvious code.
4. **Best Practices**:
* API Changes Require Tests: Any internal or external API
modification must be accompanied by corresponding tests in the
test suite.
5. **Copyright**:
* A copyright notice specific to `STYLE_GUIDE.md` (Year 2025,
Author: Jules <AI Agent>) has been included and formatted as
plain Markdown text.
This initial version of the style guide addresses issue #22 and incorporates
iterative feedback on formatting, content, and specificity. A trivial
change (extra newline at EOF) was included in this commit to facilitate
this comprehensive message.
Signed-off-by: Fabio M. Di Nitto <fdinitto(a)redhat.com>
To unsubscribe from these emails, change your notification settings at https://github.com/kronosnet/kronosnet/settings/notifications