Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] Updates to documentation
@ 2020-07-08 19:45 ericonr
  2020-07-09 23:24 ` [PR REVIEW] " ahesford
                   ` (13 more replies)
  0 siblings, 14 replies; 15+ messages in thread
From: ericonr @ 2020-07-08 19:45 UTC (permalink / raw)
  To: ml

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

There is a new pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages contributing-new
https://github.com/void-linux/void-packages/pull/23475

Updates to documentation
- more commit examples and better explanation to PR process
- use local links instead of github ones for files inside the repo

Closed #21609 in favor of this one, to speed up acceptance.

A patch file from https://github.com/void-linux/void-packages/pull/23475.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contributing-new-23475.patch --]
[-- Type: text/x-diff, Size: 6908 bytes --]

From 1f26bfacceb3d50e8be00f982910c8e33f5ed654 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Mon, 4 May 2020 20:21:45 -0300
Subject: [PATCH 1/3] CONTRIBUTING.md: add commit examples and expl. to PR
 process

- Add commit examples for package removal and shlibs modifications

- Explain the PR process, specially when related to soname bumps

- Explain [ci skip]
---
 CONTRIBUTING.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0490b5f11c2..20024274a94 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -43,7 +43,14 @@ Once you have built your template file or files, the commit message should have
 
 * for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
+* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
 If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
+Pull requests with changes to packages that take too long to build, such as Firefox and the Linux kernel, should include `[ci skip]` in the last line of the commits, to avoid unnecessarily
+spending the CI builders' time, since the package is not going to finish building under the 50 minute limit.
+In such cases, the package should be built and cross-built locally for a combination of architectures and libc.
 
 For further information, please consult the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md).
 
@@ -69,8 +76,8 @@ Once you have successfully built the package, you can start a pull request.
 
 Most pull requests should only contain a single package and dependencies which are not part of void-packages yet.
 
-If you make updates to packages containing a soname bump you also need to revbump all packages that are dependant. Those
-packages should also be part of the same pull request.
+If you make updates to packages containing a soname bump, you also need to update `common/shlibs` and revbump all packages that are dependant.
+There should be a commit for each package revbump, and those commits should be part of the same pull request.
 
 When you make changes to your pull request, please *do not close and reopen your pull request*. Instead, just forcibly git push, overwriting any old commits. Closing and opening your pull requests repeatedly spams the Void maintainers.
 

From faa123e10a1ea669a8b96f9037fcd789a6d0af62 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Mon, 4 May 2020 20:29:38 -0300
Subject: [PATCH 2/3] CONTRIBUTING.md: use local links instead of GH ones

---
 CONTRIBUTING.md | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 20024274a94..c2a4c14a67d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,9 +8,8 @@ This document describes how you, as a contributor, can help with adding packages
 
 If you really want to get a package into Void Linux, we recommend you package it yourself.
 
-We provide a [comprehensive Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
-on how to create new packages. There's also a
-[manual for xbps-src](https://github.com/void-linux/void-packages/blob/master/README.md), which is used
+We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
+There's also a [manual for xbps-src](./README.md), which is used
 to build package files from templates.
 
 For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
@@ -25,7 +24,7 @@ You can use the helper tool `xnew`, from the [xtools](https://github.com/chneuki
 
 Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `pkgname` is the same as the `pkgname` variable in the template.
 
-For deeper insights on the contents of template files, please read the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
+For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
 When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
 

From b6c9e92208495d38b3f8d23bcd896b74ef8a5549 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 8 Jul 2020 16:40:46 -0300
Subject: [PATCH 3/3] README, Manual: use local links for files in repo.

---
 Manual.md | 5 ++---
 README.md | 6 ++----
 2 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/Manual.md b/Manual.md
index 10082b68da5..71246910a12 100644
--- a/Manual.md
+++ b/Manual.md
@@ -1963,9 +1963,8 @@ Fork the voidlinux `void-packages` git repository on github and clone it:
 
     $ git clone git@github.com:<user>/void-packages.git
 
-See [CONTRIBUTING.md](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md)
-for information on how to format your commits and other tips for
-contributing.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to format your
+commits and other tips for contributing.
 
 Once you've made changes to your `forked` repository you can submit
 a github pull request; see https://help.github.com/articles/fork-a-repo for more information.
diff --git a/README.md b/README.md
index 7cb3895e6f2..fe85e3f20eb 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,8 @@ The included `xbps-src` script will fetch and compile the sources, and install i
 files into a `fake destdir` to generate XBPS binary packages that can be installed
 or queried through the `xbps-install(1)` and `xbps-query(1)` utilities, respectively.
 
-See [Contributing](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md)
-for a general overview of how to contribute and the
-[Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
-for details of how to create source packages.
+See [Contributing](./CONTRIBUTING.md) for a general overview of how to contribute and the
+[Manual](./Manual.md) for details of how to create source packages.
 
 ### Table of Contents
 

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
@ 2020-07-09 23:24 ` ahesford
  2020-07-09 23:43 ` ericonr
                   ` (12 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ahesford @ 2020-07-09 23:24 UTC (permalink / raw)
  To: ml

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

New review comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r452542313

Comment:
Maybe something like:
> Pull requests are automatically submitted for Continuous Integration (CI) testing to ensure packages build on various architectures and C libraries. Packages that take longer than 50 minutes to build (for example, Firefox or the Linux kernel) will fail CI and should include `[ci skip]` in the commit message of the last commit in the PR to avoid wasting CI builder time. Use your best judgment on build times based on your local building experience. If you skip CI when submitting a PR, please locally build for a variety of architectures with glibc as well as musl and note your local results in PR comments.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
  2020-07-09 23:24 ` [PR REVIEW] " ahesford
@ 2020-07-09 23:43 ` ericonr
  2020-07-10  3:46 ` ahesford
                   ` (11 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ericonr @ 2020-07-09 23:43 UTC (permalink / raw)
  To: ml

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

New review comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r452548051

Comment:
That is a bit better. I prefer "libc" rather than "C library", though.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
  2020-07-09 23:24 ` [PR REVIEW] " ahesford
  2020-07-09 23:43 ` ericonr
@ 2020-07-10  3:46 ` ahesford
  2020-07-10  4:10 ` [PR PATCH] [Updated] " ericonr
                   ` (10 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ahesford @ 2020-07-10  3:46 UTC (permalink / raw)
  To: ml

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

New review comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r452607105

Comment:
I don't object to "libc" instead of "C libraries", except it's harder to pluralize. :)

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR PATCH] [Updated] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (2 preceding siblings ...)
  2020-07-10  3:46 ` ahesford
@ 2020-07-10  4:10 ` ericonr
  2020-07-10  4:10 ` [PR REVIEW] " ericonr
                   ` (9 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ericonr @ 2020-07-10  4:10 UTC (permalink / raw)
  To: ml

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

There is an updated pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages contributing-new
https://github.com/void-linux/void-packages/pull/23475

Updates to documentation
- more commit examples and better explanation to PR process
- use local links instead of github ones for files inside the repo

Closed #21609 in favor of this one, to speed up acceptance.

A patch file from https://github.com/void-linux/void-packages/pull/23475.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contributing-new-23475.patch --]
[-- Type: text/x-diff, Size: 7529 bytes --]

From 083cde9d74a98c9f1e2ccf3a888227ff033777c1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Mon, 4 May 2020 20:21:45 -0300
Subject: [PATCH 1/3] CONTRIBUTING.md: add commit examples and expl. to PR
 process

- Add commit examples for package removal and shlibs modifications

- Explain the PR process, specially when related to soname bumps

- Explain [ci skip]

- Add testing requirements
---
 CONTRIBUTING.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0490b5f11c2..adbd2afdd47 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -43,8 +43,19 @@ Once you have built your template file or files, the commit message should have
 
 * for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
+* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
 If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
 
+Pull requests are automatically submitted for Continuous Integration (CI) testing to ensure packages build on various combinations of libc and architectures.
+Packages that take longer than 50 minutes to build (for example, Firefox or the Linux kernel) will fail CI and should include `[ci skip]` in the last line of the last commit message in the PR to avoid wasting CI builder time.
+Use your best judgment on build times based on your local building experience. If you skip CI when submitting a PR, please build and cross-build for a variety of architectures locally, with both glibc and musl, and note your local results in PR comments.
+Make sure to cover 64-bit and 32-bit architectures
+
+It should be noted that packages should also be runtime tested. Building them with the `-Q` flag or with the `XBPS_CHECK_PKGS=yes` variable in `etc/conf` is encouraged.
+
 For further information, please consult the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md).
 
 `xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
@@ -69,8 +80,8 @@ Once you have successfully built the package, you can start a pull request.
 
 Most pull requests should only contain a single package and dependencies which are not part of void-packages yet.
 
-If you make updates to packages containing a soname bump you also need to revbump all packages that are dependant. Those
-packages should also be part of the same pull request.
+If you make updates to packages containing a soname bump, you also need to update `common/shlibs` and revbump all packages that are dependant.
+There should be a commit for each package revbump, and those commits should be part of the same pull request.
 
 When you make changes to your pull request, please *do not close and reopen your pull request*. Instead, just forcibly git push, overwriting any old commits. Closing and opening your pull requests repeatedly spams the Void maintainers.
 

From 4841e90f8f7df38432339d78be1ed2487e9e1435 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Mon, 4 May 2020 20:29:38 -0300
Subject: [PATCH 2/3] CONTRIBUTING.md: use local links instead of GH ones

---
 CONTRIBUTING.md | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index adbd2afdd47..c86ba783023 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,9 +8,8 @@ This document describes how you, as a contributor, can help with adding packages
 
 If you really want to get a package into Void Linux, we recommend you package it yourself.
 
-We provide a [comprehensive Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
-on how to create new packages. There's also a
-[manual for xbps-src](https://github.com/void-linux/void-packages/blob/master/README.md), which is used
+We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
+There's also a [manual for xbps-src](./README.md), which is used
 to build package files from templates.
 
 For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
@@ -25,7 +24,7 @@ You can use the helper tool `xnew`, from the [xtools](https://github.com/chneuki
 
 Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `pkgname` is the same as the `pkgname` variable in the template.
 
-For deeper insights on the contents of template files, please read the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
+For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
 When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
 

From 0d019308b727aa3f6dce33644d712135b2c777b2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 8 Jul 2020 16:40:46 -0300
Subject: [PATCH 3/3] README, Manual: use local links for files in repo.

---
 Manual.md | 5 ++---
 README.md | 6 ++----
 2 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/Manual.md b/Manual.md
index 10082b68da5..71246910a12 100644
--- a/Manual.md
+++ b/Manual.md
@@ -1963,9 +1963,8 @@ Fork the voidlinux `void-packages` git repository on github and clone it:
 
     $ git clone git@github.com:<user>/void-packages.git
 
-See [CONTRIBUTING.md](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md)
-for information on how to format your commits and other tips for
-contributing.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to format your
+commits and other tips for contributing.
 
 Once you've made changes to your `forked` repository you can submit
 a github pull request; see https://help.github.com/articles/fork-a-repo for more information.
diff --git a/README.md b/README.md
index 7cb3895e6f2..fe85e3f20eb 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,8 @@ The included `xbps-src` script will fetch and compile the sources, and install i
 files into a `fake destdir` to generate XBPS binary packages that can be installed
 or queried through the `xbps-install(1)` and `xbps-query(1)` utilities, respectively.
 
-See [Contributing](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md)
-for a general overview of how to contribute and the
-[Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
-for details of how to create source packages.
+See [Contributing](./CONTRIBUTING.md) for a general overview of how to contribute and the
+[Manual](./Manual.md) for details of how to create source packages.
 
 ### Table of Contents
 

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (3 preceding siblings ...)
  2020-07-10  4:10 ` [PR PATCH] [Updated] " ericonr
@ 2020-07-10  4:10 ` ericonr
  2020-07-11 19:44 ` Chocimier
                   ` (8 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ericonr @ 2020-07-10  4:10 UTC (permalink / raw)
  To: ml

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

New review comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r452611955

Comment:
Added some more changes.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (4 preceding siblings ...)
  2020-07-10  4:10 ` [PR REVIEW] " ericonr
@ 2020-07-11 19:44 ` Chocimier
  2020-07-11 19:44 ` Chocimier
                   ` (7 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: Chocimier @ 2020-07-11 19:44 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r453227512

Comment:
Missing period.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (6 preceding siblings ...)
  2020-07-11 19:44 ` Chocimier
@ 2020-07-11 19:44 ` Chocimier
  2020-07-11 20:08 ` ahesford
                   ` (5 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: Chocimier @ 2020-07-11 19:44 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r453227786

Comment:
Quick manual test of built software are encouraged too. For new packages it is requirement.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (5 preceding siblings ...)
  2020-07-11 19:44 ` Chocimier
@ 2020-07-11 19:44 ` Chocimier
  2020-07-11 19:44 ` Chocimier
                   ` (6 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: Chocimier @ 2020-07-11 19:44 UTC (permalink / raw)
  To: ml

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

New review comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r453227509

Comment:
libc and architectur**e**?

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (7 preceding siblings ...)
  2020-07-11 19:44 ` Chocimier
@ 2020-07-11 20:08 ` ahesford
  2020-07-11 22:34 ` ericonr
                   ` (4 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ahesford @ 2020-07-11 20:08 UTC (permalink / raw)
  To: ml

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

New review comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r453230018

Comment:
That's better.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (8 preceding siblings ...)
  2020-07-11 20:08 ` ahesford
@ 2020-07-11 22:34 ` ericonr
  2020-07-12  3:37 ` ahesford
                   ` (3 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ericonr @ 2020-07-11 22:34 UTC (permalink / raw)
  To: ml

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

New review comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r453241824

Comment:
```
It should be noted that runtime testing packages, as well as building them with the `-Q` flag or with the `XBPS_CHECK_PKGS=yes` variable in `etc/conf` is encouraged.
New packages are required to have been runtime tested.
```

What do you think?

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR REVIEW] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (9 preceding siblings ...)
  2020-07-11 22:34 ` ericonr
@ 2020-07-12  3:37 ` ahesford
  2020-07-12 13:58 ` [PR PATCH] [Updated] " ericonr
                   ` (2 subsequent siblings)
  13 siblings, 0 replies; 15+ messages in thread
From: ahesford @ 2020-07-12  3:37 UTC (permalink / raw)
  To: ml

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

New review comment by ahesford on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#discussion_r453262265

Comment:
Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged. New packages will not be accepted unless they have been runtime tested.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR PATCH] [Updated] Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (10 preceding siblings ...)
  2020-07-12  3:37 ` ahesford
@ 2020-07-12 13:58 ` ericonr
  2020-07-12 13:58 ` ericonr
  2020-07-13 16:21 ` [PR PATCH] [Merged]: " Chocimier
  13 siblings, 0 replies; 15+ messages in thread
From: ericonr @ 2020-07-12 13:58 UTC (permalink / raw)
  To: ml

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

There is an updated pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages contributing-new
https://github.com/void-linux/void-packages/pull/23475

Updates to documentation
- more commit examples and better explanation to PR process
- use local links instead of github ones for files inside the repo

Closed #21609 in favor of this one, to speed up acceptance.

A patch file from https://github.com/void-linux/void-packages/pull/23475.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-contributing-new-23475.patch --]
[-- Type: text/x-diff, Size: 7586 bytes --]

From 24140e0260c38e57e5d1c9ba4f2fa88451d2dcf7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Mon, 4 May 2020 20:21:45 -0300
Subject: [PATCH 1/3] CONTRIBUTING.md: add commit examples and expl. to PR
 process

- Add commit examples for package removal and shlibs modifications

- Explain the PR process, specially when related to soname bumps

- Explain [ci skip]

- Add testing requirements
---
 CONTRIBUTING.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0490b5f11c2..0bbae36a014 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -43,8 +43,20 @@ Once you have built your template file or files, the commit message should have
 
 * for template modifications without a version change, use ```<pkgname>: <reason>``` ([example](https://github.com/void-linux/void-packages/commit/8b68d6bf1eb997cd5e7c095acd040e2c5379c91d)).
 
+* for package removals, use ```<pkgname>: remove package``` ([example](https://github.com/void-linux/void-packages/commit/83784632d94deee5d038c8e1c4c1dffa922fca21)).
+
+* for `common/shlibs` modifications, use `common/shlibs: <pkgname>` ([example](https://github.com/void-linux/void-packages/commit/613651c91811cb4fd2e1a6be701c87072d759a9f)).
+
 If you want to describe your changes in more detail, add an empty line followed by those details ([example](https://github.com/void-linux/void-packages/commit/f1c45a502086ba1952f23ace9084a870ce437bc6)).
 
+Pull requests are automatically submitted for Continuous Integration (CI) testing to ensure packages build on various combinations of libc and architecture.
+Packages that take longer than 50 minutes to build (for example, Firefox or the Linux kernel) will fail CI and should include `[ci skip]` in the last line of the last commit message in the PR to avoid wasting CI builder time.
+Use your best judgment on build times based on your local building experience. If you skip CI when submitting a PR, please build and cross-build for a variety of architectures locally, with both glibc and musl, and note your local results in PR comments.
+Make sure to cover 64-bit and 32-bit architectures.
+
+Runtime testing of packages and building with the `-Q` flag or with `XBPS_CHECK_PKGS=yes` set in the environment or `etc/conf` are strongly encouraged.
+New packages will not be accepted unless they have been runtime tested.
+
 For further information, please consult the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md).
 
 `xbump`, available in the [xtools](https://github.com/chneukirchen/xtools) package, can be used to commit a new or updated package:
@@ -69,8 +81,8 @@ Once you have successfully built the package, you can start a pull request.
 
 Most pull requests should only contain a single package and dependencies which are not part of void-packages yet.
 
-If you make updates to packages containing a soname bump you also need to revbump all packages that are dependant. Those
-packages should also be part of the same pull request.
+If you make updates to packages containing a soname bump, you also need to update `common/shlibs` and revbump all packages that are dependant.
+There should be a commit for each package revbump, and those commits should be part of the same pull request.
 
 When you make changes to your pull request, please *do not close and reopen your pull request*. Instead, just forcibly git push, overwriting any old commits. Closing and opening your pull requests repeatedly spams the Void maintainers.
 

From 24a99d5395b8c48d2e92c976f785ac81ad3798f5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Mon, 4 May 2020 20:29:38 -0300
Subject: [PATCH 2/3] CONTRIBUTING.md: use local links instead of GH ones

---
 CONTRIBUTING.md | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0bbae36a014..a38751f55ec 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,9 +8,8 @@ This document describes how you, as a contributor, can help with adding packages
 
 If you really want to get a package into Void Linux, we recommend you package it yourself.
 
-We provide a [comprehensive Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
-on how to create new packages. There's also a
-[manual for xbps-src](https://github.com/void-linux/void-packages/blob/master/README.md), which is used
+We provide a [comprehensive Manual](./Manual.md) on how to create new packages.
+There's also a [manual for xbps-src](./README.md), which is used
 to build package files from templates.
 
 For this guide, we assume you have basic knowledge about [git](http://git-scm.org), as well as a [GitHub Account](http://github.com).
@@ -25,7 +24,7 @@ You can use the helper tool `xnew`, from the [xtools](https://github.com/chneuki
 
 Templates must have the name `void-packages/srcpkgs/<pkgname>/template`, where `pkgname` is the same as the `pkgname` variable in the template.
 
-For deeper insights on the contents of template files, please read the [manual](https://github.com/void-linux/void-packages/blob/master/Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
+For deeper insights on the contents of template files, please read the [manual](./Manual.md), and be sure to browse the existing template files in the `srcpkgs` directory of this repository for concrete examples.
 
 When you've finished working on the template file, please check it with `xlint` helper from the [xtools](https://github.com/chneukirchen/xtools) package:
 

From 572341659e4c4ed758b246b53845a23504bff11b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 8 Jul 2020 16:40:46 -0300
Subject: [PATCH 3/3] README, Manual: use local links for files in repo.

---
 Manual.md | 5 ++---
 README.md | 6 ++----
 2 files changed, 4 insertions(+), 7 deletions(-)

diff --git a/Manual.md b/Manual.md
index 10082b68da5..71246910a12 100644
--- a/Manual.md
+++ b/Manual.md
@@ -1963,9 +1963,8 @@ Fork the voidlinux `void-packages` git repository on github and clone it:
 
     $ git clone git@github.com:<user>/void-packages.git
 
-See [CONTRIBUTING.md](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md)
-for information on how to format your commits and other tips for
-contributing.
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for information on how to format your
+commits and other tips for contributing.
 
 Once you've made changes to your `forked` repository you can submit
 a github pull request; see https://help.github.com/articles/fork-a-repo for more information.
diff --git a/README.md b/README.md
index 7cb3895e6f2..fe85e3f20eb 100644
--- a/README.md
+++ b/README.md
@@ -7,10 +7,8 @@ The included `xbps-src` script will fetch and compile the sources, and install i
 files into a `fake destdir` to generate XBPS binary packages that can be installed
 or queried through the `xbps-install(1)` and `xbps-query(1)` utilities, respectively.
 
-See [Contributing](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md)
-for a general overview of how to contribute and the
-[Manual](https://github.com/void-linux/void-packages/blob/master/Manual.md)
-for details of how to create source packages.
+See [Contributing](./CONTRIBUTING.md) for a general overview of how to contribute and the
+[Manual](./Manual.md) for details of how to create source packages.
 
 ### Table of Contents
 

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (11 preceding siblings ...)
  2020-07-12 13:58 ` [PR PATCH] [Updated] " ericonr
@ 2020-07-12 13:58 ` ericonr
  2020-07-13 16:21 ` [PR PATCH] [Merged]: " Chocimier
  13 siblings, 0 replies; 15+ messages in thread
From: ericonr @ 2020-07-12 13:58 UTC (permalink / raw)
  To: ml

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

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/23475#issuecomment-657225454

Comment:
Thanks for the review! Updated.

^ permalink raw reply	[flat|nested] 15+ messages in thread

* Re: [PR PATCH] [Merged]: Updates to documentation
  2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
                   ` (12 preceding siblings ...)
  2020-07-12 13:58 ` ericonr
@ 2020-07-13 16:21 ` Chocimier
  13 siblings, 0 replies; 15+ messages in thread
From: Chocimier @ 2020-07-13 16:21 UTC (permalink / raw)
  To: ml

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

There's a merged pull request on the void-packages repository

Updates to documentation
https://github.com/void-linux/void-packages/pull/23475

Description:
- more commit examples and better explanation to PR process
- use local links instead of github ones for files inside the repo

Closed #21609 in favor of this one, to speed up acceptance.

^ permalink raw reply	[flat|nested] 15+ messages in thread

end of thread, other threads:[~2020-07-13 16:21 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-08 19:45 [PR PATCH] Updates to documentation ericonr
2020-07-09 23:24 ` [PR REVIEW] " ahesford
2020-07-09 23:43 ` ericonr
2020-07-10  3:46 ` ahesford
2020-07-10  4:10 ` [PR PATCH] [Updated] " ericonr
2020-07-10  4:10 ` [PR REVIEW] " ericonr
2020-07-11 19:44 ` Chocimier
2020-07-11 19:44 ` Chocimier
2020-07-11 19:44 ` Chocimier
2020-07-11 20:08 ` ahesford
2020-07-11 22:34 ` ericonr
2020-07-12  3:37 ` ahesford
2020-07-12 13:58 ` [PR PATCH] [Updated] " ericonr
2020-07-12 13:58 ` ericonr
2020-07-13 16:21 ` [PR PATCH] [Merged]: " Chocimier

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).