public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: Ulrich Mueller <ulm@gentoo.org>
To: Arthur Zamarin <arthurzam@gentoo.org>
Cc: gentoo-dev@lists.gentoo.org,  glep@gentoo.org
Subject: [gentoo-dev] Re: [DRAFT v2] GLEP 84: Standard format for package.mask files
Date: Fri, 13 Oct 2023 18:06:18 +0200	[thread overview]
Message-ID: <ulec6se11@gentoo.org> (raw)
In-Reply-To: <fd84e73a-27aa-487e-8722-fd4e91fee5f2@gentoo.org> (Arthur Zamarin's message of "Fri, 13 Oct 2023 17:11:51 +0300")

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

>>>>> On Fri, 13 Oct 2023, Arthur Zamarin wrote:

> Comments Block
> --------------

> The comments block consists of 2 mandatory parts (`author line`_ and
> `explanation`_) and one optional part (`last-rite epilogue`_). A blank line to
> separate the parts is optional. Trailing whitespace should be dropped.

> The lines in the comment block are prefixed with a "#" symbol. The comments
> should be separated with single space from the "#", unless this is trailing
> whitespace, in which case it should be removed (meaning blank lines in comments
> block are just "#\n").

Maybe flip these two paragraphs? Otherwise it is not entirely clear
whether the "blank line" mentioned in the first paragraph refers to a
true blank line, or to a line consisting of a single number sign.

> The paragraph should be of format ``Removal on ${DATE}. ${BUGS-LIST}``, where
> the date is RFC-3339 full-date format, meaning ``YYYY-MM-DD``, and the bugs
> list is of the `bugs list`_ format. The listed bugs should include the
> last-rite bug opened, and potentially more relevant bugs which weren't listed
> in the explanation paragraphs.

Does this mean that only the first of the following entries would be
valid?

# Removal on 2023-11-13. Bugs #678901, #890123
# Removal on 2023-11-13, bugs #678901, #890123.
# Removal on 2023-11-13. Bugs #678901 #890123

IMHO that would be too restrictive. Punctuation shouldn't be significant
there. (This doesn't preclude _recommending_ one of the variants.)

Ulrich

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 507 bytes --]

  reply	other threads:[~2023-10-13 16:06 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-13 14:11 [gentoo-dev] [DRAFT v2] GLEP 84: Standard format for package.mask files Arthur Zamarin
2023-10-13 16:06 ` Ulrich Mueller [this message]
2023-10-13 16:30   ` [gentoo-dev] " Arthur Zamarin
2023-10-13 18:42     ` Ulrich Mueller
2023-10-13 19:35       ` Arthur Zamarin
2023-10-13 19:46         ` Ulrich Mueller
2023-10-13 18:49 ` [gentoo-dev] " Ulrich Mueller
2023-10-13 19:32   ` Arthur Zamarin
2023-10-13 19:43     ` Ulrich Mueller

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=ulec6se11@gentoo.org \
    --to=ulm@gentoo.org \
    --cc=arthurzam@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    --cc=glep@gentoo.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