On 10/5/21 12:09, Michał Górny wrote:
On Tue, 2021-10-05 at 19:27 +0100, Sam James wrote:
This is a preliminary version/draft of a proposed change to
GLEP 68.
I'd like to introduce a method for developers to signal anything
special about a package and how to correctly maintain it.
Sam James (1):
glep-0068: Add notes element for package maintenance instructions
glep-0068.rst | 26 +++++++++++++++++++++++---
1 file changed, 23 insertions(+), 3 deletions(-)
To be honest, I don't think adding it to metadata.xml is a good idea.
This is not something that's going to be machine-parseable,
and expecting people to look into metadata.xml to see if it's even
present is a bit much.
Maybe we could just add README files to the package directories
in question. This would have the clear advantage that the files will be
immediately visible.
Some of the devs use their username or project pages on the wiki for
maintainers notes. That's a decent place to keep them since there is not
an in-source place, but truly the closer the documentation can be kept
to the source the better.
I also like the idea of markdown files or RST files living in gentoo::.
I personally find RST to be a bit more challenging to write, but it's
simple enough to learn and we 'already have RST to HTML conversion on
www.g.o for GLEPs. GitHub will render either file format in browser. Not
sure about all the other Git* sites.
Apparently the MD and RST formats are somewhat interchangeable if one
does not go too crazy on formatting:
https://gist.github.com/javiertejero/4585196
