christoph/wamr
1
Fork 0
Code Releases Activity

Update document of embed wamr and code format check (#1054)

Browse Source 
Update document embed wamr, add how to embed wamr in cmake and makefile
Update document coding guideline check, add how to install clang-format-12
This commit is contained in:
Wenyong Huang
2022-03-23 11:01:57 +08:00
committed by GitHub
parent f8ee05db4b
commit e7079eeb17
2 changed files with 33 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
ci/coding_guidelines_check.py
View File

@ -96,10 +96,17 @@ def run_clang_format(file_path: pathlib, root: pathlib) -> bool:
def run_clang_format_diff(root: pathlib, commits: str) -> bool:
"""
Use `clang-format-12` and `git-clang-format-12` to check code
format of the PR, which specificed a commit range. It is required to
format code before `git commit` or when failed the PR check:
Use `clang-format-12` or `git-clang-format-12` to check code format of
the PR, with a commit range specified. It is required to format the
code before committing the PR, or it might fail to pass the CI check:
1. Install clang-format-12.0.0
Normally we can install it by `sudo apt-get install clang-format-12`,
or download the `clang+llvm-12.0.0-xxx-tar.xz` package from
https://github.com/llvm/llvm-project/releases/tag/llvmorg-12.0.0
and install it
2. Format the C/C++ source file
``` shell
cd path/to/wamr/root
clang-format-12 --style file -i path/to/file