Skip to content

docs: Update instructions for running the code format tool #29596

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
phlax merged 3 commits into from
Sep 13, 2023
Merged

docs: Update instructions for running the code format tool #29596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
459e52c
Update code format instructions after #29397
joaopgrassi Sep 13, 2023
aaea435
Fix format issues
joaopgrassi Sep 13, 2023
a4588f3
Use consistent markdown lang in snippet
joaopgrassi Sep 13, 2023
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
4 changes: 2 additions & 2 deletions envoy/stats/primitive_stats_macros.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ namespace Envoy {
*
* By convention, starting with #7083, we sort the lines of this macro block, so
* all the counters are grouped together, then all the gauges, etc. We do not
* use clang-format-on/off etc. "./tools/code_format/check_format.py fix" will take care of
* lining up the backslashes.
* use clang-format-on/off etc. "bazel run //tools/code_format:check_format -- fix" will take
* care of lining up the backslashes.
*
* Now actually put these stats somewhere, usually as a member of a struct:
* struct MyCoolStats {
Expand Down
4 changes: 2 additions & 2 deletions envoy/stats/stats_macros.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ namespace Envoy {
*
* By convention, starting with #7083, we sort the lines of this macro block, so
* all the counters are grouped together, then all the gauges, etc. We do not
* use clang-format-on/off etc. "./tools/code_format/check_format.py fix" will take care of
* lining up the backslashes.
* use clang-format-on/off etc. "bazel run //tools/code_format:check_format -- fix" will take
* care of lining up the backslashes.
*
* Now actually put these stats somewhere, usually as a member of a struct:
* struct MyCoolStats {
Expand Down
8 changes: 4 additions & 4 deletions support/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,19 +55,19 @@ affected files manually or run the provided formatting script.

To run the format fix script directly:

```
./tools/code_format/check_format.py fix && ./tools/code_format/format_python_tools.sh fix
```console
bazel run //tools/code_format:check_format -- fix && ./tools/code_format/format_python_tools.sh fix
Copy link
Copy Markdown
Member

@phlax phlax Sep 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for ref - it the python formatter mentioned here that we need to excise

```

To run the format fix script under Docker:

```
```console
./ci/run_envoy_docker.sh './ci/do_ci.sh format'
```

To run clang-tidy under Docker, run the following (this creates a full
compilation db and takes a long time):

```
```console
./ci/run_envoy_docker.sh ci/do_ci.sh bazel.clang_tidy
```
4 changes: 3 additions & 1 deletion tools/code_format/check_format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1048,7 +1048,9 @@ def run_checks(self):

if self.check_error_messages():
if self.args.operation_type == "check":
print("ERROR: check format failed. run '//tools/code_format:check_format -- fix'")
print(
"ERROR: check format failed. run 'bazel run //tools/code_format:check_format -- fix'"
)
else:
print("ERROR: check format failed. diff has been applied'")
sys.exit(1)
Expand Down