[ISSUE] [RFC] Consencus on $distfiles

[ISSUE] [RFC] Consencus on $distfiles

[fosslinux]

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

New issue by fosslinux on void-packages repository

https://github.com/void-linux/void-packages/issues/27735

Description:
There are varying opinions among maintainers in regards to how best to structure `$distfiles`.

For some time there has been an xlint rule that there must not be any variables in `$homepage`, which is good to me. However, when the distfile is contained underneath the homepage, such as for most github projects, there are two conflicting opinions among Void maintainers, namely whether or not to contract/expand `$homepage` in the template. For example, `distfiles=https://github.com/emersion/xdg-desktop-portal-wlr/archive/v${version}.tar.gz` v.s. `distfiles=${homepage}/archive/v$version.tar.gz`.

For a new contributor, this is often very confusing, when one maintainer reviews and asks to shorten/expand and then another maintainer responds with asking not to do this. I have seen this happen many times before, one example being https://github.com/void-linux/void-packages/pull/23296#discussion_r517525903.

To rectify this issue:

1. Add a note to Manual.md on a consensus on what should be done.
2. Create an xlint rule.

(feel free to edit below)

#### Pros for contracting (i.e. using `${homepage}`):

1. Shorter variable declarations
2. Less places to change if upstream moves github, for example.

#### Pros for expanding (i.e. not using `${homepage}`):

1. Easier to copy-paste urls
2. "obfuscates" url

@void-linux/pkg-committers (if i can even do that)

Re: [RFC] Consencus on $distfiles

[Piraty]

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

New comment by Piraty on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756010401

Comment:
@void-linux/pkg-committers 

Re: [RFC] consensus on $distfiles

[ahesford]

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

New comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756078086

Comment:
+1 for encouraging use of variables whenever possible in distfiles.

The primary justification for keeping the homepage and change log free from variables is that these things should be easy to copy and paste (or, in some terminal emulators, directly clickable).

No such justification applies to distfiles, which are already encouraged to use `$version`. It would be inconsistent and, in my view, senseless to demand that some variables be used while others be avoided.

When I make changes, I use the shortest possible form for distfiles

Re: [ISSUE] [CLOSED] [RFC] consensus on $distfiles

[ahesford]

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

Closed issue by fosslinux on void-packages repository

https://github.com/void-linux/void-packages/issues/27735

Description:
There are varying opinions among maintainers in regards to how best to structure `$distfiles`.

For some time there has been an xlint rule that there must not be any variables in `$homepage`, which is good to me. However, when the distfile is contained underneath the homepage, such as for most github projects, there are two conflicting opinions among Void maintainers, namely whether or not to contract/expand `$homepage` in the template. For example, `distfiles=https://github.com/emersion/xdg-desktop-portal-wlr/archive/v${version}.tar.gz` v.s. `distfiles=${homepage}/archive/v$version.tar.gz`.

For a new contributor, this is often very confusing, when one maintainer reviews and asks to shorten/expand and then another maintainer responds with asking not to do this. I have seen this happen many times before, one example being https://github.com/void-linux/void-packages/pull/23296#discussion_r517525903.

To rectify this issue:

1. Add a note to Manual.md on a consensus on what should be done.
2. Create an xlint rule.

(feel free to edit below)

#### Pros for contracting (i.e. using `${homepage}`):

1. Shorter variable declarations
2. Less places to change if upstream moves github, for example.

#### Pros for expanding (i.e. not using `${homepage}`):

1. Easier to copy-paste urls
2. "obfuscates" url

@void-linux/pkg-committers (if i can even do that)

Re: [RFC] consensus on $distfiles

[ahesford]

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

New comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756078086

Comment:
+1 for encouraging use of variables whenever possible in distfiles.

The primary justification for keeping the homepage and change log free from variables is that these things should be easy to copy and paste (or, in some terminal emulators, directly clickable).

No such justification applies to distfiles, which are already encouraged to use `$version`. It would be inconsistent and, in my view, senseless to demand that some variables be used while others be avoided.

When I make changes, I use the shortest possible form for distfiles. However, I tend not to demand a specific style when reviewing others' work. (Although I may suggest such a change when it would be one of many other demands.)

EDIT: sorry for the accidental close.

Re: [RFC] consensus on $distfiles

[Duncaen]

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

New comment by Duncaen on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756085928

Comment:
> Less places to change if upstream moves github, for example.

More places to change if upstream gets a real homepage.

IMHO the less variables used in templates the better, it makes things easier to parse and tools like xlint can't deal with variables.
There is no real upside, if the homepage and distfiles URL changes then changing two lines is really not a problem.

Re: [RFC] consensus on $distfiles

[Duncaen]

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

New comment by Duncaen on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756085928

Comment:
> Less places to change if upstream moves github, for example.

More places to change if upstream gets a real homepage.

IMHO the less variables used in templates the better, it makes things easier to parse and tools like xlint can't deal with variables.
There is no real upside, if the homepage and distfiles URL is changed then you can simple change both lines.

Re: [RFC] consensus on $distfiles

[Anachron]

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

New comment by Anachron on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756108259

Comment:
I'm not a committer but I would agree to always expand URL variables when possible. User scripts (like xtools) will have it a lot easier handling package templates.

Re: [RFC] consensus on $distfiles

[sgn]

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

New comment by sgn on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756121325

Comment:
FWIW, I don't like to use `${homepage}` in `${distfiles}`

Re: [RFC] consensus on $distfiles

[Duncaen]

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

New comment by Duncaen on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756085928

Comment:
> Less places to change if upstream moves github, for example.

More places to change if upstream gets a real homepage.

IMHO the less variables used in templates the better, it makes things easier to parse and tools like xlint can't deal with variables.
There is no real upside, if the homepage and distfiles URL is changed then you can simply change both lines.

Re: [RFC] consensus on $distfiles

[ericonr]

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756132363

Comment:
I like using `${homepage}`, but it's also because it's expected (by me, at least) that most projects won't move off of GitHub/Gitlab. Makes for a shorter link, which is less visual noise.

I would ask that `${pkgname}` be removed from distfiles, though, since we have many that are like `https://github.com/user/${pkgname}/archive`, which is the worst of both options. If the link gets too big by expanding pkgname, IMO it's better to at least use `homepage` directly.

Re: [RFC] consensus on $distfiles

[Vaelatern]

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

New comment by Vaelatern on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756180542

Comment:
I don't like to use `${homepage}` or `${pkgname}` because the full-tree update checking script doesn't replace them.

Re: [RFC] consensus on $distfiles

[Vaelatern]

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

New comment by Vaelatern on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756180542

Comment:
I don't like to use `${homepage}` or `${pkgname}` because the full-tree update checking script doesn't replace them.

Edit: That's in the homepage var itself, not distifles. For distfiles, I typically just replace the version these days.

e.g. it IS possible for python packages to have a single URL for all python packages with nothing hardcoded, but this makes it difficult to read.

Re: [RFC] consensus on $distfiles

[Piraty]

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

New comment by Piraty on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756347842

Comment:
ever `grep -r 'distfile=.*someurl.org' srcpkgs`'ed ? no `$homepage` in `$distfiles` please.

Re: [RFC] consensus on $distfiles

[Chocimier]

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

New comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756410024

Comment:
I prefer to avoid variables, for simplicity of processing as text.

"Less places to change if upstream moves github" is case only for changed account on same hosting. If hosting is changed, distfiles need to be changed anyway.

Re: [RFC] consensus on $distfiles

[ericonr]

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756548750

Comment:
For what it's worth, we also use a bunch of `GNOME_SITE`, `PYPI_SITE`, etc, across distfiles. In my opinion, those are kinda worse, since the link can't even be found in the template itself, and I have to open another file to find it. If we decide to make `${homepage}` "forbidden", we should make those variables forbidden as well. 

Re: [RFC] consensus on $distfiles

[ericonr]

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756548750

Comment:
For what it's worth, we also use a bunch of `GNOME_SITE`, `PYPI_SITE`, etc, across distfiles. In my opinion, those are kinda worse, since the link can't even be found in the template itself, and I have to open another file to find it. If we decide to make `${homepage}` "forbidden", we should remove those variables forbidden as well. 

Re: [RFC] consensus on $distfiles

[Vaelatern]

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

New comment by Vaelatern on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756553690

Comment:
Those variables have a well established purpose of making sure we hit the correct centralized distribution server, and are able to change mirrors in a reasonable way. Even if we have not used that capability, I find this valuable.

Re: [RFC] consensus on $distfiles

[ericonr]

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-756548750

Comment:
For what it's worth, we also use a bunch of `GNOME_SITE`, `PYPI_SITE`, etc, across distfiles. In my opinion, those are kinda worse, since the link can't even be found in the template itself, and I have to open another file to find it. If we decide to make `${homepage}` "forbidden", we should remove those variables as well. 

Re: [RFC] consensus on $distfiles

[subnut]

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

New comment by subnut on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-1079749124

Comment:
I propose to pin this issue to increase visibility

Re: [RFC] consensus on $distfiles

[ahesford]

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

New comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-1079778817

Comment:
There is no consensus; pinning the issue and attracting new attention to an unresolved debate that has no functional consequence doesn't offer any benefit.

Re: [RFC] consensus on $distfiles

[github-actions]

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

New comment by github-actions[bot] on void-packages repository

https://github.com/void-linux/void-packages/issues/27735#issuecomment-1166171824

Comment:
Issues become stale 90 days after last activity and are closed 14 days after that.  If this issue is still relevant bump it or assign it.

Re: [ISSUE] [CLOSED] [RFC] consensus on $distfiles

[github-actions]

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

Closed issue by fosslinux on void-packages repository

https://github.com/void-linux/void-packages/issues/27735

Description:
There are varying opinions among maintainers in regards to how best to structure `$distfiles`.

For some time there has been an xlint rule that there must not be any variables in `$homepage`, which is good to me. However, when the distfile is contained underneath the homepage, such as for most github projects, there are two conflicting opinions among Void maintainers, namely whether or not to contract/expand `$homepage` in the template. For example, `distfiles=https://github.com/emersion/xdg-desktop-portal-wlr/archive/v${version}.tar.gz` v.s. `distfiles=${homepage}/archive/v$version.tar.gz`.

For a new contributor, this is often very confusing, when one maintainer reviews and asks to shorten/expand and then another maintainer responds with asking not to do this. I have seen this happen many times before, one example being https://github.com/void-linux/void-packages/pull/23296#discussion_r517525903.

To rectify this issue:

1. Add a note to Manual.md on a consensus on what should be done.
2. Create an xlint rule.

(feel free to edit below)

#### Pros for contracting (i.e. using `${homepage}`):

1. Shorter variable declarations
2. Less places to change if upstream moves github, for example.

#### Pros for expanding (i.e. not using `${homepage}`):

1. Easier to copy-paste urls
2. "obfuscates" url

@void-linux/pkg-committers (if i can even do that)