Skip to content

Conversation

@KenVanHoeylandt
Copy link
Contributor

@KenVanHoeylandt KenVanHoeylandt commented Jan 27, 2026

  • Renamed TactilityKernel and Platform project files
  • Updated code style docs

Summary by CodeRabbit

  • Documentation

    • Added a C coding style guide with conventions and examples.
    • Clarified C++ style guidance to align shared naming and header organization with C rules.
  • Refactor

    • Normalized include/header paths across the codebase to a consistent lowercase naming scheme.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request normalizes include paths and filenames to a lowercase tactility/... layout across the repository. Many source, header, device tree, platform, driver, kernel, and test files had include directives changed from mixed-case (e.g., <Tactility/Device.h>, FreeRTOS.h) to lowercase equivalents (e.g., <tactility/device.h>, freertos.h). Several include orders were adjusted. Two new coding style documents for C and C++ were added. No changes to control flow, logic, or public API signatures were introduced.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main objective of the changeset: renaming files to follow consistent C code style conventions (lowercase naming).

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 16

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
CODING_STYLE_CPP.md (1)

75-79: Fix the enum class example - missing enum name.

The example shows enum class { with an empty name, which is invalid C++ syntax. Add a meaningful enum name for the example.

📝 Proposed fix
-enum class  {
+enum class Status {
     Ok,
     NotSupported,
     Error
 };
🧹 Nitpick comments (7)
Tactility/Source/app/fileselection/View.cpp (1)

4-12: Same inconsistent include path casing as in Tactility/Source/app/files/View.cpp.

Line 8 uses lowercase <tactility/check.h> while surrounding includes (lines 4-7, 9-12) use CamelCase <Tactility/...>. This is the same mixed-casing pattern flagged in the other file.

TactilityKernel/Include/tactility/drivers/gpio_controller.h (1)

9-10: Consider using consistent include style.

Line 9 uses quotes ("gpio.h") while line 10 uses angle brackets (<tactility/error.h>). Since both are project headers, consider using a consistent style. Typically, quotes are for relative/local headers and angle brackets for system or installed headers.

♻️ Suggested fix for consistency
-#include "gpio.h"
-#include <tactility/error.h>
+#include <tactility/drivers/gpio.h>
+#include <tactility/error.h>
CODING_STYLE_C.md (4)

13-16: Use c language identifier for C code examples.

Since this is a C coding style guide, the code block should use the c language identifier instead of c++.

📝 Suggested fix
-```c++
+```c
 some_feature.c
 some_feature.h
 ```

54-60: Extra space in enum declaration and language identifier.

There's a double space before the opening brace, and this C-style enum example uses the c++ identifier.

📝 Suggested fixes
-```c++
-enum SomeResult  {
+```c
+enum SomeResult {
     Ok,
     NotSupported,
     Error
 };
 ```

68-72: Use c language identifier for C function example.

📝 Suggested fix
-```c++
+```c
 void get_limit() {
     // ...
 }
 ```

94-96: Use c language identifier for typedef example.

📝 Suggested fix
-```c++
+```c
 typedef uint32_t thread_id_t;
 ```
TactilityKernel/Source/concurrent/dispatcher.cpp (1)

5-11: Include paths updated correctly.

All include directives use the new lowercase tactility/ convention.

Minor note: Line 7 uses double quotes ("tactility/error.h") while other project headers use angle brackets (<tactility/...>). This works but is slightly inconsistent with the surrounding includes.

Optional: Align quote style
 `#include` <tactility/concurrent/dispatcher.h>

-#include "tactility/error.h"
+#include <tactility/error.h>

 `#include` <tactility/concurrent/eventgroup.h>

@KenVanHoeylandt KenVanHoeylandt merged commit d551e46 into main Jan 27, 2026
0 of 13 checks passed
@KenVanHoeylandt KenVanHoeylandt deleted the rename-tactilitykernel-files branch January 27, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants