Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 581152 - app-emacs/buffer-extension: add ebuild for buffer-extension.el and dependencies
Summary: app-emacs/buffer-extension: add ebuild for buffer-extension.el and dependencies
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Victor Gaydov
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-04-25 11:51 UTC by Victor Gaydov
Modified: 2016-05-10 01:51 UTC (History)
3 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Victor Gaydov 2016-04-25 11:51:13 UTC
buffer-extension.el[1] provides enhanced functions for buffer manipulations.

Pull request[2] on github adds app-emacs/buffer-extension ebuild and its dependencies.

[1] https://www.emacswiki.org/emacs/buffer-extension.el
[2] https://github.com/gentoo/gentoo/pull/1339
Comment 1 Patrice Clement gentoo-dev 2016-04-25 12:16:56 UTC
Hello @gnu-emacs

Could someone peer-review Victor's PR and sign off on it? Thanks!
Comment 2 Ulrich Müller gentoo-dev 2016-04-25 12:55:57 UTC
Some comments throughout:

- Ebuilds should be newest EAPI, i.e. EAPI=6.
- Is the license really GPL-3 only? If it is GPL version 3 or later, it should be labelled LICENSE="GPL-3+".
- Empty IUSE="" assignments are not needed.
- The DEPENDs look suspicious, I'd guess they should be in RDEPEND as well. Also, please put DEPEND and RDEPEND in a separate block, betweeen the LICENSE/SLOT/KEYWORDS and the SITEFILE blocks.
- In site-init files, we usually include the first line of the function's docstring as the third argument. Also, is none of these functions interactive? Otherwise, a fourth argument of t should be added as well.
Comment 3 Victor Gaydov 2016-04-25 14:03:19 UTC
Please see updated PR.

> - Ebuilds should be newest EAPI, i.e. EAPI=6.

Fixed.

> - Is the license really GPL-3 only? If it is GPL version 3 or later, it
> should be labelled LICENSE="GPL-3+".

Partially fixed.

1. buffer-extension and basic-toolkit are really GPL-3+.

2. cycle-buffer mentions no license, but emacswiki has a GPL-2 footer, which is the "default" license I guess.

windows.el and revive.el mention no specific license; instead, they contain this note:

;;;	  This program is distributed as a free  software. The author is
;;;	not responsible  for  any  possible   defects   caused  by  this
;;;	software.

See also copyright notice[1] for debian `windows-el' package[2], which contains author's response to debian maintainers.

What license should we use for them?

> - Empty IUSE="" assignments are not needed.
> - The DEPENDs look suspicious, I'd guess they should be in RDEPEND as well.
> Also, please put DEPEND and RDEPEND in a separate block, betweeen the
> LICENSE/SLOT/KEYWORDS and the SITEFILE blocks.

Fixed.

> - In site-init files, we usually include the first line of the function's
> docstring as the third argument. Also, is none of these functions
> interactive? Otherwise, a fourth argument of t should be added as well.

Could you give an example please? Do we need autoloads for all provided functions in site-init files?

[1] http://sources.debian.net/copyright/license/windows-el/2.48-3/
[2] https://packages.debian.org/en/sid/windows-el
Comment 4 Ulrich Müller gentoo-dev 2016-04-25 15:26:17 UTC
(In reply to Victor from comment #3)
> 2. cycle-buffer mentions no license, but emacswiki has a GPL-2 footer, which
> is the "default" license I guess.

The wiki footer isn't the license of the file. Especially, it isn't a statement of the file's author, since cycle-buffer.el may have been uploaded to the wiki by somebody else.

The license needs to be clarified with the author before we can include the package.

> windows.el and revive.el mention no specific license; instead, they contain
> this note:
> 
> ;;;	  This program is distributed as a free  software. The author is
> ;;;	not responsible  for  any  possible   defects   caused  by  this
> ;;;	software.
> 
> See also copyright notice[1] for debian `windows-el' package[2], which
> contains author's response to debian maintainers.

This is less than ideal, but I think we can copy lines 15 to 42 from the Debian notice [1] and add them as a license file. It should go to the @MISC-FREE group (CCing licenses team).

> > - In site-init files, we usually include the first line of the function's
> > docstring as the third argument. Also, is none of these functions
> > interactive? Otherwise, a fourth argument of t should be added as well.
> 
> Could you give an example please?

See app-emacs/chess/files/50chess-gentoo.el which contains several examples.

> Do we need autoloads for all provided functions in site-init files?

The rule of thumb is that a function should be autoloaded if it would be executed by the user in order to start the package. For example, app-emacs/ebuild-mode has an autoload for 'ebuild-mode but not for any of the mode's internal commands (since those will be executed only when the package has been loaded).

A similar rule applies for functions called non-interactively by another package.

> [1] http://sources.debian.net/copyright/license/windows-el/2.48-3/
> [2] https://packages.debian.org/en/sid/windows-el
Comment 5 Victor Gaydov 2016-04-26 10:27:12 UTC
> > 2. cycle-buffer mentions no license, but emacswiki has a GPL-2 footer, which
> > is the "default" license I guess.
> 
> The wiki footer isn't the license of the file. Especially, it isn't a
> statement of the file's author, since cycle-buffer.el may have been uploaded
> to the wiki by somebody else.
> 
> The license needs to be clarified with the author before we can include the
> package.

OK. I'll try to send him an email.

> > windows.el and revive.el mention no specific license; instead, they contain
> > this note:
> > 
> > ;;;	  This program is distributed as a free  software. The author is
> > ;;;	not responsible  for  any  possible   defects   caused  by  this
> > ;;;	software.
> > 
> > See also copyright notice[1] for debian `windows-el' package[2], which
> > contains author's response to debian maintainers.
> 
> This is less than ideal, but I think we can copy lines 15 to 42 from the
> Debian notice [1] and add them as a license file. It should go to the
> @MISC-FREE group (CCing licenses team).

Done, see updated PR.

> > > - In site-init files, we usually include the first line of the function's
> > > docstring as the third argument. Also, is none of these functions
> > > interactive? Otherwise, a fourth argument of t should be added as well.
> > 
> > Could you give an example please?
> 
> See app-emacs/chess/files/50chess-gentoo.el which contains several examples.
> 
> > Do we need autoloads for all provided functions in site-init files?
> 
> The rule of thumb is that a function should be autoloaded if it would be
> executed by the user in order to start the package. For example,
> app-emacs/ebuild-mode has an autoload for 'ebuild-mode but not for any of
> the mode's internal commands (since those will be executed only when the
> package has been loaded).
> 
> A similar rule applies for functions called non-interactively by another
> package.

All packages now have autoload comments and use `elisp-make-autoload-file'. Is it OK?

I've also updated `basic-toolkit' to version 0.3 (with autoload comments) and removed revive-2.22 ebuild.
Comment 6 Victor Gaydov 2016-04-27 15:01:24 UTC
The author of cycle-buffer.el kindly published the module on github[1] under public domain. EmacsWiki page[2] is also updated now[2].

(See updated pull request)

Are there any other outstanding issues?

[1] https://github.com/VladimirAlexiev/emacs/blob/master/cycle-buffer.el
[2] https://www.emacswiki.org/emacs/cycle-buffer.el
Comment 7 Ulrich Müller gentoo-dev 2016-05-01 17:33:57 UTC
Looks good.
Thanks for the contribution!
Comment 8 Ulrich Müller gentoo-dev 2016-05-01 17:44:16 UTC
One minor point: You are the "proxied maintainer", whereas a "proxy maintainer" is someone who is committing for you. I've updated all metadata.xml accordingly.
Comment 9 Victor Gaydov 2016-05-01 18:10:54 UTC
> You are the "proxied maintainer", whereas a "proxy maintainer" is someone who
> is committing for you. I've updated all metadata.xml accordingly.

Ah, really.

Thanks!

Is it OK that SRC_URIs in ebuilds still point to my server[1]? I'm not 100% sure that it will always work 24/7 :)

[1] https://enise.org/users/victor/share/distfiles/
Comment 10 Ulrich Müller gentoo-dev 2016-05-01 18:46:51 UTC
(In reply to Victor from comment #9)
> Is it OK that SRC_URIs in ebuilds still point to my server[1]? I'm not 100%
> sure that it will always work 24/7 :)
> 
> [1] https://enise.org/users/victor/share/distfiles/

That should be OK, as the files will be on the Gentoo mirror system too. Alternatively, I could copy them to my dev space. Just tell me what you prefer.
Comment 11 Victor Gaydov 2016-05-01 19:49:37 UTC
(In reply to Ulrich Müller from comment #10)
> (In reply to Victor from comment #9)
> > Is it OK that SRC_URIs in ebuilds still point to my server[1]? I'm not 100%
> > sure that it will always work 24/7 :)
> > 
> > [1] https://enise.org/users/victor/share/distfiles/
> 
> That should be OK, as the files will be on the Gentoo mirror system too.
> Alternatively, I could copy them to my dev space. Just tell me what you
> prefer.

Great, then it's more convenient to keep in when they are.
Comment 12 Victor Gaydov 2016-05-01 19:50:08 UTC
*keep them
Comment 13 Victor Gaydov 2016-05-02 06:55:36 UTC
*where
Comment 14 Ian Delaney (RETIRED) gentoo-dev 2016-05-10 01:51:03 UTC
Thanks ulm. The bug ought to be assigned to the maintainer.