Skip to content

Commit 8d16fcf

Browse files
chore: clang tidy changes + readme update
1 parent e39eaaf commit 8d16fcf

File tree

3 files changed

+11
-15
lines changed

3 files changed

+11
-15
lines changed

.clang-tidy

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,6 @@ Checks: >
55
# Bug Prone Checks: Focus on potential bugs and common mistakes
66
bugprone-*,
77
8-
# C++ Core Guidelines Checks: Enforce Modern C++ Guidelines
9-
cppcoreguidelines-*,
10-
11-
# Clang Static Analyzer Checks: Deeper semantic analysis for bugs
12-
clang-analyzer-*,
13-
148
# Modernize Checks: Suggest modern C++ features and idioms
159
modernize-*,
1610
@@ -20,21 +14,22 @@ Checks: >
2014
# Readability Checks: Improve code readability and maintainability
2115
readability-*,
2216
23-
# Misc Checks: Catch various issues
24-
misc-*,
25-
2617
# Specific exceptions or stricter rules
2718
-modernize-use-trailing-return-type, # Often generates noisy suggestions
28-
-cppcoreguidelines-pro-type-member-init, # Can be overly strict for some styles
19+
20+
# NOTE: These slow checks are disabled for pre-commit speed.
21+
# Consider running them in CI:
22+
# - clang-analyzer-* (deep dataflow analysis)
23+
# - cppcoreguidelines-* (many checks, some overlap)
24+
# - misc-*
2925
3026
WarningsAsErrors: >
3127
bugprone-*,
32-
clang-analyzer-*,
3328
3429
HeaderFilterRegex: '^((?!/opt/ros|/usr/include).)*$'
3530

36-
AnalyzeTemporaryDtors: true
37-
# Enables analysis of temporary destructors, which can catch more bugs but might be slower.
31+
# AnalyzeTemporaryDtors: true
32+
# Disabled for speed. Enable in CI for thorough analysis.
3833

3934
FormatStyle: file
4035
# Integrate with .clang-format to ensure consistent formatting options.

.github/workflows/rolling_ros2_ci.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ jobs:
1717
CCACHE_DIR: "${{ github.workspace }}/.ccache" # directory for ccache (and how we enable ccache in industrial_ci)
1818
steps:
1919
- uses: actions/checkout@v4 # clone target repository
20-
with:
21-
ref: rolling
2220
- uses: actions/cache@v4 # fetch/store the directory used by ccache before/after the ci run
2321
with:
2422
path: ${{ env.CCACHE_DIR }}

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
<a href="https://github.com/utiasDSL/crisp_controllers/actions/workflows/kilted_ros2_ci.yml"><img src="https://github.com/utiasDSL/crisp_controllers/actions/workflows/kilted_ros2_ci.yml/badge.svg"/></a>
66
<a href="https://github.com/utiasDSL/crisp_controllers/actions/workflows/rolling_ros2_ci.yml"><img src="https://github.com/utiasDSL/crisp_controllers/actions/workflows/rolling_ros2_ci.yml/badge.svg"/></a>
77
<a href="https://danielsanjosepro.github.io/crisp_controllers/"><img alt="Static Badge" src="https://img.shields.io/badge/docs-passing-blue?style=flat&link=https%3A%2F%2Fdanielsanjosepro.github.io%2Fcrisp_controllers%2F"></a>
8+
9+
> [!NOTE]
10+
> To reduce maintenance overhead, all ROS 2 distributions are supported from a single `main` branch. The code uses compile-time macros to handle version-specific differences.
811
<a href="https://utiasDSL.github.io/crisp_controllers#citing"><img alt="Static Badge" src="https://img.shields.io/badge/arxiv-cite-b31b1b?style=flat"></a>
912
1013
CRISP is a collection of real-time, C++ controllers for compliant torque-based control for manipulators compatible with `ros2_control`, including **Cartesian Impedance Control** and **Operational Space Control**. Developed for deploying high-level learning-based policies (VLA, Diffusion, ...) and teleoperation on your manipulator. It is robot-agnostic and compatible with any manipulator offering and effort interface. Check the [project website](https://utiasdsl.github.io/crisp_controllers/) for guides, getting started, demos and more!

0 commit comments

Comments
 (0)