Re: When Storable and Devel::DProf mix, core dump [perl #19385]
[p5sagit/p5-mst-13.2.git] / Porting / repository.pod
index d1667b7..9b59bba 100644 (file)
@@ -2,8 +2,16 @@
 
 repository - Using the Perl repository
 
-This document describes what a Perl Porter needs to do
-to start using the Perl repository.
+=head1 Synopsis
+
+First, we assume here that you have already decided that you will
+need B<write> access to the repository.  If all you need is B<read>
+access, there are much better ways to access the most current state of
+the perl repository, or explore individual files and patches therein.
+See L<perlhack> for details.
+
+This document describes what a Perl Porter needs to do to start using
+the Perl repository.
 
 =head1 Prerequisites
 
@@ -145,7 +153,7 @@ be used for the value of the P4PORT environment variable (q.v.).
 =item sickle.activestate.com
 
 This is the canonical name of the host on which the perl repository
-resides. Its IP address is 199.60.48.20.
+resides.
 
 =item foo
 
@@ -191,7 +199,7 @@ the section above on the B<-L 1666:127.0.0.1:1666> option to ssh.
 
 The value of this is the name by which Perforce knows your
 host's workspace. You need to pick a name (normally, your
-Perforce username, a dash, and your hostname)
+Perforce username, a dash, and your host's short name)
 when you first start using the perl repository and then
 stick with it.
 
@@ -250,9 +258,10 @@ The C<p4 users> command lists all currently known users.
 Once these three environment variables are set, you can use the
 perforce p4 client exactly as described in its documentation.
 After setting these variables and connecting to the repository
-for the first time, you should use the C<p4 user> and
-C<p4 client> commands to tell perforce the details of your
-new username and your new client workspace specifications.
+for the first time, you should use the C<p4 user> command to
+set a valid email address for yourself.  Also use the C<p4 client>
+command to specify your workspace specifications for each
+individual client from which you will interact with the repository.
 
 =head1 Ending a Repository Session
 
@@ -357,6 +366,9 @@ Other useful Perforce commands
 
 Note: the output of "p4 describe" is not in proper diff format, use
 the F<Porting/p4genpatch> to get a diff-compatible format.
+(Note that it may be easier to get one already prepared: grep
+L<perlhack> for APC, and append eg "/diffs/12345.gz" to one of the
+URLs to get a usable patch.)
 
     % p4 diff -se ./...     # have I modified something but forgotten
                             # to "p4 edit", easy faux pas with autogenerated