| 1 |
On Tue, Oct 05, 2021 at 02:21:22PM -0700, Alec Warner wrote: |
| 2 |
> I'd argue we can add NOTES.md to packages (e.g. allow those files.) |
| 3 |
> Then we modify packages.gentoo.org to render the markdown; or users |
| 4 |
> can render locally or read unrendered. |
| 5 |
> |
| 6 |
> WDYT? |
| 7 |
|
| 8 |
Given this topic came up again on IRC, late reply to say that some |
| 9 |
kind NOTES of file in the tree is my preference over metadata.xml |
| 10 |
at the moment. |
| 11 |
|
| 12 |
I don't feel strongly about being rendered somewhere though, a dev |
| 13 |
will see the file in the tree if they work on the package (partly |
| 14 |
because of that I'd also rather rst over md for bit better plain-text |
| 15 |
readability, but can work with either). Seeing the file is main reason |
| 16 |
I prefer this over metadata.xml, making it clear there's notes without |
| 17 |
needing any tools integration to parse metadata.xml and remind about. |
| 18 |
|
| 19 |
fwiw given these are entirely for devs they could even be skipped |
| 20 |
from sync mirrors so users don't get them and think it's something |
| 21 |
they need to read (+less files), but no strong opinion here. |
| 22 |
|
| 23 |
-- |
| 24 |
ionen |
Archives