| 1 |
On 4.3.2022 2.35, Ionen Wolkens wrote: |
| 2 |
> On Tue, Oct 05, 2021 at 02:21:22PM -0700, Alec Warner wrote: |
| 3 |
>> I'd argue we can add NOTES.md to packages (e.g. allow those files.) |
| 4 |
>> Then we modify packages.gentoo.org to render the markdown; or users |
| 5 |
>> can render locally or read unrendered. |
| 6 |
>> |
| 7 |
>> WDYT? |
| 8 |
> |
| 9 |
> Given this topic came up again on IRC, late reply to say that some |
| 10 |
> kind NOTES of file in the tree is my preference over metadata.xml |
| 11 |
> at the moment. |
| 12 |
> |
| 13 |
> I don't feel strongly about being rendered somewhere though, a dev |
| 14 |
> will see the file in the tree if they work on the package (partly |
| 15 |
> because of that I'd also rather rst over md for bit better plain-text |
| 16 |
> readability, but can work with either). Seeing the file is main reason |
| 17 |
> I prefer this over metadata.xml, making it clear there's notes without |
| 18 |
> needing any tools integration to parse metadata.xml and remind about. |
| 19 |
> |
| 20 |
> fwiw given these are entirely for devs they could even be skipped |
| 21 |
> from sync mirrors so users don't get them and think it's something |
| 22 |
> they need to read (+less files), but no strong opinion here. |
| 23 |
> |
| 24 |
|
| 25 |
make.conf: |
| 26 |
FEATURES="bumpnotes" |
| 27 |
|
| 28 |
or make.conf: |
| 29 |
BUMPNOTES=y |
| 30 |
|
| 31 |
then .ebuild: |
| 32 |
BUMPNOTES=1 |
| 33 |
|
| 34 |
or |
| 35 |
has_version sys-apps/portage[gentoo-dev] |
| 36 |
|
| 37 |
results in: |
| 38 |
"QA notice: |
| 39 |
This package has internal version bump notes. Please see..." |
| 40 |
|
| 41 |
and do those notes get saved to metadata.xml? |
| 42 |
|
| 43 |
Because I doubt people will get to the habit of checking metadata.xml |
| 44 |
manually for each bump. But we all test the packages we merge ":^)" and |
| 45 |
therefore would see this QA notice. Or ewarn. |
| 46 |
|
| 47 |
-- juippis |
Archives