[SOLVED] Help with PKGBUILD for own software "vimiv"

karlch · 2015-12-02 20:52:19

I recently released the first considered the first considered stable version of my project mentioned here:
https://bbs.archlinux.org/viewtopic.php?id=205763

I am hoping to add it to the AUR but I have no experience with PKGBUILDs at all. This is what I have come up with so far:

# Maintainer: Christian Karl <christian.karl@protonmail.com>

pkgname='vimiv-git'
pkgver=0.1
pkgrel=1
pkgdesc='An image viewer with vim-like keybindings'
arch=('any')
url='https://github.com/karlch/vimiv'
license=('MIT')
depends=('python3' 'python-gobject' 'gtk3' 'python-pillow')
makedepends=('git')
optdepends=('imagemagick')
provides=('vimiv-git')
conflicts=('vimiv-git')
source=('$pkgname::git+${url}.git')
md5sums=('SKIP')

package() {
    cd '$srcdir/$pkgname'

    install -D -m755 vimiv $pkgdir/usr/bin/vimiv
    install -D -m644 vimivrc.py $pkgdir/etc/vimiv/vimivrc.py
    install -D -m644 vimiv.desktop $pkgdir/usr/share/applications/vimiv.desktop
    install -D -m644 LICENSE $pkgdir/usr/share/licenses/vimiv/LICENSE
    install -D -m644 vimiv.1 $pkgdir/usr/share/man/man1/vimiv.1
}

It works on my machine. Is there anything I should change, improve, do?

Last edited by karlch (2015-12-02 22:54:33)

WorMzy · 2015-12-02 20:58:22

Looks pretty good to me, but why does it provide and conflict with itself?

karlch · 2015-12-02 21:02:23

I copied that from this PKGBUILD:
https://aur.archlinux.org/cgit/aur.git/ … h=sxiv-git
and simply took for granted that this was a convention of some sort. I shall remove the conflicts part, thank you.

Trilby · 2015-12-02 21:02:45

If it's a git package you should use the pkgver function rather than a static pkgver.

You can make a PKGBUILD based on a specific git version/tag, but then this would not pull from head as this does, and it would have a checksum.

Other than that it looks great to me (except for the already mentioned provide/conflict entries, which are harmless, but just odd).

karlch · 2015-12-02 21:07:28

Thanks for your feedback.

I will need some further reading for the git part, as soon as I come up with a new version I will post it here again.

karlch · 2015-12-02 21:36:19

So here is what I have come up with, I do not quite understand what you mean with a checksum, but this seems to work with a pkgver function:

# Maintainer: Christian Karl <christian.karl@protonmail.com>

pkgname='vimiv-git'
pkgrel=1
pkgver=305af42
pkgdesc="An image viewer with vim-like keybindings"
arch=('any')
url="https://github.com/karlch/vimiv"
license=('MIT')
depends=('python3' 'python-gobject' 'gtk3' 'python-pillow')
makedepends=('git')
optdepends=('imagemagick: for the optimization of images')
provides=('vimiv-git')
source=("$pkgname::git+${url}.git")
md5sums=('SKIP')

pkgver() {
    cd "$pkgname" 
    git describe --long --always | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
}

package() {
    cd "$srcdir/$pkgname"

    install -D -m755 vimiv $pkgdir/usr/bin/vimiv
    install -D -m644 vimivrc.py $pkgdir/etc/vimiv/vimivrc.py
    install -D -m644 vimiv.desktop $pkgdir/usr/share/applications/vimiv.desktop
    install -D -m644 LICENSE $pkgdir/usr/share/licenses/vimiv/LICENSE
    install -D -m644 vimiv.1 $pkgdir/usr/share/man/man1/vimiv.1
}

EDIT: stupide me did not remove the provides/conflicts issue

Last edited by karlch (2015-12-02 21:42:31)

Trilby · 2015-12-02 21:55:42

karlch wrote:

I do not quite understand what you mean with a checksum

Don't worry about it - it doesn't apply if you pull from get (this is the sha256sum or md5sum), these are just SKIP for git packages. But if you were pulling a specific (and static) version/tag from git, then you'd want to include the checksum.

The above version looks great to me. I haven't tested it, but it's pretty clean, I don't see anything that could go wrong.

karlch · 2015-12-02 22:26:50

Thanks again, one last question, do I edit the version in .SRCINFO manually or is this also automated somehow?

respiranto · 2015-12-02 22:35:34

There is the command mksrcinfo which is provided by pkgbuild-introspection.

karlch · 2015-12-02 22:39:58

Yep, I used that to create the file

I will try to clarify my question.

If I understand everything correctly the package now receives a version depending on the git commit. The version of the package is automatically adapted when makepkg is run. But the version is also displayed on the AUR website. So would I have to readd the package to the AUR website everytime I do a git commit to the software or is the version there also updated automatically somehow? Or is it okay to have an outdated git version in the website description?

respiranto · 2015-12-02 22:47:14

The website's shown data relies on the data provided in the .SRCINFO, i.e. it will stay the same.
To my knowledge it is common to have rather outdated numbers displayed there, however I personally avoid this by regularly checking for updates using cron.

karlch · 2015-12-02 22:52:51

Alright, I will try to keep it up to date. Thank you.

And thanks to all your help vimiv is now available in the AUR:
https://aur.archlinux.org/packages/vimiv-git/

Scimmia · 2015-12-03 00:49:22

The pkgver function is bad. That only works if the repo has tags, this one doesn't.

You still have the pkgname in "provides".

You should quote any paths that use $pkgdir or $srcdir.

The first command in one function is cd "$pkgname", the other is cd "$srcdir/$pkgname". They do the same thing, but should be consistent.

Last edited by Scimmia (2015-12-03 00:53:11)

Trilby · 2015-12-03 03:18:02

karlch wrote:

But the version is also displayed on the AUR website. So would I have to readd the package to the AUR website everytime I do a git commit to the software or is the version there also updated automatically somehow? Or is it okay to have an outdated git version in the website description?

You would not want to update the AUR website package everytime you commit something to git. You could periodically if you wanted, there'd be no real harm other than the small bit of bandwidth used. But this is just generally not done.

It is okay - and infact expected - to have an outdated git version in the website description. This is one of the main reasons such packages need a postfix like "-git" in this case (others are "-cvs" or "-bzr" ...) These indicate that the package builds a development version and users can rebuild at anytime for the newest development version regardless of what the AUR website lists for a version number.

karlch · 2015-12-03 09:03:35

Scimmia wrote:

The pkgver function is bad. That only works if the repo has tags, this one doesn't.
You still have the pkgname in "provides".
You should quote any paths that use $pkgdir or $srcdir.
The first command in one function is cd "$pkgname", the other is cd "$srcdir/$pkgname". They do the same thing, but should be consistent.

Thanks for your suggestions, here is my next version:

pkgname='vimiv-git'
pkgrel=1
pkgver=r35.305af42
pkgdesc="An image viewer with vim-like keybindings"
arch=('any')
url="https://github.com/karlch/vimiv"
license=('MIT')
depends=('python3' 'python-gobject' 'gtk3' 'python-pillow')
makedepends=('git')
optdepends=('imagemagick: for the optimization of images')
source=("$pkgname::git+${url}.git")
md5sums=('SKIP')

pkgver() {
    cd "$srcdir/$pkgname" 
    printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
}

package() {
    cd "$srcdir/$pkgname"

    install -D -m755 vimiv "$pkgdir/usr/bin/vimiv"
    install -D -m644 vimivrc.py "$pkgdir/etc/vimiv/vimivrc.py"
    install -D -m644 vimiv.desktop "$pkgdir/usr/share/applications/vimiv.desktop"
    install -D -m644 LICENSE "$pkgdir/usr/share/licenses/vimiv/LICENSE"
    install -D -m644 vimiv.1 "$pkgdir/usr/share/man/man1/vimiv.1"
}

Trilby wrote:

You would not want to update the AUR website package everytime you commit something to git.

Makes perfect sense to me and makes life a lot easier.

Arch Linux

#1 2015-12-02 20:52:19

[SOLVED] Help with PKGBUILD for own software "vimiv"

#2 2015-12-02 20:58:22

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#3 2015-12-02 21:02:23

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#4 2015-12-02 21:02:45

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#5 2015-12-02 21:07:28

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#6 2015-12-02 21:36:19

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#7 2015-12-02 21:55:42

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#8 2015-12-02 22:26:50

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#9 2015-12-02 22:35:34

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#10 2015-12-02 22:39:58

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#11 2015-12-02 22:47:14

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#12 2015-12-02 22:52:51

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#13 2015-12-03 00:49:22

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#14 2015-12-03 03:18:02

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

#15 2015-12-03 09:03:35

Re: [SOLVED] Help with PKGBUILD for own software "vimiv"

Board footer