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: dnf
Version: rawhide
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
Assignee: rpm-software-management
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks: dnf-community
TreeView+ depends on / blocked
 
Reported: 2020-09-03 15:03 UTC by Neal Gompa
Modified: 2020-09-07 11:24 UTC (History)
9 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
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


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