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.

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

Add an EditorConfig file #13

Merged
merged 1 commit into from Dec 26, 2019
Merged

Add an EditorConfig file #13

merged 1 commit into from Dec 26, 2019

Conversation

gszy
Copy link
Contributor

@gszy gszy commented Dec 25, 2019

EditorConfig is a standard that makes it possible to automatically configure supported text editors with basic project­‑specific coding style properties, like charset or indentation. See https://editorconfig.org/ for more details.

This pull request introduces an EditorConfig file that enables basic properties for all files: the UTF‑8 charset, Unix line breaks, 4‑spaces based indentation, automatic line break at the end of a file, no hard limit on line length and automatic trimming of trailing whitespaces. The last property is disabled for Markdown files, as double trailing space has a special meaning there.

Makefiles are configured to use mixed indentation, unfortunately some EditorConfig­‑enabled editors don’t support it fully.

Finally, linker and startup files (and the licence file, by the way) have hard line length limit of 80 characters.

This pull request also cleans up missing or excess line breaks at the end of several files.

EditorConfig is a standard that makes it possible to automatically
configure supported text editors with basic project‐specific coding
style properties, like charset or indentation. See
<https://editorconfig.org/> for more details.

This commit introduces an EditorConfig file that enables basic
properties for all files: the UTF‑8 charset, Unix line breaks, 4‑spaces
based indentation, automatic line break at the end of a file, no hard
limit on line length and automatic trimming of trailing whitespaces. The
last property is disabled for Markdown files, as double trailing space
has a special meaning there.

Makefiles are configured to use mixed indentation, unfortunately some
EditorConfig‐enabled editors don’t support it fully.

Finally, linker and startup files (and the licence file, by the way)
have hard line length limit of 80 characters.

This commit also cleans up missing or excess line breaks at the end of
several files.
@ThomasGravekamp
Copy link
Collaborator

Thanks for your contribution!

I've read about those configuration files a long time ago. I never thought of adding them to this project. I'll merge this PR.

@ThomasGravekamp ThomasGravekamp merged commit 53f2c80 into STM32-base:master Dec 26, 2019
@gszy gszy deleted the editorconfig branch December 27, 2019 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants