unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Oleh Krehel <ohwoeowho@gmail.com>
Cc: Artur Malabarba <bruce.connor.am@gmail.com>,
	emacs-devel <emacs-devel@gnu.org>
Subject: RE: Adding a few more finder keywords
Date: Mon, 8 Jun 2015 09:20:00 -0700 (PDT)	[thread overview]
Message-ID: <36a1364b-5023-4dfb-96a0-6f8b710403b3@default> (raw)
In-Reply-To: <87lhfukxyv.fsf@gmail.com>

> >> I've just added `checkdoc-package-keywords' that checks if the
> >> current file's keywords are in `finder-known-keywords'.
> >
> > Why? There is no reason to signal to users that there might be
> > a problem if they use keywords that are not in `finder-known-
> > keywords'.
> 
> It's a matter of checking the current keywords against a list of
> keywords that are known to be good. `finder-known-keywords' is a
> good start for such a list.

I know, but experience shows that such "checks", even when intended
to be only helpful and not restrictive, tend to be taken by some
users as indicating what is permissible.  IMHO, this is not helpful
as the default behavior.  Making it optional, and not turned on
by default, lets any user who is savvy and will not be frightened
or misled by such checking signalling phony "problems" can turn it on.

> > The purpose of `finder-known-keywords' is not to suggest that
> > other keywords are a mistake.  File-header `Keywords:' is for
> > arbitrary labels that any user can make use of.  It is not only
> > for "standard" keywords that might be "known" to Emacs at any
> > state, let alone to Emacs at startup.
> 
> I've provided a command that a package developer can voluntarily
> call to make sure that the keywords he chose are sound.

That's good.  I'm all for it.  Voluntary, customizable, and turned
off by default.  And I would probably be in favor of making
`finder-known-keywords' a user option, to facilitate and encourage
user customization of "the keywords he chose".

> It is for the benefit of all users if >2000 known packages can be
> organized by a smallish list of keywords, with no redundant
> synonyms, typos etc.

But you just acknowledged that the list is for "keywords he chose",
that is, keywords that a user can choose, and not just some
predefined "smallish list" of "standard" keywords.

> If a package author doesn't want to conform to the keyword
> guidelines

What guidelines?  File header `Keywords:' is not for package.el.
It predates it by decades, and its use is for arbitrary keywords.

If you want to invent a different file-header keyword from
`Keywords:', for example only for package.el or for your
prescribed more restrictive, guidelined use, then I'm not
opposed to that.  But please do not try to co-opt `Keywords:'
for something different from, and especially more restrictive
than, what it has been intended and used for all of these years.

> that I propose to recommend, fine: it's just a recommendation.

If it comes from GNU Emacs, such a recommendation should not
be applied to existing file-header keyword `Keywords:'.  If you
want to propose a new file-header keyword that has your
recommended use and meaning, please go right ahead.

In sum, OK to propose and check-doc whatever, but not for
the existing `Keywords:' keyword.



  reply	other threads:[~2015-06-08 16:20 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-04-25 16:59 Adding a few more finder keywords Artur Malabarba
2015-04-25 18:51 ` Drew Adams
2015-04-25 19:23   ` Artur Malabarba
2015-06-08 14:56 ` Oleh Krehel
2015-06-08 15:37   ` Drew Adams
2015-06-08 15:43     ` Oleh Krehel
2015-06-08 16:20       ` Drew Adams [this message]
2015-06-08 16:15   ` Artur Malabarba
2015-06-08 16:19     ` Artur Malabarba
2015-06-08 16:27       ` Drew Adams
2015-06-08 20:59   ` Stefan Monnier
2015-06-09  4:39     ` Stephen J. Turnbull
2015-06-09  6:52       ` Oleh Krehel
2015-06-09  8:02         ` Artur Malabarba
2015-06-09  8:54           ` Oleh Krehel
2015-06-09 14:22       ` Drew Adams
2015-06-09 14:47         ` Oleh Krehel
2015-06-09 16:05           ` Drew Adams
2015-06-09 16:47             ` Oleh Krehel
2015-06-09 17:19               ` Drew Adams
2015-06-09 16:08           ` Stephen J. Turnbull

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=36a1364b-5023-4dfb-96a0-6f8b710403b3@default \
    --to=drew.adams@oracle.com \
    --cc=bruce.connor.am@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=ohwoeowho@gmail.com \
    /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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).