Skip to content

Latest commit

Β 

History

History
116 lines (92 loc) Β· 6.63 KB

FilesAndFolders.md

File metadata and controls

116 lines (92 loc) Β· 6.63 KB
Raw

Files and Folders

name content
.clang-format See below
.clang-format-ignore See below
.editorconfig See below
.code_snippets/
.git/ version control data base
.github/
.gitattributes See below
.gitignore
.goreleaser.yml
.idea/ GoLand
.travis.yml
.vscode/
AUTHORS.md
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
FoldersAndFiles.md this file
GoInfos.txt
LICENSE.md
README.md
_config.yml
branchesInfo.md
cmd/
coverage.out
dist/ created by goreleaser
docs/
examples/ real projects
fmtcoverage.html
go.mod
go.sum
internal/ trice Go packages for internal usage only
pkg/ trice Go packages usagable externally
src/ trice target sources
super-linter.report/
temp/ project binary logfiles
third_party/ tools
./cmd/cui (do not use) command user interface tryout code
./cmd/stim (do not use) target stimulation tool tryout code
./cmd/trice trice tool command Go sources
./docs documentation
./examples example target projects
./internal trice tool internal Go packages
./pkg trice tool common Go packages
./src/ C sources for trice instrumentation
./test automatic target code tests
./third_party external components

.clang-format

Contributor: Sazerac4

Sazerac4 commented Aug 29, 2024: I have a code formatter when I make changes to my application but I would like to keep the style of the library when modifying. I couldn't find a code formatter, is there a tool used? If not, I propose this to provide one as an example by using clang-format.

# I have created a default style :
clang-format -style=llvm -dump-config > .clang-format
# Then format the code:
find ./src  -name '*.c' -o  -name '*.h'| xargs clang-format-18 -style=file -i

The style of the example does not correspond to the original one. Configurations are necessary for this to be the case. Tags can be placed to prevent certain macros from being formatted

int formatted_code;
// clang-format off
    void    unformatted_code  ;
// clang-format on
void formatted_code_again;

I have tuned some settings for clang-format :

- IndentWidth: 4  // original code size indentation
- ColumnLimit: 0  // avoid breaking long line (like macros)
- PointerAlignment: Left  // like original files (mostly)

With preprocessor indentation, the result is a bit strange in some cases. It's possible with the option IndentPPDirectives (doc).

Staying as close as possible to a default version (LLVM in this case) makes it easier to regenerate the style if necessary.

See also: #487 (comment)

.clang-format-ignore

Contributor: Sazerac4

Sazerac4 commented Aug 30, 2024: I have added .clang-format-ignore to ignore formatting for specific files

.editorconfig

Contributor: Sazerac4

The.editorconfig file allows to better identify the basic style for every files. (endline, charset, ...). It is a file accepted by a wide list of IDEs and editors : link This addition is motivated by forgetting the end of line in the .gitattributes file.

.gitattributes

Contributor: Sazerac4

With the.gitattributes file avoid problems with "diff" and end of lines. Here is an article that presents the problem.

To fill the.gitattributes, I used the command below to view all the extensions currently used.

git ls-tree -r HEAD --name-only | perl -ne 'print $1 if m/\.([^.\/]+)$/' | sort -u