From 96971677d46a58146a4129bcd3ceab3978b5cf88 Mon Sep 17 00:00:00 2001 From: Per Cederqvist Date: Thu, 22 Jan 2015 16:44:48 +0100 Subject: [PATCH] Added a short style guide, and Emacs settings. Signed-off-by: Per Cederqvist Signed-off-by: Josef 'Jeff' Sipek --- .dir-locals.el | 3 +++ Documentation/Contributing | 15 +++++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 .dir-locals.el diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 0000000..50ef2b7 --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,3 @@ +((nil . ((indent-tabs-mode . t) + (tab-width . 8))) + (sh-mode . ((sh-basic-offset . 8)))) diff --git a/Documentation/Contributing b/Documentation/Contributing index abf3480..0da49d6 100644 --- a/Documentation/Contributing +++ b/Documentation/Contributing @@ -4,6 +4,21 @@ Documentation/SubmittingPatches file. :) 1) Hack on the code a bit +Please follow this style guide: + + - Use tabs for indentation. + + - Put "then" on the same line as "if". + + - Follow the style of the existing code, except if it breaks the + above guidlines. + + - If you change the code to conform to the style guide, please do so + in a separate commit that does not change anything else. + +Please check that you change does not break "make test". Please add +new testcases for any new functionality, and if you fix a bug. + 2) Make a patch: Use "diff -up" or "diff -uprN" to create patches. Or simply use git to