[ITP] The Silver Searcher / Ag

[ITP] The Silver Searcher / Ag

[Adam Dinwoodie]

Folks,

I'm looking at packaging The Silver Searcher, aka Ag.  The Silver
Searcher is a grep/Ack replacement designed for searching code and
optimised for speed.

The package has an Apache 2.0 license, and is already packaged for
Debian, Ubuntu and Fedora, amongst others.

setup.hint is below, further information in the links.

Adam

Package home page: http://geoff.greer.fm/ag/
Package source: https://github.com/ggreer/the_silver_searcher
License: https://github.com/ggreer/the_silver_searcher/blob/master/LICENSE
Cygport files: https://github.com/me-and/Cygwin-ag
Debian package: https://packages.debian.org/sid/utils/silversearcher-ag
Ubuntu package: https://launchpad.net/ubuntu/+source/silversearcher-ag
Fedora package: https://apps.fedoraproject.org/packages/the_silver_searcher

category: Utils
requires: cygwin liblzma5 libpcre1 zlib0
sdesc: "Ag: a code searching tool with a focus on speed"
ldesc: "The Silver Searcher (Ag) is a code searching tool similar to Ack,
with a focus on speed."

Re: [ITP] The Silver Searcher / Ag

[Yaakov Selkowitz]

On 2016-02-23 08:42, Adam Dinwoodie wrote:
> I'm looking at packaging The Silver Searcher, aka Ag.  The Silver
> Searcher is a grep/Ack replacement designed for searching code and
> optimised for speed.
>
> The package has an Apache 2.0 license, and is already packaged for
> Debian, Ubuntu and Fedora, amongst others.
>
> setup.hint is below, further information in the links.

> SRC_URI="https://github.com/ggreer/the_silver_searcher/archive/${PV}.tar.gz"

SRC_URI="https://github.com/ggreer/the_silver_searcher/archive/${VERSION}/the_silver_searcher-${VERSION}.tar.gz"

This works better with DISTDIR.

> the_silver_searcher_completion_REQUIRES='the_silver_searcher bash_completion'
                                                                    ^
That should be bash-completion with a hyphen.

>   cyginstall bashcompdir=/etc/bash_completion.d

We have bash-completion-2.1 now, so you can use bashcompdir=$(pkg-config 
--variable=completionsdir bash-completion) -- and change *_CONTENTS 
accordingly.

-- 
Yaakov

Re: [ITP] The Silver Searcher / Ag

[Warren Young]

On Feb 23, 2016, at 7:42 AM, Adam Dinwoodie <adam@dinwoodie.org> wrote:
> 
> I'm looking at packaging The Silver Searcher, aka Ag.

That would be lovely!  I’ve been building it from source since I discovered it, about a year ago.

(Anyone still using grep -R on a source tree really should switch to ag!)

Re: [ITP] The Silver Searcher / Ag

[Adam Dinwoodie]

On Tue, Feb 23, 2016 at 10:54:04AM -0600, Yaakov Selkowitz wrote:
> On 2016-02-23 08:42, Adam Dinwoodie wrote:
> >SRC_URI="https://github.com/ggreer/the_silver_searcher/archive/${PV}.tar.gz"
> 
> SRC_URI="https://github.com/ggreer/the_silver_searcher/archive/${VERSION}/the_silver_searcher-${VERSION}.tar.gz"
> 
> This works better with DISTDIR.

I didn't know that URL existed.  I'll switch to that and do similar for
fzf, which also uses the first version of the command.

> >the_silver_searcher_completion_REQUIRES='the_silver_searcher bash_completion'
>                                                                    ^
> That should be bash-completion with a hyphen.

Good spot, thank you!

> >  cyginstall bashcompdir=/etc/bash_completion.d
> 
> We have bash-completion-2.1 now, so you can use
> bashcompdir=$(pkg-config --variable=completionsdir bash-completion)
> -- and change *_CONTENTS accordingly.

Ooh.  I hadn't spotted that change or the addition of on-demand
completion loading.  I'll have a look at whether the other packages I
maintain can take advantage of that, too.

For this package, it doesn't look as simple as _just_ changing
bashcompdir, though, as the script is called "ag.bashcomp.sh".  That
works just fine putting the file in compatdir, but doesn't load if it's
in completionsdir, because that expects the script to just be called
"ag".  I can see a few different solutions, and I'd appreciate a second
opinion:

1. Patch the Ag build process to call the script "ag" rather than
   "ag.bashcomp.sh".  This looks like it'd be a slightly complex and
   fragile patch, though.

2. Rename "ag.bashcomp.sh" to "ag" after the cyginstall step.  This
   still feels a bit fragile to me, although less so than option 1.

3. Install the script as "ag.bashcomp.sh", then create a symlink from
   "ag" to "ag.bashcomp.sh".  I'm currently leaning towards this as the
   neatest and safest solution, not least because it uses Cygport's
   dosym rather than a bare mv, although it does leave a more-or-less
   useless file in the completions directory.

4. Just install to /etc/bash_completion.d (although probably using
   "pkg-config --variable=compatdir bash-completion), which appears to
   be what the upstream package currently intends.

Anyone have any thoughts/advances on those options?

(The neatest solution would obviously be to get the upstream package to
install in the right directory in the first place, and it looks like
they'd be amenable to such a change based on an issue from 2013[0], but
it looks like it'd require some autoconf magic to be able to handle
versions of Bash completion both with and without on-demand loading, and
autoconf is an art I do not currently have.)

[0]: https://github.com/ggreer/the_silver_searcher/issues/271

Re: [ITP] The Silver Searcher / Ag

[Yaakov Selkowitz]

On 2016-02-24 04:26, Adam Dinwoodie wrote:
> For this package, it doesn't look as simple as _just_ changing
> bashcompdir, though, as the script is called "ag.bashcomp.sh".  That
> works just fine putting the file in compatdir, but doesn't load if it's
> in completionsdir, because that expects the script to just be called
> "ag".  I can see a few different solutions, and I'd appreciate a second
> opinion:
[snip]
> 4. Just install to /etc/bash_completion.d (although probably using
>     "pkg-config --variable=compatdir bash-completion), which appears to
>     be what the upstream package currently intends.
>
> Anyone have any thoughts/advances on those options?

Given the issues you stated, that will be fine.

-- 
Yaakov

Re: [ITP] The Silver Searcher / Ag

[Adam Dinwoodie]

On Wed, Feb 24, 2016 at 08:48:15AM -0600, Yaakov Selkowitz wrote:
> On 2016-02-24 04:26, Adam Dinwoodie wrote:
> >For this package, it doesn't look as simple as _just_ changing
> >bashcompdir, though, as the script is called "ag.bashcomp.sh".  That
> >works just fine putting the file in compatdir, but doesn't load if it's
> >in completionsdir, because that expects the script to just be called
> >"ag".  I can see a few different solutions, and I'd appreciate a second
> >opinion:
> [snip]
> >4. Just install to /etc/bash_completion.d (although probably using
> >    "pkg-config --variable=compatdir bash-completion), which appears to
> >    be what the upstream package currently intends.
> >
> >Anyone have any thoughts/advances on those options?
> 
> Given the issues you stated, that will be fine.

Does this and/or Warren's email count as a GTG?  I have the packages
ready to upload...

Re: [ITP] The Silver Searcher / Ag

[Corinna Vinschen]

[-- Attachment #1: Type: text/plain, Size: 1227 bytes --]

Hi Adam,

On Mar 15 10:05, Adam Dinwoodie wrote:
> On Wed, Feb 24, 2016 at 08:48:15AM -0600, Yaakov Selkowitz wrote:
> > On 2016-02-24 04:26, Adam Dinwoodie wrote:
> > >For this package, it doesn't look as simple as _just_ changing
> > >bashcompdir, though, as the script is called "ag.bashcomp.sh".  That
> > >works just fine putting the file in compatdir, but doesn't load if it's
> > >in completionsdir, because that expects the script to just be called
> > >"ag".  I can see a few different solutions, and I'd appreciate a second
> > >opinion:
> > [snip]
> > >4. Just install to /etc/bash_completion.d (although probably using
> > >    "pkg-config --variable=compatdir bash-completion), which appears to
> > >    be what the upstream package currently intends.
> > >
> > >Anyone have any thoughts/advances on those options?
> > 
> > Given the issues you stated, that will be fine.
> 
> Does this and/or Warren's email count as a GTG?  I have the packages
> ready to upload...

I added ag to cygwin-pkg-maint.  Please go ahead.


Thanks,
Corinna

-- 
Corinna Vinschen                  Please, send mails regarding Cygwin to
Cygwin Maintainer                 cygwin AT cygwin DOT com
Red Hat

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [ITP] The Silver Searcher / Ag

[Adam Dinwoodie]

On Tue, Mar 15, 2016 at 11:36:57AM +0100, Corinna Vinschen wrote:
> Hi Adam,
> 
> On Mar 15 10:05, Adam Dinwoodie wrote:
> > Does this and/or Warren's email count as a GTG?  I have the packages
> > ready to upload...
> 
> I added ag to cygwin-pkg-maint.  Please go ahead.

Hmm.  The package I uploaded was called the_silver_searcher, to match
Fedora's packaging (plus Gentoo, Arch, Slackware, BSD, ...), and I think
the mismatch is preventing upset from picking up the packages.  Could
you rename the package in cygwin-pkg-maint?

Thank you!

Re: [ITP] The Silver Searcher / Ag

[Corinna Vinschen]

[-- Attachment #1: Type: text/plain, Size: 781 bytes --]

On Mar 15 11:52, Adam Dinwoodie wrote:
> On Tue, Mar 15, 2016 at 11:36:57AM +0100, Corinna Vinschen wrote:
> > Hi Adam,
> > 
> > On Mar 15 10:05, Adam Dinwoodie wrote:
> > > Does this and/or Warren's email count as a GTG?  I have the packages
> > > ready to upload...
> > 
> > I added ag to cygwin-pkg-maint.  Please go ahead.
> 
> Hmm.  The package I uploaded was called the_silver_searcher, to match
> Fedora's packaging (plus Gentoo, Arch, Slackware, BSD, ...), and I think
> the mismatch is preventing upset from picking up the packages.  Could
> you rename the package in cygwin-pkg-maint?

Done.


Corinna

-- 
Corinna Vinschen                  Please, send mails regarding Cygwin to
Cygwin Maintainer                 cygwin AT cygwin DOT com
Red Hat

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]

Re: [ITP] The Silver Searcher / Ag

[Adam Dinwoodie]

On Tue, Mar 15, 2016 at 01:18:16PM +0100, Corinna Vinschen wrote:
> On Mar 15 11:52, Adam Dinwoodie wrote:
> > On Tue, Mar 15, 2016 at 11:36:57AM +0100, Corinna Vinschen wrote:
> > > Hi Adam,
> > > 
> > > On Mar 15 10:05, Adam Dinwoodie wrote:
> > > > Does this and/or Warren's email count as a GTG?  I have the packages
> > > > ready to upload...
> > > 
> > > I added ag to cygwin-pkg-maint.  Please go ahead.
> > 
> > Hmm.  The package I uploaded was called the_silver_searcher, to match
> > Fedora's packaging (plus Gentoo, Arch, Slackware, BSD, ...), and I think
> > the mismatch is preventing upset from picking up the packages.  Could
> > you rename the package in cygwin-pkg-maint?
> 
> Done.

Thank you!