From 07cc730f86e8a471be0b7810faa0032cc5fe14d8 Mon Sep 17 00:00:00 2001 From: Otto Urpelainen Date: Apr 21 2022 05:24:39 +0000 Subject: Fix broken links Antora 3 has improved reporting of broken links. This has revealed some problems, which are fixed here: * Xref in Python guidelines had garbled target filename. * Xref in what-can-be-packaged had an additional '/' character. * Xref to java-packaging-howto component was actually correct, but shorter syntax for the same is introduced. The link still fails because java-packaging-howto has a problem. Pull request to fix it has been submitted already: https://pagure.io/java-packaging-howto/pull-request/2 --- diff --git a/guidelines/modules/ROOT/nav.adoc b/guidelines/modules/ROOT/nav.adoc index a941ba4..6281361 100644 --- a/guidelines/modules/ROOT/nav.adoc +++ b/guidelines/modules/ROOT/nav.adoc @@ -47,7 +47,7 @@ *** xref:Golang_templates.adoc[Additional annotated templates] ** xref:Haskell.adoc[Haskell] ** xref:Java.adoc[Java] -*** xref:java-packaging-howto:ROOT:index.adoc[Java Packaging HOWTO] +*** xref:java-packaging-howto::index.adoc[Java Packaging HOWTO] ** xref:JavaScript.adoc[JavaScript] ** xref:Lisp.adoc[Lisp] ** xref:Mono.adoc[Mono] diff --git a/guidelines/modules/ROOT/pages/Python.adoc b/guidelines/modules/ROOT/pages/Python.adoc index da9f595..caa674e 100644 --- a/guidelines/modules/ROOT/pages/Python.adoc +++ b/guidelines/modules/ROOT/pages/Python.adoc @@ -936,7 +936,7 @@ that might not always set `+$PATH+` or install scripts consistently. == Using Cython[[_packages_using_cython]] Tightening the -xref:what-can-be-packaged.adoc/#_pregenerated_code[general Fedora policy], +xref:what-can-be-packaged.adoc#pregenerated-code[general Fedora policy], packages *MUST NOT* use files pre-generated by Cython. These *MUST* be deleted in `+%prep+` and regenerated during the build. diff --git a/guidelines/modules/ROOT/pages/Python_Appendix.adoc b/guidelines/modules/ROOT/pages/Python_Appendix.adoc index 910fb6f..bd686f0 100644 --- a/guidelines/modules/ROOT/pages/Python_Appendix.adoc +++ b/guidelines/modules/ROOT/pages/Python_Appendix.adoc @@ -7,7 +7,7 @@ Here are some additional Python-related guidelines, moved here in order to keep == Python 2 packages If your package needs to build for Python 2 only, -follow the xref:_201xPython.adoc[201x-era Python guidelines], +follow the xref:Python_201x.adoc[201x-era Python guidelines], except substitute 3 for 2. For example instead of `+%{python3_sitearch}+`, use `+%{python2_sitearch}+`. diff --git a/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc b/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc index d545463..0a7be23 100644 --- a/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc +++ b/guidelines/modules/ROOT/pages/what-can-be-packaged.adoc @@ -93,6 +93,7 @@ When you encounter prebuilt binaries in a package you *MUST*: * An exception is made for binary firmware, as long as it meets the requirements documented https://fedoraproject.org/wiki/Licensing:Main#Binary_Firmware[here]. * Some pre-packaged program binaries or program libraries may be under terms which do not permit redistribution, or be affected by legal scenarios such as patents. In such situations, simply deleting these files in %prep is not sufficient, the maintainer will need to make a modified source that does not contain these files. See: xref:SourceURL.adoc#when-upstream-uses-prohibited-code[When Upstream uses Prohibited Code]. +[#pregenerated-code] == Pregenerated code Often a package will contain code which was itself generated by other code. This often takes the form of configure files or parsing code generated by bison/yacc or lex/flex.