Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] [WIP] Manual: add 80 column line break suggestion.
@ 2021-03-31  3:21 ericonr
  2021-03-31 11:33 ` [PR REVIEW] " sgn
                   ` (16 more replies)
  0 siblings, 17 replies; 18+ messages in thread
From: ericonr @ 2021-03-31  3:21 UTC (permalink / raw)
  To: ml

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

There is a new 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: 1909 bytes --]

From aa7576feb373ec0e277a863eca589626d31ed8cb 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.
---
 Manual.md | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/Manual.md b/Manual.md
index 4439865e1d73..ab275744e6ce 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
+The `template' files are `GNU bash` scripts that define some optional or required
 `variables` and `functions` that are processed by `xbps-src` (the package builder)
 to generate the resulting binary packages.
 
-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. In addition, `pkgname` and `version` can't
+contain any characters in that would require them to be quoted, so they are not quoted.
+Most of the lines should be kept under 80 columns; variables that list many values
+can be split into new lines.
 
 A simple `template` example is as follows:
 

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

end of thread, other threads:[~2021-04-07 20:37 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-31  3:21 [PR PATCH] [WIP] Manual: add 80 column line break suggestion 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 ` [PR PATCH] [Updated] " ericonr
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

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).