all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Dmitry Gutov <dgutov@yandex.ru>
To: Robert Weiner <rswgnu@gmail.com>, emacs-devel@gnu.org
Subject: Re: Suggestion for improved clarity in xref.el symbol names
Date: Tue, 19 Apr 2016 23:55:09 +0300	[thread overview]
Message-ID: <22a19833-7133-ed1a-970c-c8b97eca8c78@yandex.ru> (raw)
In-Reply-To: <CA+OMD9hfGv8j+5WFmCLkNt6qiHrPQs+qhgmr4eO5u4TsOA1R_Q@mail.gmail.com>

Hello Robert,

On 04/19/2016 11:27 PM, Robert Weiner wrote:
> The xref.el library has many variables and functions with `backend' in
> them, indicating that they represent language-dependent entities.
> Before the xref API is set in stone, I would consider replacing this
> term with 'language' as it reads better in the names,

Thanks for the suggestion, but a backend is not a language, it's a 
particular solution for a given language and/or environment.

There will (hopefully) be multiple different backends for certain 
languages. There can be backends that are specific to a certain 
environment within a language (say, only projects using a particular 
framework), and so on.

A backend can also be language-agnostic. In fact, one of the two 
backends available now is that (etags).

> it refers to a
> concept intrinsic to the cross-references themselves which are
> language-specific, whereas backend is just an implementation detail, and
> it will make more sense to users of the library who may not be familiar
> with the concept of a `backend'.

The functions and variables with the word "backend" in them are normally 
something only backend authors should be concerned with. And they should 
get familiar with the concept, because xref-backend-functions is the 
main entry point to this API. I'm not sure the phrase "xref language" 
could convey the same notion.

The user-level commands don't have the word "backend" in them.



      parent reply	other threads:[~2016-04-19 20:55 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-19 20:27 Suggestion for improved clarity in xref.el symbol names Robert Weiner
2016-04-19 20:47 ` John Wiegley
2016-04-19 20:55 ` Dmitry Gutov [this message]

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=22a19833-7133-ed1a-970c-c8b97eca8c78@yandex.ru \
    --to=dgutov@yandex.ru \
    --cc=emacs-devel@gnu.org \
    --cc=rswgnu@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 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.