There are many places in Package Maintainer Docs that document or give
examples of command line tool syntax. Most of these were already using
notation that was compatible, or almost so, with [docopt]. Be more
consistent by making everything really compatible with that notation,
and also by choosing to denote a mandatory parameter via <some_string>
instead of SOME_STRING.
[docopt]: http://docopt.org/
As these are updates very irregularly and Fedora 41 was almost
completely missed, and with Fedora 42 release being just days away, set
MAJOROSVER to 42 now.
Previously, `fedrq` was only mentioned in the Utilities page. On the
other hand, Package Update Guide did not have anything about checking
for affected dependents. Move `fedrq` usage instructions to that page,
so it is part of a document describing a full workflow, rather than
just in a list of random tools.
The new _Finding dependents_ section in Package Update Guide is quite
short for such a complicated topic. It can be extended later. The
purpose of this change is not to exhaustively cover that topic. The
purpose is just to move the existing coverage of `fedrq` abd checking
for affected packages.
Add --request to the recommended koji wait-repo call for doing
side tag builds, needed now we use on-demand repo generation.
Signed-off-by: Adam Williamson <awilliam@redhat.com>
The following items were broken in [pull request 173][pr]:
* Section was in the wrong level.
* String '<=' was intended to be interpreted as-is, but Antora actually
replaces this sequence with the '⇐' character.
* Delimiters for code blocks were wrong and were interpreted as
horizontal lines.
[pr]: https://pagure.io/fedora-docs/package-maintainer-docs/pull-request/173
Adjusted with semantic line breaks,
I have moved the text introducing copr as an option from section upload your package, but have not changed it's wording or syntax
Requesting dist-git branches was covered in multiple places. To avoid
maintaining the same information in multiple places, retain one
location, extend it with additional information from other places, and
replace other places with links.
This is a follow up for f0316f9347 from #165 where the new location,
intended to be the main source, was added.
Section _Update attributes_ was under the section about singe-package
updates, but its content applies equally to multi-package updates.
Move it to correct level in the section hierarchy.
Some sections were put under section _Multi-package updates_, even
though they applied equally to single-package updates. Move them to
higher level to avoid confusion and make the table of contents easier
to understand.
Previously, the different workflows used before and after
updates-testing activation did not have clear names. Instead, they were
referred to by explaining the difference every time, with quite many
words. Simplify the text by naming them _before updates-testing activation_
and _after updates-testing_activation_.
Pull requests are an important aspect of how Fedora packaging works,
and, crucially, the easiest way for new contributors to get started.
Document a way how they can be used.
Fixes#66
The script comes from [fedora-docs-template][1], which already a long
time ago released a new version. And also changed script name. Update
to match upstream, and to benefit from new features and fixes, whatever
they may be.
[1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template
The most common warning is about redirects. Such links are replaced
with direct links. In some cases better syntax for the same URL is
used, and in a single case the link target seems to be completely gone,
so the link is just removed.
1. linkchecker had removed option `--complete`, so have to remove it
from here as well.
2. Many errors were not actionable, because they came from Docs
stylesheet. Add `--ignore-url` entries to silence such errors.