Branch: refs/heads/reformat-style-guide-copyright
Home: https://github.com/kronosnet/kronosnet
Commit: d23568fa395d464902ac2eccbbd4d2be6874b17b
https://github.com/kronosnet/kronosnet/commit/d23568fa395d464902ac2eccbbd4d…
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.
To unsubscribe from these emails, change your notification settings at https://github.com/kronosnet/kronosnet/settings/notifications
Run reason: Pull request #443 opened
Total runtime: 9 min 12 sec
Split logs: https://ci.kronosnet.org/job/kronosnet/job/kronosnet-pipeline/job/PR-443/1/…
Full log: https://ci.kronosnet.org/job/kronosnet/job/kronosnet-pipeline/job/PR-443/1/…
Please report the following errors to your friendly local Jenkins admin (though they have probably already seen them and are already panicking).
Exception caught on centos-9-power9-ppc64le during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-s390x during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-12-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-testing-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-40-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-41-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-power9-ppc64le during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-s390x during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-13-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-14-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-coverity-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-power9-ppc64le during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-s390x during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-coverity-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-power9-ppc64le during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-s390x during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-coverity-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-power9-ppc64le during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-s390x during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-20-04-lts-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-22-04-lts-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-04-lts-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-10-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-25-04-x86-64 during voting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-power9-ppc64le during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-s390x during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-x86-64 during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-experimental-x86-64 during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-unstable-x86-64 during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-devel-x86-64 during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-devel-x86-64 during nonvoting_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-power9-ppc64le during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-power9-ppc64le during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-s390x during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-s390x during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-power9-ppc64le during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-power9-ppc64le during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-s390x during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-s390x during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-12-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-12-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-experimental-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-experimental-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-testing-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-testing-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-unstable-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-unstable-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-40-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-40-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-41-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-41-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-power9-ppc64le during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-power9-ppc64le during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-s390x during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-s390x during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-13-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-13-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-14-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-14-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-devel-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-devel-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-power9-ppc64le during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-power9-ppc64le during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-s390x during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-s390x during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-power9-ppc64le during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-power9-ppc64le during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-s390x during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-s390x during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-power9-ppc64le during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-power9-ppc64le during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-s390x during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-s390x during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-20-04-lts-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-20-04-lts-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-22-04-lts-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-22-04-lts-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-04-lts-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-04-lts-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-10-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-10-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-25-04-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-25-04-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-devel-x86-64 during nonvoting-clang: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-devel-x86-64 during nonvoting-clang_debug: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-s390x during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-s390x during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-40-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-41-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-s390x during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-s390x during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-s390x during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-s390x during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-x86-64 during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-coverity-x86-64 during covscan: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-coverity-x86-64 during covscan: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-coverity-x86-64 during covscan: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-power9-ppc64le during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-s390x during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-42-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-13-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-14-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-coverity-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-power9-ppc64le during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-s390x during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-8-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-coverity-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-power9-ppc64le during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-s390x during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-9-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-coverity-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-power9-ppc64le during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-s390x during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on rhel-10-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-20-04-lts-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-22-04-lts-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-04-lts-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-24-10-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-25-04-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-power9-ppc64le during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-s390x during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-10-x86-64 during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-experimental-x86-64 during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-unstable-x86-64 during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on freebsd-devel-x86-64 during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on ubuntu-devel-x86-64 during nonvoting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-rawhide-power9-ppc64le during buildrpms: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-s390x during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-power9-ppc64le during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-12-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on debian-testing-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-41-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on fedora-40-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Exception caught on centos-9-x86-64 during voting: org.jenkinsci.plugins.workflow.steps.FlowInterruptedException
Branch: refs/heads/reformat-style-guide-copyright
Home: https://github.com/kronosnet/kronosnet
Commit: b0ce5fa030a1afec5e6c77b981d4e5da542e5097
https://github.com/kronosnet/kronosnet/commit/b0ce5fa030a1afec5e6c77b981d4e…
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:
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.
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: e92c0cae8c5f3050e44de418103e49b6d61e8c6c
https://github.com/kronosnet/kronosnet/commit/e92c0cae8c5f3050e44de418103e4…
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:
-----------
Here's how I've reformatted the copyright section in STYLE_GUIDE.md:
This commit updates the "Copyright" section in STYLE_GUIDE.md
to be plain Markdown text instead of a commented code block.
I've removed the '#' characters and code block fences.
To unsubscribe from these emails, change your notification settings at https://github.com/kronosnet/kronosnet/settings/notifications