Github messages for voidlinux
 help / color / mirror / Atom feed
* [PR PATCH] Manual.md: make section concerning quoting version and pkgname clearer
@ 2023-08-14 11:39 Bnyro
  2023-08-16 18:58 ` Chocimier
  2023-08-19 17:53 ` [PR PATCH] [Merged]: " Chocimier
  0 siblings, 2 replies; 3+ messages in thread
From: Bnyro @ 2023-08-14 11:39 UTC (permalink / raw)
  To: ml

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

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

https://github.com/Bnyro/void-packages dont-quote-pkgname-and-version
https://github.com/void-linux/void-packages/pull/45603

Manual.md: make section concerning quoting version and pkgname clearer
The current description might be a bit difficult to understand for new contributors due to some grammatical things that could result in it to be understood in the wrong way.

`[...] which make it necessary to quote them` somewhat could be interpreted that you actually should quote them.
The rest are just minor grammar changes.

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

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-dont-quote-pkgname-and-version-45603.patch --]
[-- Type: text/x-diff, Size: 1052 bytes --]

From 733879600207983af8a285874ca0670ed245d072 Mon Sep 17 00:00:00 2001
From: Bnyro <82752168+Bnyro@users.noreply.github.com>
Date: Mon, 14 Aug 2023 13:33:29 +0200
Subject: [PATCH] Manual.md: make section concerning quoting version and
 pkgname clearer

---
 Manual.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Manual.md b/Manual.md
index 5a183e6c3d183..b3deacc6d344e 100644
--- a/Manual.md
+++ b/Manual.md
@@ -441,8 +441,8 @@ the generated `binary packages` have been modified.
 - `version` A string with the package version. Must not contain dashes or underscore
 and at least one digit is required. Shell's variable substitution usage is not allowed.
 
-Neither `pkgname` or `version` should contain special characters which make it
-necessary to quote them, so they shouldn't be quoted in the template.
+Neither `pkgname` nor `version` should contain special characters that would make it
+necessary to quote them, hence they should not be quoted in the template.
 
 <a id="optional_vars"></a>
 #### Optional variables

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

* Re: Manual.md: make section concerning quoting version and pkgname clearer
  2023-08-14 11:39 [PR PATCH] Manual.md: make section concerning quoting version and pkgname clearer Bnyro
@ 2023-08-16 18:58 ` Chocimier
  2023-08-19 17:53 ` [PR PATCH] [Merged]: " Chocimier
  1 sibling, 0 replies; 3+ messages in thread
From: Chocimier @ 2023-08-16 18:58 UTC (permalink / raw)
  To: ml

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

New comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/45603#issuecomment-1681124820

Comment:
Yeah, it's worth to fix. Can be worded even even simpler, eg. "pkgname and version are forbidden to contain special characters. As such, they don't need to be quoted, and convention is to not quote."

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

* Re: [PR PATCH] [Merged]: Manual.md: make section concerning quoting version and pkgname clearer
  2023-08-14 11:39 [PR PATCH] Manual.md: make section concerning quoting version and pkgname clearer Bnyro
  2023-08-16 18:58 ` Chocimier
@ 2023-08-19 17:53 ` Chocimier
  1 sibling, 0 replies; 3+ messages in thread
From: Chocimier @ 2023-08-19 17:53 UTC (permalink / raw)
  To: ml

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

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

Manual.md: make section concerning quoting version and pkgname clearer
https://github.com/void-linux/void-packages/pull/45603

Description:
The current description might be a bit difficult to understand for new contributors due to some grammatical things that could result in it to be understood in the wrong way.

`[...] which make it necessary to quote them` somewhat could be interpreted that you actually should quote them.
The rest are just minor grammar changes.

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

end of thread, other threads:[~2023-08-19 17:53 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-08-14 11:39 [PR PATCH] Manual.md: make section concerning quoting version and pkgname clearer Bnyro
2023-08-16 18:58 ` Chocimier
2023-08-19 17:53 ` [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).