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>
(cherry picked from commit 0927f0d822)
This commit is contained in:
Richard Levitte 2015-08-31 17:25:17 +02:00 committed by Richard Levitte
parent 1333891830
commit 92d0e6aa94
2 changed files with 19 additions and 0 deletions

17
doc/dir-locals.example.el Normal file
View file

@ -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")))

View file

@ -21,6 +21,8 @@
;;;
;;; A new buffer with .dir-locals.el will appear. Save it (C-x C-s).
;;;
;;; Alternatively, have a look at dir-locals.example.el
;;; For suggesting improvements, please send e-mail to levitte@openssl.org.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;