summaryrefslogtreecommitdiffstats
path: root/doc/dir-locals.example.el
diff options
context:
space:
mode:
authorRichard Levitte <richard@levitte.org>2015-08-31 17:25:17 +0200
committerRichard Levitte <richard@levitte.org>2015-08-31 18:15:32 +0200
commit0927f0d822b1e0f55cb7d8bacf9004ad3495514b (patch)
treecfa4dec269c8437ea5be7fea4410d952cc400cba /doc/dir-locals.example.el
parentd9b3554b2d9724bc2d1621a026ddaf0223e2d191 (diff)
Add an example .dir-locals.el
This file, when copied to .dir-locals.el in the OpenSSL source top, will make sure that the CC mode style "OpenSSL-II" will be used for all C files. Additionally, I makes sure that tabs are never used as indentation character, regardless of the emacs mode, and that the fill column is 78. Reviewed-by: Rich Salz <rsalz@openssl.org>
Diffstat (limited to 'doc/dir-locals.example.el')
-rw-r--r--doc/dir-locals.example.el17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/dir-locals.example.el b/doc/dir-locals.example.el
new file mode 100644
index 0000000000..a9fa24464e
--- /dev/null
+++ b/doc/dir-locals.example.el
@@ -0,0 +1,17 @@
+;;; This is an example of what a .dir-locals.el suitable for OpenSSL
+;;; development could look like.
+;;;
+;;; Apart from setting the CC mode style to "OpenSSL-II", it also
+;;; makes sure that tabs are never used for indentation in any file,
+;;; and that the fill column is 78.
+;;;
+;;; For more information see (info "(emacs) Directory Variables")
+
+((nil
+ (indent-tabs-mode . nil)
+ (fill-column . 78)
+ ;; (auto-fill-mode . t) ;; optional.
+ )
+ (c-mode
+ (auto-fill-mode . nil) ;; auto-fill makes more harm than good in C
+ (c-file-style . "OpenSSL-II")))