Generate doc/buildinfo-fields-reference.rst

[philderbeast]

Helps with #9186. Revives the buildinfo-reference-generator package, replaces a PHONY target with doc/buildinfo-fields-reference.rst as the target in the Makefile and updates a field reference. Includes the output generated by the Makefile recipe, doc/buildinfo-fields-reference.rst.

Template Β: This PR does not modify cabal behaviour (documentation, tests, refactoring, etc.)

Include the following checklist in your PR:

• Patches conform to the coding conventions.

To test:

$ make doc/buildinfo-fields-reference.rst --always-make

[ulysses4ever]

Would it be possible to add this make command to the "Quick Jobs" in the CI so that we're sure that it doesn't bitrot? I assume it's not very expensive?..

My general intention is to increase the coverage of the makefile targets in our CI when possible.

[philderbeast]

@ulysses4ever on my machine it takes <5s to run with the project already built and about a minute to run after a cabal clean.

[ulysses4ever]

This is affordable.

[philderbeast]

@ulysses4ever is "Quick Jobs" the right place for it? Maybe it is something for .github/workflows/users-guide.yml?

[ulysses4ever]

Right, that probably makes more sense.

[philderbeast]

@ulysses4ever I added a quick job, not wanting to slow down the doc job. If it fails then the output will look something like the following that shows a stray -Resolving dependencies... from a prior intentional bad check in for this test:

make: *** [Makefile:69: doc/buildinfo-fields-reference.rst] Error 1
git diff --exit-code doc/buildinfo-fields-reference.rst
diff --git a/doc/buildinfo-fields-reference.rst b/doc/buildinfo-fields-reference.rst
index afd95e8..338bbdd 100644
--- a/doc/buildinfo-fields-reference.rst
+++ b/doc/buildinfo-fields-reference.rst
@@ -1,4 +1,3 @@
-Resolving dependencies...
 .. _buildinfo-field-reference:
 
 Field Syntax Reference
Error: Process completed with exit code 2.

[philderbeast]

@ulysses4ever and @geekosaur, normally I wouldn't boost the scope of a fix but I added GHC2021 to default-language and sorted this list, newest-first.

[ulysses4ever]

Thanks! Minor CI comments from me…

[philderbeast]

Label merge+no rebase is necessary when the pull request is from an organisation.