From: ericonr <ericonr@users.noreply.github.com>
To: ml@inbox.vuxu.org
Subject: Re: [PR PATCH] [Updated] [WIP] Manual: add 80 column line break suggestion.
Date: Wed, 07 Apr 2021 21:21:19 +0200 [thread overview]
Message-ID: <20210407192119.EejWD5UB7f-dTd-mQtTUPr2dYqLzBQoPEsAghqHkzBM@z> (raw)
In-Reply-To: <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-29897@inbox.vuxu.org>
[-- Attachment #1: Type: text/plain, Size: 1709 bytes --]
There is an updated pull request by ericonr against master on the void-packages repository
https://github.com/ericonr/void-packages lines
https://github.com/void-linux/void-packages/pull/29897
[WIP] Manual: add 80 column line break suggestion.
Also rework most of the language in the Introduction.
<!-- Mark items with [x] where applicable -->
#### General
- [ ] This is a new package and it conforms to the [quality requirements](https://github.com/void-linux/void-packages/blob/master/Manual.md#quality-requirements)
#### Have the results of the proposed changes been tested?
- [ ] I use the packages affected by the proposed changes on a regular basis and confirm this PR works for me
- [ ] I generally don't use the affected packages but briefly tested this PR
<!--
If GitHub CI cannot be used to validate the build result (for example, if the
build is likely to take several hours), make sure to
[skip CI](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTING.md#continuous-integration).
When skipping CI, uncomment and fill out the following section.
Note: for builds that are likely to complete in less than 2 hours, it is not
acceptable to skip CI.
-->
<!--
#### Does it build and run successfully?
(Please choose at least one native build and, if supported, at least one cross build. More are better.)
- [ ] I built this PR locally for my native architecture, (ARCH-LIBC)
- [ ] I built this PR locally for these architectures (if supported. mark crossbuilds):
- [ ] aarch64-musl
- [ ] armv7l
- [ ] armv6l-musl
-->
[ci skip]
Picking up from #29765
A patch file from https://github.com/void-linux/void-packages/pull/29897.patch is attached
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-lines-29897.patch --]
[-- Type: text/x-diff, Size: 3617 bytes --]
From 02af52ee30bc2fe5c71a8ec3e6a5ef86079d5a80 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Nogueira?= <erico.erc@gmail.com>
Date: Wed, 31 Mar 2021 00:19:13 -0300
Subject: [PATCH] Manual: add 80 column line break suggestion.
Also:
- rework most of the language in the Introduction
- move note about special characters in pkgname or version
- note restrictions to version field are caused partly by xbps-checkvers
---
Manual.md | 33 +++++++++++++++++++--------------
1 file changed, 19 insertions(+), 14 deletions(-)
diff --git a/Manual.md b/Manual.md
index 4439865e1d73..2105d7a2eea3 100644
--- a/Manual.md
+++ b/Manual.md
@@ -76,17 +76,19 @@ packages for XBPS, the `Void Linux` native packaging system.
<a id="Introduction"></a>
## Introduction
-The `void-packages` repository contains all `source` packages that are the
-recipes to download, compile and build binary packages for `Void`.
-Those `source` package files are called `templates`.
+The `void-packages` repository contains all the
+recipes to download, compile and build binary packages for Void Linux.
+These `source` package files are called `templates`.
-The `template files` are `GNU bash` shell scripts that must define some required/optional
-`variables` and `functions` that are processed by `xbps-src` (the package builder)
-to generate the resulting binary packages.
+The `template` files are shell scripts that define `variables` and `functions`
+to be processed by `xbps-src`, the package builder, to generate binary packages.
+The shell used by `xbps-src` is GNU bash; `xbps-src` doesn't aim to be
+compatible with POSIX `sh`.
-By convention, all templates start with a comment briefly explaining what they
-are. In addition, pkgname and version can't have any characters in them that
-would require them to be quoted, so they are not quoted.
+By convention, all templates start with a comment saying that it is a
+`template file` for a certain package. Most of the lines should be kept under 80
+columns; variables that list many values can be split into new lines, with the
+continuation in the next line indented by one space.
A simple `template` example is as follows:
@@ -447,10 +449,9 @@ Multiple licenses should be separated by commas, Example: `GPL-3.0-or-later, cus
Note: `MIT`, `BSD`, `ISC` and custom licenses
require the license file to be supplied with the binary package.
-- `maintainer` A string in the form of `name <user@domain>`. The
- email for this field must be a valid email that you can be reached
- at. Packages using `users.noreply.github.com` emails will not be
- accepted.
+- `maintainer` A string in the form of `name <user@domain>`. The email for this field
+must be a valid email that you can be reached at. Packages using
+`users.noreply.github.com` emails will not be accepted.
- `pkgname` A string with the package name, matching `srcpkgs/<pkgname>`.
@@ -461,7 +462,11 @@ the generated `binary packages` have been modified.
- `short_desc` A string with a brief description for this package. Max 72 chars.
- `version` A string with the package version. Must not contain dashes or underscore
-and at least one digit is required. Shell's variable substition usage is not allowed.
+and at least one digit is required. Using bash's pattern substitution, prefix and suffix
+matching isn't supported, since this field needs to be parsed by `xbps-checkvers(1)`.
+
+Neither `pkgname` or `version` should contain special characters which make it necessary
+to quote them, so they shouldn't be quoted in the template.
<a id="optional_vars"></a>
#### Optional variables
next prev parent reply other threads:[~2021-04-07 19:21 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-31 3:21 [PR PATCH] " ericonr
2021-03-31 11:33 ` [PR REVIEW] " sgn
2021-03-31 16:56 ` Chocimier
2021-03-31 16:56 ` Chocimier
2021-03-31 16:56 ` Chocimier
2021-04-07 19:21 ` ericonr [this message]
2021-04-07 19:22 ` [PR REVIEW] " ericonr
2021-04-07 19:22 ` ericonr
2021-04-07 19:22 ` [PR PATCH] [Updated] " ericonr
2021-04-07 19:44 ` [PR REVIEW] " Chocimier
2021-04-07 19:44 ` Chocimier
2021-04-07 19:44 ` Chocimier
2021-04-07 19:53 ` ericonr
2021-04-07 19:54 ` ericonr
2021-04-07 20:23 ` [PR PATCH] [Updated] " ericonr
2021-04-07 20:34 ` ericonr
2021-04-07 20:37 ` ericonr
2021-04-07 20:37 ` [PR PATCH] [Merged]: " ericonr
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210407192119.EejWD5UB7f-dTd-mQtTUPr2dYqLzBQoPEsAghqHkzBM@z \
--to=ericonr@users.noreply.github.com \
--cc=ml@inbox.vuxu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).