From: Robin Jarry <robin.jarry@6wind.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] tools: add EditorConfig file
Date: Fri, 18 Oct 2019 09:59:54 +0200 [thread overview]
Message-ID: <20191018075954.29715-1-robin.jarry@6wind.com> (raw)
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
next reply other threads:[~2019-10-18 8:00 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-18 7:59 Robin Jarry [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191018075954.29715-1-robin.jarry@6wind.com \
--to=robin.jarry@6wind.com \
--cc=dev@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).