http://bugs.grommit.com/show_bug.cgi?id=400
Summary: DevRef changes for Mercurial
Product: SCM Migration
Version: unspecified
Platform: Other
OS/Version: Solaris 11/Nevada
Status: NEW
Severity: normal
Priority: P3
Component: other
AssignedTo: scm-migration-dev at opensolaris.org
ReportedBy: mike.kupfer at sun.com
The current ON Developer Reference assumes that Teamware is used
internally, and that external developers have to work from source
snapshots (tarball). We need to update the DevRef for Mercurial.
This is partly so that both internal and external developers can use
it as a reference. It's also to avoid confusion due to the reference
being out of date.
I've got an almost-finished set of changes to the DevRef to reflect
the changes in 6467531 (nightly's -O option). Ideally, we'll work
from that. But we could also update the copy in docs community
(http://www.opensolaris.org/os/community/documentation/files/) and
then merge the 6467531 changes later.
Here's a sketch of what changes are needed. I came up with this list
after reviewing the contents and doing a (case-insensitive) string
search on the terms "teamware", "sccs", "workspace", "bringover",
"putback", "parent", and "gate". Changes are tagged as Required or
Desirable.
The items below are mostly worded to imply that the text goes in the
DevRef itself. But in most cases, if there is documentation
elsewhere, a link from the DevRef is probably enough.
TBD: should we also include information about Subversion? ON won't
use it, but will other consolidations point people at the ON DevRef?
Section 1.3.3.1 Creating a Source Workspace: add a section on setting
up a local workspace using Mercurial. [Required]
Section 2.1.1 Development Environment: update to reflect current
storage requirements. [Desirable]
Section 2.1.2 Build Environment: same as 2.1.1.
Section 3.1 Retrieving the Sources: add a section on using Mercurial.
[Required]
Section 3.4 Keeping your workspace in sync: add a section on using
Mercurial. [Required]
Section 4.1 Environment Variables: update description of CODEMGR_WS to
reflect the fact that it's still needed for Mercurial workspaces.
[Required]
Chapter 6 Integration Procedure: this chapter currently says nothing
about the request-sponsor process or--for people with commit
access--putback details. This is a pretty big hole, and I don't think
it's reasonable for the SCM Migration project to fill it completely.
I suppose we could start with just a pointer to the ON README, or any
other documentation that talks about RTIs, delta squishing, "putback
-n", "hg outgoing -v" , etc. We need to provide *somewhere* the
Mercurial equivalents and information about registering one's ssh key.
[Required]
Section 7.2.3 Non-Formatting Considerations: remove discussion of SCCS
keywords. [Required]
Glossary: update entry for TeamWare to reflect that it's (just) used
for releases prior to Nevada. Add entries for Mercurial and maybe
Subversion. [Required]
--
Configure bugmail: http://bugs.grommit.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
