commit | ba560cc31297caddfc157c540ae9e6d760d630e5 | [log] [tgz] |
---|---|---|
author | Ed Tanous <ed@tanous.net> | Wed Aug 13 06:46:07 2025 -0700 |
committer | Ed Tanous <ed@tanous.net> | Mon Aug 18 10:27:04 2025 -0700 |
tree | 98975f4fdccc3a32bdab56a7ef2158e99bd7648a | |
parent | ac6e69a7df9c214fbf55144aafde43595a76aa60 [diff] |
Remove size checks from .clang-tidy These two checks around cognative complexity and function size were put in this file aspirationally. To date no repositories have been able to successfully enable these two checks. This maintainer has personally tried and we'd either have to bypass so many functions that the check became more cumbersome to maintain, or we'd have to raise the limits to where they were not useful. While I'm hopeful that these checks could be enabled in the future, they don't match the reality of where tidy is at. As a side note, one thing asio-based repos suffer from is overly large inline lambdas. cognative complexity and length checks do not take those into account when measuring line count, and in some cases seem to actively disable the checks, so even if we were able to enable these checks, as implemented in clang they're not useful in a lot of scenarios today. To ensure that the content is not lost, these two checks are moved into documentation (tidy-desired.md) that can track the desire to enable these checks, even if we're not able to do so today. Change-Id: Ic86066f21f0c01a4d7b27a02829564f693f8b00b Signed-off-by: Ed Tanous <etanous@nvidia.com>
The OpenBMC project is a Linux Foundation project whose goal is to produce a customizable, open-source firmware stack for Baseboard Management Controllers (BMCs). This repository contains documentation for OpenBMC as a whole. There may be component-specific documentation in the repository for each component.
The features document lists the project's major features with links to more information.
openbmc@lists.ozlabs.org
https://lists.ozlabs.org/listinfo/openbmcThese documents contain details on developing OpenBMC code itself
cheatsheet.md: Quick reference for some common development tasks
CONTRIBUTING.md: Guidelines for contributing to OpenBMC
development tutorials: Tutorials for getting up to speed on OpenBMC development
kernel-development.md: Reference for common kernel development tasks
These documents describe how to use OpenBMC, including using the programmatic interfaces to an OpenBMC system.
code-update: Updating OpenBMC and host platform firmware
console.md: Using the host console
host-management.md: Performing host management tasks with OpenBMC
rest-api.md: Introduction to using the OpenBMC REST API
REDFISH-cheatsheet.md: Quick reference for some common OpenBMC Redfish commands
REST-cheatsheet.md: Quick reference for some common OpenBMC REST API commands