Bug 1875473 - [RFE] Support for showing the user package specific documentation post-transaction
Summary: [RFE] Support for showing the user package specific documentation post-transa...
Keywords:
Status: NEW
Alias: None
Product: Fedora
Classification: Fedora
Component: dnf5
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: rpm-software-management
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks: dnf-community
TreeView+ depends on / blocked
 
Reported: 2020-09-03 15:03 UTC by Neal Gompa
Modified: 2024-12-09 22:35 UTC (History)
12 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed:
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Neal Gompa 2020-09-03 15:03:33 UTC
Description of problem:
In URPMI, it's possible to have README.urpmi %doc files that get shown post-transaction to inform the user of additional required steps. It'd be great if a similar system existed in DNF (either in the core or as a plugin) so that a continuity of functionality is possible.

The current functionality in URPMI is as follows:
README.urpmi: always displayed
README.install.urpmi: displayed when first installing
README.(update|upgrade).urpmi (or README.upgrade.urpmi): always displayed when updating the package
README.<EVR>.(update|upgrade).urpmi: displayed when updating the package from a version strictly older than the given EVR

Note: <EVR> can be epoch:version-release, epoch:version, version-release, or version. Shortest wins.

I would propose that we add support for a README.RPM filename that operates on the same behavior.

I feel like this is possible as a plugin, but I'm not sure if our plugin hooks are granular enough...

Additional info:
This behavior is documented here: https://wiki.mageia.org/en/Packagers_RPM_tutorial#Interaction_with_urpmi_and_rpmdrake

Comment 1 Neal Gompa 2024-12-07 14:46:31 UTC
Moving to dnf5 since that's where feature development is.

Comment 2 Petr Pisar 2024-12-09 15:54:22 UTC
I don't think Fedora is interested in this Feature. Especially because it prefers silent installation. E.g. it does not show RPM scriptlet output.

Comment 3 Neal Gompa 2024-12-09 22:35:50 UTC
And yet our own documentation says we're supposed to make these files for documenting stuff like this that is Fedora specific or package specific. How are people supposed to find them without some kind of information?


Note You need to log in before you can comment on or make changes to this bug.