On 28-09-2023 21:12, Florian Weimer wrote:
* Stephen Gallagher:
On Wed, Sep 27, 2023 at 12:59 PM Ron Olson <tachoknight@xxxxxxxxx> wrote:
I mean this sincerely: Where is the excellent documentation? I admit that I’ve been frustrated that web searches leads me all over the place, sometimes the documentation is obsolete, or it’s someone’s blog post, etc. I’ve been surprised again and again there’s a macro for this or that which could have made the job much easier, but I had no idea until I asked here or in IRC.
The documentation he's referring to is the
https://src.fedoraproject.org/rpms/redhat-rpm-config/blob/rawhide/f/buildflags.md
Indeed, we probably should figure out a way to make that link more
prominent on the Packaging Guidelines pages, though.
I couldn't figure out the contribution process for the documentation (it
probably has changed since), but I did file
<https://pagure.io/packaging-committee/issue/743> a while back.
Making a copy is disappointing because it will bit-rot fairly quickly.
Every Fedora release will change some build flags. And ideally, you'd
consult the documentation for the Fedora release you are working on.
The on-the-side documentation wouldn't be versioned per Fedora release.
I see what you mean. The file is constantly evolving.
How about adding a section to the top of the document saying something
along the lines:
The build flags are constantly evolving You can find the most recent
version of this document online at
https://src.fedoraproject.org/rpms/redhat-rpm-config/blob/${RELEASE}/f/buildflags.md
where ${RELEASE} refers to the Fedora release you are packaging for
(e.g. f38, f39 or rawhide).
That way someone looking at the installed version of the file will be
directed towards the most current version for any release.
That aside, having the document linked in the packaging guidelines is a
big step towards letting packagers know of its existence.
Thanks for all the work!
-- Sandro
_______________________________________________
devel mailing list -- devel@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to devel-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/devel@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue
