|
|
heads up: Avoiding RTI Delays Related to man pages
Date: Tue, 26 Jul 2005 13:14:23 -0700 (PDT)
From: Patricia Levinson <Patricia dot Levinson at eng dot sun dot com>
To: on-all at sun dot com, onnv-gate at onnv dot eng dot sun dot com
Subject: heads up: Avoiding RTI Delays Related to man pages
Because customers rely heavily on man pages for information, it is
important to have man pages that are up-to-date and accurately reflect
the code base with which they are associated.
To ensure that man pages keep pace with code being putback,
WebRTItool now requires that man page CRs
be in the "Fix in Progress" state prior to submitting your
RTI.
We wanted to communicate with you how the man page group is dealing
with this new requirement, and how the man page group and engineering
can work together to ensure timely delivery of your man pages,
and no delays with filing your RTI.
Engineers can facilitate this process by using the following guidelines:
+ As always, the best way to deal with the new requirement is to file
your man page CR and begin work with your man page writer as early as
possible. As a guide, the man page group recommends filing man page CRs:
+ 4 builds aheads for moderately large projects
+ 2 builds ahead for minor changes to one or more man pages
This kind of lead time allows for your man page writer(s) to ensure
that your man page work is ready for delivery at the same time as your
code.
Realizing that there are some cases (for example, Fast Tracks or high
priority fixes) that might not lend themselves to the above schedule,
we suggest the following:
+ If your CR needs to be integrated in the current build,
file the man page CR as soon as you know that your code fix
requires man page changes.
+ Include specific instructions regarding how to fix the man
page in the man page CR.
+ Cite the associated engineering CR in the man page CR.
+ Notify the man page rep to the Nevada c-team,
Pattie Levinson (patricia dot levinson at sun dot com), that
your man page CR is urgent. She will ensure that
the man page receives immediate priority, or that
you receive an exemption to putback your code
without the man page CR being in the "Fix in Progress" state.
For additional information regarding the filing of man page CRs and
the man page group, please contact your man page writer or
Pattie Levinson, man page representative to the Nevada c-team.
Thanks in advance for your cooperation.
Pattie Levinson, SunOS man page Group, c-team Rep
Mark J. Nelson, Solaris Nevada c-team Technical Lead
|