DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] tools: add EditorConfig file
@ 2019-10-18  7:59 Robin Jarry
  2019-10-18  9:08 ` Burakov, Anatoly
                   ` (3 more replies)
  0 siblings, 4 replies; 10+ messages in thread
From: Robin Jarry @ 2019-10-18  7:59 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev

EditorConfig is a file format and collection of text editor plugins for
maintaining consistent coding styles between different editors and IDEs.

Initialize the file following the coding rules in
doc/guides/contributing/coding_style.rst,
doc/guides/contributing/documentation.rst and
doc/guides/contributing/patches.rst.

In order for this file to be taken into account (unless they use an
editor with built-in EditorConfig support), developers will have to
install a plugin.

Note: The max_line_length property is only supported by a limited number
of EditorConfig plugins. It will be ignored if unsupported.

Add this new file in MAINTAINERS in the "Developers and Maintainers
Tools" section.

Link: https://editorconfig.org/
Link: https://github.com/editorconfig/editorconfig-emacs
Link: https://github.com/editorconfig/editorconfig-vim
Link: https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#max_line_length
Cc: Thomas Monjalon <thomas@monjalon.net>
Signed-off-by: Robin Jarry <robin.jarry@6wind.com>
---
 .editorconfig | 23 +++++++++++++++++++++++
 MAINTAINERS   |  1 +
 2 files changed, 24 insertions(+)
 create mode 100644 .editorconfig

diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 000000000000..c5704d89b8c6
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,23 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2019 6WIND S.A.
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = tab
+tab_width = 8
+max_line_length = 80
+
+[**.py]
+indent_style = space
+indent_size = 4
+
+[**.rst]
+indent_style = space
+indent_size = 3
+
+[COMMIT_EDITMSG]
+max_line_length = 72
diff --git a/MAINTAINERS b/MAINTAINERS
index f8a56e2e2615..16b4eb18cafa 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -82,6 +82,7 @@ F: doc/
 
 Developers and Maintainers Tools
 M: Thomas Monjalon <thomas@monjalon.net>
+F: .editorconfig
 F: MAINTAINERS
 F: devtools/check-dup-includes.sh
 F: devtools/check-maintainers.sh
-- 
2.23.0


^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2020-02-22 20:03 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-10-18  7:59 [dpdk-dev] [PATCH] tools: add EditorConfig file Robin Jarry
2019-10-18  9:08 ` Burakov, Anatoly
2019-10-18 15:47 ` Stephen Hemminger
2019-10-18 15:55   ` Robin Jarry
2019-10-18 15:48 ` Stephen Hemminger
2019-10-18 15:56   ` Robin Jarry
2019-10-18 16:08     ` Stephen Hemminger
2019-10-21  9:01       ` Bruce Richardson
2019-10-25 14:04 ` [dpdk-dev] [PATCH v2] devtools: " Robin Jarry
2020-02-22 20:03   ` Thomas Monjalon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).