From: Joonas Niilola <juippis@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: Re: [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68)
Date: Fri, 4 Mar 2022 10:02:58 +0200 [thread overview]
Message-ID: <a48d79c7-7de1-d264-8ac2-c75b7b79d816@gentoo.org> (raw)
In-Reply-To: <YiFewhfA3Lr3VPiP@eversor>
[-- Attachment #1.1: Type: text/plain, Size: 1604 bytes --]
On 4.3.2022 2.35, Ionen Wolkens wrote:
> On Tue, Oct 05, 2021 at 02:21:22PM -0700, Alec Warner wrote:
>> I'd argue we can add NOTES.md to packages (e.g. allow those files.)
>> Then we modify packages.gentoo.org to render the markdown; or users
>> can render locally or read unrendered.
>>
>> WDYT?
>
> Given this topic came up again on IRC, late reply to say that some
> kind NOTES of file in the tree is my preference over metadata.xml
> at the moment.
>
> I don't feel strongly about being rendered somewhere though, a dev
> will see the file in the tree if they work on the package (partly
> because of that I'd also rather rst over md for bit better plain-text
> readability, but can work with either). Seeing the file is main reason
> I prefer this over metadata.xml, making it clear there's notes without
> needing any tools integration to parse metadata.xml and remind about.
>
> fwiw given these are entirely for devs they could even be skipped
> from sync mirrors so users don't get them and think it's something
> they need to read (+less files), but no strong opinion here.
>
make.conf:
FEATURES="bumpnotes"
or make.conf:
BUMPNOTES=y
then .ebuild:
BUMPNOTES=1
or
has_version sys-apps/portage[gentoo-dev]
results in:
"QA notice:
This package has internal version bump notes. Please see..."
and do those notes get saved to metadata.xml?
Because I doubt people will get to the habit of checking metadata.xml
manually for each bump. But we all test the packages we merge ":^)" and
therefore would see this QA notice. Or ewarn.
-- juippis
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 618 bytes --]
next prev parent reply other threads:[~2022-03-04 8:03 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-05 18:27 [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68) Sam James
2021-10-05 18:27 ` [gentoo-dev] [PATCH 1/1] glep-0068: Add notes element for package maintenance instructions Sam James
2021-10-05 19:09 ` Mike Gilbert
2021-10-05 19:42 ` Wolfgang E. Sanyer
2021-10-05 22:17 ` Andreas K. Huettel
2021-10-06 5:35 ` Ulrich Mueller
2021-10-05 19:09 ` [gentoo-dev] [PATCH 0/1] Add 'notes' element to metadata.xml (GLEP 68) Michał Górny
2021-10-05 20:13 ` Alessandro Barbieri
2021-10-06 5:28 ` Ulrich Mueller
2021-10-07 7:00 ` Matthew Marchese
2021-10-07 7:27 ` Ulrich Mueller
2021-10-05 20:29 ` Alec Warner
2021-10-05 20:36 ` Sam James
2021-10-05 21:21 ` Alec Warner
2021-10-06 5:37 ` Ulrich Mueller
2021-10-06 6:25 ` Alec Warner
2021-10-06 9:33 ` Ulrich Mueller
2022-03-04 0:35 ` Ionen Wolkens
2022-03-04 8:02 ` Joonas Niilola [this message]
2021-10-05 23:54 ` Joshua Kinard
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=a48d79c7-7de1-d264-8ac2-c75b7b79d816@gentoo.org \
--to=juippis@gentoo.org \
--cc=gentoo-dev@lists.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