Skip to content

Commit

Permalink
Add .editorconfig file
Browse files Browse the repository at this point in the history
remove newlinet in binary file

editorconfig style guide

correct format for rst hyperlinks
  • Loading branch information
tuanpmt committed Dec 18, 2017
1 parent 8f874aa commit 5615b9c
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[{*.md,*.rst}]
trim_trailing_whitespace = false

[{Makefile,*.mk,*.bat}]
indent_style = tab
indent_size = 2

[*/freertos/**]
indent_style = tab
indent_size = 4

[{*/freertos/**.S,**/FreeRTOSConfig.h}]
indent_style = space
indent_size = 4

[*.pem]
insert_final_newline = false

[*.py]
max_line_length = 119
9 changes: 9 additions & 0 deletions docs/contribute/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,15 @@ To re-format a file, run::

tools/format.sh components/my_component/file.c


Configuring the code style for a project using EditorConfig
-----------------------------------------------------------

EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.

For more information, see `EditorConfig <http://editorconfig.org>`_ Website.


Documenting code
----------------

Expand Down

0 comments on commit 5615b9c

Please sign in to comment.