Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Yao Qi <yao@codesourcery.com>
To: <gdb-patches@sourceware.org>
Subject: [PATCH] Check code stype in Emacs: gdb-code-style.el
Date: Sat, 14 Apr 2012 07:46:00 -0000	[thread overview]
Message-ID: <1334378614-13787-1-git-send-email-yao@codesourcery.com> (raw)

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


             reply	other threads:[~2012-04-14  4:43 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-04-14  7:46 Yao Qi [this message]
2012-04-14 12:24 ` Eli Zaretskii
2012-04-16 20:01 ` Tom Tromey
2012-04-19  4:14   ` [committed] : " Yao Qi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1334378614-13787-1-git-send-email-yao@codesourcery.com \
    --to=yao@codesourcery.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox