Skip to content
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

Jump to bottom

Docs: Add Lint Target to Makefile #442

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Docs: Add Lint Target to Makefile #442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90c66ec
Update docs
edenreich Jul 2, 2024
7ab3de5
Add astyle as a dependency to Building-in-Ubuntu docs
edenreich Jul 2, 2024
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
8 changes: 2 additions & 6 deletions docs/development/CodingStyle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,10 @@ Any of these tools can get you pretty close:
Eclipse built in "K&R" style, after changing the indent to 4 spaces and change Braces after function declarations to Next line.

```
astyle --style=kr --indent=spaces=4 --min-conditional-indent=0 --max-instatement-indent=80 --pad-header --pad-oper --align-pointer=name --align-reference=name --max-code-length=120 --convert-tabs --preserve-date --suffix=none --mode=c
make lint
```

```
indent -kr -i4 -nut
```

(the options for these commands can be tuned more to comply even better)
(the rules for the linter can be tuned more to comply even better using [.astylerc](https://github.com/betaflight/betaflight/blob/master/.astylerc) config file)

Note: These tools are not authoritative.
Sometimes, for example, you may want other columns and line breaks so it looks like a matrix.
Expand Down
2 changes: 1 addition & 1 deletion docs/development/building/Building-in-Ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This document is tested and based on the latest Ubuntu 22.04 LTS release and can

```
$ sudo apt update && sudo apt upgrade
$ sudo apt install build-essential libblocksruntime-dev libtool git curl clang-12
$ sudo apt install build-essential libblocksruntime-dev libtool git curl clang-12 astyle
$ git clone https://github.com/betaflight/betaflight.git
$ cd betaflight
$ make arm_sdk_install
Expand Down
Loading