Arch Linux PKGBUILD, AUR

  Hello,

I've found exman quite useful and suspect other (Arch) Linux users
might, too, so I'm considering adding a PKGBUILD for it to the AUR
[1].

I would like to ask:

0. Are you OK with me doing so?

1. Do you intend to cut releases, or is exman going to stay VCS-only
for the foreseeable future?

2. Could you please add a LICENSE file or otherwise specify the
licensing terms?

3. Any comments on the attached PKGBUILD?

[ A comment from my side: Arch Linux PKGBUILDs are interpreted by
bash(1), so I've chosen to take advantage of that and a few other
default GNUisms when tackling some of the challenges faced. ]

  Thanks and best wishes,

  Štěpán

[1] https://aur.archlinux.org/

 

## shellcheck disable=SC2034
# shellcheck disable=SC2164
# Maintainer: Štěpán Němec <stepnem@gmail.com>

pkgname=exman-git
pkgver=r22.c7c44d88fedb
pkgrel=1
pkgdesc="manuals for other systems"
arch=(any)
url="https://git.causal.agency/${pkgname%-git}"
license=(unknown)
depends=(man sh)
makedepends=(bmake git)
provides=("${pkgname%-git}")
conflicts=("${pkgname%-git}")
source=("git+https://git.causal.agency/${pkgname%-git}")
md5sums=(SKIP)
# zipman autocompression took 40m(!?) on my machine (4-core i7),
# parallelized and all (compared to ~1m with the custom package()
# below)
options=(!zipman)

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

prepare() {
  cd "$srcdir/${pkgname%-git}"
  # these two are better obtained via the 'man-pages' package, exclude
  # them
  sed -i -e '/^SYSTEMS += \(Linux\|POSIX\)/d' Makefile
}

build() {
  cd "$srcdir/${pkgname%-git}"
  bmake PREFIX=/usr TAR=bsdtar
}

package() {
  cd "$srcdir/${pkgname%-git}"
  # shellcheck disable=SC2154
  bmake PREFIX="$pkgdir/usr" TAR=bsdtar install

  find "$pkgdir" -empty -delete

  # macOS ships two perl(1) man pages...?
  if [[ -f "$pkgdir/usr/share/exman/macOS/man1/perl.1.gz" &&
          -f "$pkgdir/usr/share/exman/macOS/man1/perl.1" ]]; then
    echo 'Removing stray macOS perl.1 man page...'
    rm "$pkgdir/usr/share/exman/macOS/man1/perl.1.gz"
    echo 'Removing stray macOS perl.1 man page...done'
  fi

  echo 'Compressing uncompressed man pages...'
  find "$pkgdir/usr/share/man" "$pkgdir/usr/share/exman" -type f \
       ! -name '*.gz' -exec gzip --best '{}' + 2>&1 | tee log
  echo 'Compressing uncompressed man pages...done'

  # gzip (still) can't handle links...?
  # cf. e.g. http://www.argon.org/~roderick/gzip-links
  echo 'Compressing and fixing multiply (hard-)linked files...'
  local -a sources
  local inode path sOurce
  sed -ne 's/^gzip: \(.*\) has [^ ]\{1,\} other link.*$/\1/p' log |
    while IFS= read -r path; do
      inode="$(stat --printf='%i' "$path")"
      sOurce=${sources[$inode]}
      if [[ -n "$sOurce" ]]; then
	# we've already compressed one of the links; just link to it
	# from the other path(s)
        ln "$sOurce" "$path".gz
        rm "$path"
      elif gzip --best --force "$path"; then
        sources[$inode]=$path.gz
      else
        printf 'WARNING: failed to compress %s\n' "$path"
      fi
    done
  echo 'Compressing and fixing multiply (hard-)linked files...done'

  echo 'Fixing symbolic links...'
  # re-link to the newly compressed targets
  find "$pkgdir/usr/share/man" "$pkgdir/usr/share/exman" -xtype l \
       -exec sh -c 'ln -sf "$(readlink "$1")".gz "$1".gz && rm "$1"' sh {} \;
  echo 'Fixing symbolic links...done'

  chown -R root:root "$pkgdir"
}

> On Aug 22, 2021, at 04:44, Štěpán Němec <stepnem@gmail.com> wrote:
> 
> 
>  Hello,
> 
> I've found exman quite useful and suspect other (Arch) Linux users
> might, too, so I'm considering adding a PKGBUILD for it to the AUR
> [1].
> 
> I would like to ask:
> 
> 0. Are you OK with me doing so?

Of course :)

> 1. Do you intend to cut releases, or is exman going to stay VCS-only
> for the foreseeable future?

Since exman (loosely) tracks many upstream releases, I don’t think
it makes sense for it to have its own releases. Feel free to version
it however works.

> 2. Could you please add a LICENSE file or otherwise specify the
> licensing terms?

I’ve added an ISC license header to exman.in. As a package, you may
want to add the licenses of the various manual sets it includes.

> 3. Any comments on the attached PKGBUILD?
> 
> [ A comment from my side: Arch Linux PKGBUILDs are interpreted by
> bash(1), so I've chosen to take advantage of that and a few other
> default GNUisms when tackling some of the challenges faced. ]
> 
>  Thanks and best wishes,
> 
>  Štěpán
> 
> [1] https://aur.archlinux.org/
> 
> ## shellcheck disable=SC2034
> # shellcheck disable=SC2164
> # Maintainer: Štěpán Němec <stepnem@gmail.com>
> 
> pkgname=exman-git
> pkgver=r22.c7c44d88fedb
> pkgrel=1
> pkgdesc="manuals for other systems"
> arch=(any)
> url="https://git.causal.agency/${pkgname%-git}"
> license=(unknown)
> depends=(man sh)
> makedepends=(bmake git)

I think bsdtar and curl are missing from this list? Unless they’re
implied somehow.

> provides=("${pkgname%-git}")
> conflicts=("${pkgname%-git}")
> source=("git+https://git.causal.agency/${pkgname%-git}")
> md5sums=(SKIP)
> # zipman autocompression took 40m(!?) on my machine (4-core i7),
> # parallelized and all (compared to ~1m with the custom package()
> # below)
> options=(!zipman)
> 
> pkgver() {
>  # shellcheck disable=SC2154
>  cd "$srcdir/${pkgname%-git}"
>  printf "r%s.%s" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"
> }
> 
> prepare() {
>  cd "$srcdir/${pkgname%-git}"
>  # these two are better obtained via the 'man-pages' package, exclude
>  # them
>  sed -i -e '/^SYSTEMS += \(Linux\|POSIX\)/d' Makefile
> }
> 
> build() {
>  cd "$srcdir/${pkgname%-git}"
>  bmake PREFIX=/usr TAR=bsdtar
> }
> 
> package() {
>  cd "$srcdir/${pkgname%-git}"
>  # shellcheck disable=SC2154
>  bmake PREFIX="$pkgdir/usr" TAR=bsdtar install

I should probably support DESTDIR in the Makefile, but this works.

Looks good!