Skip to content

Update formatting docs #5357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
morgando merged 1 commit into from
Aug 21, 2025
Merged

Update formatting docs #5357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ci/scripts/format
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,20 @@ print_help() {
echo " -s, --only-staged Only format staged files"
echo " -v, --verbose Enable verbose output"
echo " -h, --help Show this help message"
echo ""
echo "Uses the following clang-format style:"
echo " { $(echo "${clang_style}" | sed 's/[{}]//g; s/, */;\n /g')" }
echo ""
echo "Formats files with the following extensions: ${extensions_to_style_check}"
echo "in the following directories:"
echo " ${dirs_to_style_check}" | fold -s -w 80 | sed '2,$s/^/ /'
echo ""
echo "Examples:"
echo " Format changes against upstream/main (useful before opening a PR to upstream/main):"
echo " $0 -b upstream/main"
echo ""
echo " Check format for staged changes against HEAD (useful for a pre-commit hook):"
echo " $0 --dry-run --only-staged --compare-base $(git rev-parse --short HEAD)"
}

while [[ $# -gt 0 ]]; do
Expand Down
10 changes: 3 additions & 7 deletions docs/pages/overview/contrib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,9 @@ Please submit a pull request! We welcome code and idea contributions.

### Indentation, etc.

Comdb2 contains code from multiple open source libraries. If editing existing code for, for example, BerkeleyDB and
SQLite, please stick to existing conventions for those code bases. For Comdb2 code, it's highly recommended that
before you creating a pull request, please format your code with `clang` via the following:

```
clang-format -style="{BasedOnStyle: llvm, IndentWidth: 4, UseTab: Never, BreakBeforeBraces: Linux, SortIncludes: false, IndentCaseLabels: false, AlwaysBreakTemplateDeclarations: true, AllowShortFunctionsOnASingleLine: false, AllowShortCaseLabelsOnASingleLine: true, AllowShortIfStatementsOnASingleLine: true}"
```
Comdb2 contains code from multiple open source libraries. If editing existing code for, for example, BerkeleyDB and
SQLite, please stick to existing conventions for those code bases. For Comdb2 code, you can check your formatting
using the `ci/scripts/format` script. Run `./ci/scripts/format -h` for details.

### Producing trace

Expand Down