mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-16 00:46:03 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
96 lines
2.7 KiB
Markdown
96 lines
2.7 KiB
Markdown
---
|
|
title: Source code formatting
|
|
weight: 4
|
|
---
|
|
|
|
This project uses **clang-format** (version 18) to enforce a consistent coding style
|
|
for C and C++ source files. For convenience, **treefmt** is also configured as a
|
|
single-command wrapper that discovers and formats every file in the tree.
|
|
|
|
## clang-format
|
|
|
|
### Configuration file
|
|
|
|
The formatting rules live in [`.clang-format`](../.clang-format) at the repository
|
|
root. The style is based on **LLVM**.
|
|
|
|
See the `.clang-format` file itself for the complete list.
|
|
|
|
### Version requirement
|
|
|
|
clang-format **18** is required.
|
|
The helper script [`scripts/clang-format-wrapper`](../scripts/clang-format-wrapper)
|
|
automatically resolves the correct binary: it first looks for `clang-format-18` on
|
|
`PATH`, then falls back to `clang-format` and verifies that its major version is 18.
|
|
All other tooling in the repo calls this wrapper instead of `clang-format` directly.
|
|
|
|
### Running clang-format manually
|
|
|
|
Format every tracked source file in the repository:
|
|
|
|
```bash
|
|
git ls-files -z \
|
|
'*.c' '*.cc' '*.cpp' \
|
|
'*.h' '*.hh' '*.hpp' \
|
|
':(exclude)include/etl/generators/*' \
|
|
':(exclude)include/etl/private/*_cpp03.h' | xargs -0 scripts/clang-format-wrapper -i --verbose --style=file
|
|
```
|
|
|
|
You can also format individual files directly:
|
|
|
|
```bash
|
|
scripts/clang-format-wrapper -i --style=file path/to/file.cpp
|
|
```
|
|
## treefmt
|
|
|
|
[treefmt](https://treefmt.com) is a language-agnostic source-tree formatter.
|
|
It reads a single configuration file and dispatches each file to the appropriate
|
|
formatter. In this project, it delegates all C/C++ formatting to the same
|
|
`clang-format-wrapper` described above.
|
|
|
|
In comparison to calling clang-format directly, it brings a significant speedup.
|
|
|
|
### Configuration file
|
|
|
|
The configuration lives in [`.treefmt.toml`](../.treefmt.toml) at the repository root.
|
|
|
|
### Installing treefmt
|
|
|
|
treefmt is a standalone Go binary. Install it with any of:
|
|
|
|
```bash
|
|
# Using the official install script
|
|
curl -fsSL https://raw.githubusercontent.com/numtide/treefmt/main/install.sh | bash
|
|
|
|
# Or via Homebrew
|
|
brew install treefmt
|
|
|
|
# Or via Nix
|
|
nix profile install nixpkgs#treefmt2
|
|
```
|
|
|
|
See the [treefmt documentation](https://treefmt.com) for more options.
|
|
|
|
### Running treefmt
|
|
|
|
From the repository root:
|
|
|
|
```bash
|
|
# Format everything
|
|
treefmt
|
|
|
|
# Check formatting without modifying files (useful in CI)
|
|
treefmt --fail-on-change
|
|
```
|
|
|
|
## Excluded paths
|
|
|
|
`.treefmt.toml` excludes generated files under
|
|
`include/etl/generators/`. Do **not** format those files manually via clang-format or treefmt.
|
|
|
|
## Pre-commit
|
|
|
|
Before submitting a PR / contribution, run `treefmt --fail-on-change` to catch
|
|
unformatted code before merge.
|
|
|
|
Alternatively, a plain `treefmt` automatically fixes any issues. |