This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[PATCH] Check code stype in Emacs: gdb-code-style.el
- From: Yao Qi <yao at codesourcery dot com>
- To: <gdb-patches at sourceware dot org>
- Date: Sat, 14 Apr 2012 12:43:34 +0800
- Subject: [PATCH] Check code stype in Emacs: gdb-code-style.el
Hi,
gdb-code-style.el gives some checks, and highlight corresponding parts
if they are violations on a certain rule or convention in gdb development.
So far, it only has two, and I'd like to push more, if it is the right
way to go.
Ideally, I hope these checks can go to gdb/.dir-locals.el, as they apply
when people open gdb source files automatically. However, the repeated
warning when opening files force me to think about moving them to a
separate .el file, and give contributors to decide use this .el or not.
Some of the rules I am using are from the lesson I learned from the review
to my patches, such as missing space or superfluous spaces. I am sure
it is useful, especially to new contributors.
gdb:
* gdb-code-style.el: New.
---
gdb/gdb-code-style.el | 35 +++++++++++++++++++++++++++++++++++
1 files changed, 35 insertions(+), 0 deletions(-)
create mode 100644 gdb/gdb-code-style.el
diff --git a/gdb/gdb-code-style.el b/gdb/gdb-code-style.el
new file mode 100644
index 0000000..5919e3d
--- /dev/null
+++ b/gdb/gdb-code-style.el
@@ -0,0 +1,35 @@
+;; Emacs settings to check various code styles.
+;; Copyright (C) 2012 Free Software Foundation, Inc.
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+;; These hooks defined in this file provide some code style checks in
+;; Emacs. You can load it in your ~/.emacs,
+;; (load-file "~/$(GDB_SOURCE)/gdb/gdb-code-style.el")
+
+;; Don't use these functions. Their alternatives are better. This list
+;; of functions is from ARI rules.
+(defun gdb-fun-name-hook ()
+ (font-lock-add-keywords
+ nil
+ '(("\\<\\(\\(xasprintf\\|abort\\|vasprintf\\|strerror\\|strdup\\|asprintf\\|sprintf\\)[ ]*\(\\)" 1 font-lock-warning-face t))))
+(add-hook 'c-mode-common-hook 'gdb-fun-name-hook)
+
+;; Don't include these files directly.
+(defun gdb-include-hook ()
+ (font-lock-add-keywords
+ nil
+ '(("\\<include[ ]*\\(<\\(stat\\|dirent\\|wait\\|sys/wait\\|assert\\)\\.h>\\)" 1 font-lock-warning-face t))))
+
+(add-hook 'c-mode-common-hook 'gdb-include-hook)
--
1.7.0.4