swung0x48/MobileGL
1
0
Fork 0
mirror of https://github.com/MobileGL-Dev/MobileGL synced 2026-11-07 01:53:24 +09:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] (.git-blame-ignore-revs, CONTRIBUTING.md): list the reformat for git blame and update the format rules

Browse Source
This commit is contained in:
swung0x48
2026-10-16 06:30:59 -04:00
parent f4994ee36e
commit 7dbe0e5c78
2 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.git-blame-ignore-revs
+5
View File
@@ -0,0 +1,5 @@
# Layout-only commits for `git blame` to look past:
# git config blame.ignoreRevsFile .git-blame-ignore-revs
# clang-format every C and C++ source
f4994ee36e3aa2d53c22370e471c976a3fae719f
CONTRIBUTING.md
+3 -2
View File
@@ -52,8 +52,9 @@ Example:
## Code ## Code
- Format the lines you change with `.clang-format`, using clang-format 23. Install it with `pip install 'clang-format==23.1.3'`; `git clang-format <base>` from the same package formats only the lines changed since `<base>`. `scripts/format_code.sh` reformats whole files, so do not use it on files you only touched. - C and C++ sources are formatted with `.clang-format`, using clang-format 23. Install it with `pip install 'clang-format==23.1.3'`. `git clang-format <base>` from the same package formats the lines changed since `<base>`, and `scripts/format_code.sh` formats every file the check covers. The tree is already formatted, so neither touches lines you did not change.
- `.inc` files are fragments included in the middle of a `.cpp` file, inside a namespace, or are generated tables. clang-format cannot format them on their own, so the check skips them. Match the indentation of the file that includes them. - The commit that reformatted the whole tree is listed in `.git-blame-ignore-revs`. Run `git config blame.ignoreRevsFile .git-blame-ignore-revs` once so that `git blame` looks past it.
- `.inc` files are fragments included in the middle of a `.cpp` file, inside a namespace, or are generated tables. clang-format cannot format them on their own, so the check skips them. Match the indentation of the file that includes them. The check also skips generated files and the GL export table, `MG_Impl/GLImpl/Exporting/Definitions.cpp`.
- Text files are UTF-8. - Text files are UTF-8.
- These source files under `MobileGL/`, `scripts/` and `tools/` start with the license header: - These source files under `MobileGL/`, `scripts/` and `tools/` start with the license header:
- C, C++, `.inc`, GLSL, Java and JavaScript modules, with `//` comments; - C, C++, `.inc`, GLSL, Java and JavaScript modules, with `//` comments;