[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [RISU PATCH v5 02/13] README: document the coding style use
From: |
Alex Bennée |
Subject: |
[Qemu-devel] [RISU PATCH v5 02/13] README: document the coding style used for risu |
Date: |
Mon, 19 Jun 2017 11:46:44 +0100 |
We also include the an Emacs .dir-locals (as per QEMU) that enforces
this layout.
Signed-off-by: Alex Bennée <address@hidden>
---
.dir-locals.el | 2 ++
README | 9 +++++++++
2 files changed, 11 insertions(+)
create mode 100644 .dir-locals.el
diff --git a/.dir-locals.el b/.dir-locals.el
new file mode 100644
index 0000000..3ac0cfc
--- /dev/null
+++ b/.dir-locals.el
@@ -0,0 +1,2 @@
+((c-mode . ((c-file-style . "stroustrup")
+ (indent-tabs-mode . nil))))
diff --git a/README b/README
index 4b37b4e..858a349 100644
--- a/README
+++ b/README
@@ -42,6 +42,15 @@ architecture that we support and that you have a cross
compiler
installed for. This is useful for confirming that your changes
to risu haven't broken anything.
+Coding Style
+------------
+
+risu follows the same coding style as the QEMU project, namely 4
+spaces (no tabs) for indentation and the One True Brace Style variant
+of K&R. The source tree includes a .dir-locals.el for Emacs users that
+will set this automatically. Other editors are available.
+
+
Usage
-----
--
2.13.0