Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (1.0)
Subject: Re: Line length for APKBUILD files
From: Duncan Bellamy <a.16bit.sysop@me.com>
In-Reply-To: <47b50ae0b2e30e316927c7b3b0e29ac5e900e867.camel@cogitri.dev>
Cc: Alpine develmopment <~alpine/devel@lists.alpinelinux.org>
Date: Mon, 1 Jun 2020 13:12:36 +0100
Message-Id: <487CCA80-4621-41A4-B9C2-08C05A139B3B@me.com>
References: <47b50ae0b2e30e316927c7b3b0e29ac5e900e867.camel@cogitri.dev>
To: Rasmus Thomsen <oss@cogitri.dev>

Hi

> On 1 Jun 2020, at 11:33, Rasmus Thomsen <oss@cogitri.dev> wrote:
>=20
> =EF=BB=BFHello,
>=20
>>>> On Mon, 2020-06-01 at 11:23 +0100, Duncan Bellamy wrote:
>> Hi,
>> I read Linus Torvalds is going to stop enforcing line lengths in
>> kernel patches to increase readability.
>=20
> FWIW, I don't think that kernel QA will stop enforcing line lengths,
> just that the maximum character count per line will be increased. Many
> have suggested ~120 lines per line to be a good compromise between
> readability and being too restrictive.
>=20
>> Is it something Alpine has considered doing?
>> I think lines like the blocks with:
>> install -dm 750 -o PKGUSER -g PKGGRP \
>>      var/lib/ $pkgname
>> Would be easier to read if they were on one line (per install)
>=20
> Hm, that depends on the situation. In some cases linebreaks can make
> reading things easier, even if linebreaks are enabled in the editor.
> For example in the rust APKBUILD we have the following construct:
>=20
> ./configure \
>  --build=3D"$_build" \
>  --host=3D"$_target" \
>  --target=3D"$_target" \
>  --prefix=3D"/usr" \
>  --release-channel=3D"stable" \
>  --enable-local-rust \
>  --local-rust-root=3D"/usr" \
>  --llvm-root=3D"/usr/lib/llvm$_llvmver" \
>  --disable-docs \
>  --enable-extended \
>  --tools=3D"analysis,cargo,src" \
>  --enable-llvm-link-shared \
>  --enable-option-checking \
>  --enable-locked-deps \
>  --enable-vendor \
>  --python=3D"$_python" \
>  --set=3D"rust.musl-root=3D/usr" \
>  --set=3D"target.$_target.llvm-
> config=3D/usr/lib/llvm$_llvmver/bin/llvm-config" \
>  --set=3D"target.$_build.musl-root=3D/usr" \
>  --set=3D"target.$_build.crt-static=3Dfalse"
>=20
> The indention makes it immediately obvious where each configuration
> option begins and ends. Without it it's kind of a pain to read:
>=20
> ./configure --build=3D"$_build" --host=3D"$_target" --target=3D"$_target" -=
-
> prefix=3D"/usr" --release-channel=3D"stable" --enable-local-rust --local-
> rust-root=3D"/usr" --llvm-root=3D"/usr/lib/llvm$_llvmver" --disable-docs -=
-
> enable-extended --tools=3D"analysis,cargo,src" --enable-llvm-link-shared
> --enable-option-checking --enable-locked-deps --enable-vendor --
> python=3D"$_python" --set=3D"rust.musl-root=3D/usr" --
> set=3D"target.$_target.llvm-config=3D/usr/lib/llvm$_llvmver/bin/llvm-
> config" --set=3D"target.$_build.musl-root=3D/usr" --
> set=3D"target.$_build.crt-static=3Dfalse"

Yes the configure is definitely more readable on separate lines

>=20
> Even if your mail client has linebreaks enabled, this is nowhere as
> nice to read as the previous version with linebreaks. As such I think
> that linebreaks still make sense for command invocations, since they
> can carry semantic meaning.
>=20
> However, for things like makedepends, I think it'd be fine to stop
> enforcing the character limit. The indention in that doesn't really
> carry semantic meaning, nor does it make reading the list much easier
> compared to your text editor doing automatic linebreaks. I'm not sure
> if lifting that restriction makes sense though - maybe that
> inconsistency would only confuse contributors.

Yes it could be more confusing if some files are formatted one way and other=
s another.

>=20
> Regards,
>=20
> Rasmus
>=20
>> Duncan

Regards,
Duncan=