We need a way to manage release notes for Solaris SRUs, Updates and Releases.

It would be good if:

* Release notes were confined to issues that this customer might
  experience on this machine on this upgrade path.  This implies that
  release notes should take installed packages, original and final
  versions into account.

* Release notes are displayed for all proposed image modifying
  packaging operations when -n option is used.

* Release note display should not depend on being connected to external
  web sites.
* No new actions are required to make this work.
* Release notes could be updated without affecting the packages to which
  they apply so that RE/SUstaining could put them together at the end.

Proposal:

For Solaris, create a single package containing the release note
fragments.  All possible release notes that could affect this release
are delivered as separate files, in a consistent directory.  The files
will be named so as to distinguish them; the name is not otherwise
used.  A new actuator named 'release-note' is added to each file; it
is set to an FMRI, which has an optional version.  If that fmri is
present at the specified level or earlier in the original image, the
release note is included in the release-note summary.  If no version
is specified, the release is note is included if any version was
present in the original image.  If multiple release-note attributes
are set, the release note is used if any of the conditions are true.

The compiled release notes would be stored by IPS, and displayed to
the user if -v is given.  Without -v, if any release notes apply to
the upgrade the user has performed, he would be reminded to read them,
and given a pointer to a file containing the compiled nodes.  If any
file with a release note that applies has must-display=true as well,
the release notes will be always be displayed whether or not -v is
used.  Release notes for previous packaging operations can be read (&
file name retrieved) using pkg history -l.



- Bart

--
Bart Smaalders                  Solaris Kernel Performance
[email protected]       http://blogs.oracle.com/barts
"You will contribute more with Mercurial than with Thunderbird."
"Civilization advances by extending the number of important
 operations which we can perform without thinking about them."
_______________________________________________
pkg-discuss mailing list
[email protected]
http://mail.opensolaris.org/mailman/listinfo/pkg-discuss

Reply via email to