all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
To: emacs-devel@gnu.org
Subject: Re: changes to cfengine-mode
Date: Fri, 16 Dec 2011 19:45:53 -0500	[thread overview]
Message-ID: <jwvzkes9gq8.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <87pqfs16x0.fsf@lifelogs.com> (Ted Zlatanov's message of "Tue, 13 Dec 2011 15:46:35 -0600")

> OK.  See attached, and I hope final, patch.

A few more nit picks, feel free to install the patch after addressing them.

> +(defcustom cfengine-mode-debug nil
> +  "Whether `cfengine-mode' should print debugging info
> + (only used by the cfengine3 support currently)"
> +  :group 'cfengine
> +  :type 'boolean)

We usually make those debug variables with `defvar' rather than `defcustom'.

>  (defcustom cfengine-mode-abbrevs nil
> -  "Abbrevs for Cfengine mode."
> +  "Abbrevs for CFEngine2 mode.
> +Obsolete, see `edit-abbrevs' instead."
[...]
> +(make-obsolete-variable 'cfengine-mode-abbrevs nil "24.1")

Don't mention "Obsolete" in the docstring, since the
make-obsolete-variable already gives this info.  And please put the
"use edit-abbrevs" as second argument to make-obsolete-variable instead.

>  (defvar cfengine3-font-lock-keywords
>    `(
> +    ;; defuns

Please capitalize your comments.

> +    (,(concat "\\<" cfengine3-defuns-regex "\\>"
> +              "[ \t]+\\<\\([[:alnum:]_]+\\)\\>"
> +              "[ \t]+\\<\\([[:alnum:]_]+\\)\\((\\([^)]*\\))\\)")
> +    (1 font-lock-builtin-face)
> +    (2 font-lock-constant-face)
> +    (3 font-lock-function-name-face)
> +    (5 font-lock-variable-name-face))
> +
> +    (,(concat "\\<" cfengine3-defuns-regex "\\>"
> +              "[ \t]+\\<\\([[:alnum:]_]+\\)\\>"
> +              "[ \t]+\\<\\([[:alnum:]_]+\\)")
> +    (1 font-lock-builtin-face)
> +    (2 font-lock-constant-face)
> +    (3 font-lock-function-name-face))

Why not merge the two entries into something like:

       (,(concat "\\<" cfengine3-defuns-regex "\\>"
                 "[ \t]+\\<\\([[:alnum:]_]+\\)\\>"
                 "[ \t]+\\<\\([[:alnum:]_]+\\)\\(?:(\\([^)]*\\))\\)?")
       (1 font-lock-builtin-face)
       (2 font-lock-constant-face)
       (3 font-lock-function-name-face)
       (4 font-lock-variable-name-face nil t))

And please make sure you explain in the commit log (or here in comments)
why this code was moved to the beginning of
cfengine3-font-lock-keywords.


        Stefan



  reply	other threads:[~2011-12-17  0:45 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-11-22 17:18 prog-mode not available in earlier Emacsen, need help with cfengine.el Ted Zlatanov
2011-11-22 18:05 ` Eli Zaretskii
2011-11-22 18:45   ` Ted Zlatanov
2011-11-22 22:30     ` Stefan Monnier
2011-11-23  2:09       ` Ted Zlatanov
2011-11-23  6:03         ` Chong Yidong
2011-11-23 13:35           ` Ted Zlatanov
2011-11-24  6:03             ` Chong Yidong
2011-11-25 13:17               ` Ted Zlatanov
2011-11-26 10:57                 ` Reiner Steib
2011-11-27  2:06                   ` Ted Zlatanov
2011-12-01 15:39                     ` Ted Zlatanov
2011-12-02 16:12                       ` changes to cfengine-mode (was: prog-mode not available in earlier Emacsen, need help with cfengine.el) Ted Zlatanov
2011-12-02 20:32                         ` changes to cfengine-mode Stefan Monnier
2011-12-07 11:04                           ` Ted Zlatanov
2011-12-07 16:10                             ` Stefan Monnier
2011-12-08  9:52                               ` Chong Yidong
2011-12-13 17:21                               ` Ted Zlatanov
2011-12-13 19:51                                 ` Stefan Monnier
2011-12-13 21:46                                   ` Ted Zlatanov
2011-12-17  0:45                                     ` Stefan Monnier [this message]
2011-12-21 11:31                                       ` Ted Zlatanov
2011-12-13 17:23                               ` Ted Zlatanov
2011-12-07 16:12                             ` Stefan Monnier
2011-12-13 15:47                               ` Ted Zlatanov

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=jwvzkes9gq8.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.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.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.