all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Przemysław Wojnowski" <esperanto@cumego.com>
To: Stephen Leake <stephen_leake@stephe-leake.org>, emacs-devel@gnu.org
Subject: Re: How to find when a function/var has been added
Date: Sat, 08 Aug 2015 09:37:59 +0200	[thread overview]
Message-ID: <55C5B1D7.2010700@cumego.com> (raw)
In-Reply-To: <86egjgaga0.fsf@stephe-leake.org>

>> Adding simple "Since: x" to a doc is not very time consuming,
>
> Not for one doc, but it adds up _very_ quickly.
So it's good that "Since: x" adds up. It only means that number of documented
functions/vars is growing.
Maybe it could be generated and added, at the end of each docstring, by some
script that goes through git history and/or Changelog/NEWS and gets Emacs
version from there.

> And it will be very
> easy to forget to change it on a later edit; no information is one
> thing, wrong information is worse.
I don't get this one. To change "Since: x" on later edit? Why?

>> but may
>> make life much easier to its users.
>
> I guess we disagree on that.
>
> In particular, it is only useful for a very small subset of
> functions/variables. The ones that you happen to need are useful, but
> there's no way to know in advance which ones that will be.
Clearly we disagree here.
IMHO it is useful to any programmer that would like to write an Emacs package 
that works across some emacsen. For such people Emacs is a programming platform 
that can be deployed in different versions (API versions - in case of Emacs 
different libs/functions/vars). Having "Since: x" makes it faster learn and 
hence to write software that works on different versions of the platform.

For example Jira is such a platform. It may be installed in different versions,
and a programmer that writes Jira plugins needs to know which
classes/methods/vars can be used safely for a plugin.
Nobody expects such programmer to grep Jira's git history just to find it out.
It's just counterproductive.
When a company is developing a platform (say Jira) it makes programming on it
as easy as possible. Similar mindset is useful in non-commercial software too.

> I like Eli's 'git annotate' solution;
> that's an automated way to get mostly what you are asking for.
>
> It needs another step; relating a git hash to an Emacs version. I hope
> there's a git function that takes a hash and two tags and tells you if
> the hash occured between them.
You missed the step where a programmer have to download sources of the platform
just to find out whether a function can be used, when targeting some version
of the platform.



  parent reply	other threads:[~2015-08-08  7:37 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-08-05 18:38 How to find when a function/var has been added Przemysław Wojnowski
2015-08-05 19:06 ` David Kastrup
2015-08-05 19:32   ` Drew Adams
2015-08-05 20:53     ` Przemysław Wojnowski
2015-08-06  9:54       ` Stephen Leake
2015-08-05 20:46   ` Przemysław Wojnowski
2015-08-05 19:25 ` Eli Zaretskii
2015-08-05 21:01   ` Przemysław Wojnowski
2015-08-06  9:59     ` Stephen Leake
2015-08-06 14:37       ` Eli Zaretskii
2015-08-08  7:37       ` Przemysław Wojnowski [this message]
2015-08-09  6:26         ` Stephen Leake
2015-08-12 20:39           ` Przemysław Wojnowski
2015-08-07 15:57 ` Stefan Monnier
2015-08-07 15:58 ` Stefan Monnier

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=55C5B1D7.2010700@cumego.com \
    --to=esperanto@cumego.com \
    --cc=emacs-devel@gnu.org \
    --cc=stephen_leake@stephe-leake.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.