diff options
author | Ed Tanous <edtanous@google.com> | 2022-05-11 00:36:23 +0300 |
---|---|---|
committer | Ed Tanous <ed@tanous.net> | 2022-07-09 20:47:17 +0300 |
commit | c5bb99821d6b2a59bed5538475aa8d8631b4c075 (patch) | |
tree | 4f03a1540f9f55d7fc50e1f21c484ebf833c36d5 /DEVELOPING.md | |
parent | fdb203473d41c008f210c744aa71933b1865dfba (diff) | |
download | bmcweb-c5bb99821d6b2a59bed5538475aa8d8631b4c075.tar.xz |
Remove clang-tidy documentation
clang-tidy is now integrated into CI; Documenting the "manual" process
for running tidy doesn't provide value these days. Point to
openbmc-build-scripts as the "recommended" mechanism to run static
analysis.
Tested: Documentation only
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Idac0d29e8976a168355bfa3b863b8600db916f14
Diffstat (limited to 'DEVELOPING.md')
-rw-r--r-- | DEVELOPING.md | 27 |
1 files changed, 2 insertions, 25 deletions
diff --git a/DEVELOPING.md b/DEVELOPING.md index fcd5b3a8a8..5df3ce057f 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -181,28 +181,5 @@ clang-tidy is a tool that can be used to identify coding style violations, bad design patterns, and bug prone constructs. The checks are implemented in the -.clang-tidy file in the root of bmcweb, and are expected to be passing. To -run, the best way is to run the checks in yocto. - -``` -# check out meta-clang in your openbmc root -cd openbmc -git clone https://github.com/kraj/meta-clang - -# add the meta-clang layer to BBLAYERS in $BBPATH/conf/bblayers.conf -<path_to_your_build_dir>/meta-clang - -# Add this line to $BBPATH/conf/local.conf to build bmcweb with clang -TOOLCHAIN_pn-bmcweb = "clang" - -# and build -bitbake bmcweb - -# Open devshell (this will open a shell) -bitbake -c devshell bmcweb - -# cd into the work dir -cd oe-workdir/bmcweb-1.0+git999 -# run clang tidy -clang-tidy --header-filter=".*" -p . $BBPATH/workspace/sources/bmcweb/src/webserver_main.cpp -``` +.clang-tidy file in the root of bmcweb, and are expected to be passing. [openbmc-build-scripts](https://github.com/openbmc/openbmc-build-scripts/blob/master/run-unit-test-docker.sh) +implements clang-tidy checks and is the recommended way to run these checks
\ No newline at end of file |