Helix SwarmHelix Swarm
Loading...

admin.html

  • //
  • guest/
  • jeff_bowles/
  • faq/
  • admin.html #1
  • View
  • Commits
  • Open Download .zip Download (49 KB) 
  1. <HTML>
  2. <HEAD>
  3.    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
  4.    <META NAME="GENERATOR" CONTENT="Mozilla/4.05 [en] (X11; U; OSF1 V4.0 alpha) [Netscape]">
  5.    <TITLE>FAQ for System Administators supporting basic Perforce issues</TITLE>
  6. <x-html>
  7. </HEAD>
  8. <BODY>
  9.  
  10. <DL>
  11. <H1>
  12. Perforce FAQ for System Administrators</H1>
  13. <p>
  14. Contributed by Jeff Bowles
  15.  
  16. <H3>
  17. Note - the intended audience for this FAQ is a system administrator who
  18. knows some Perforce commands as a user, but needs more information to be
  19. able to do some Perforce administration tasks such as setting up a new
  20. Perforce user or dealing with restarting the Perforce server after a recovery
  21. from a catastrophic disk crash.</H3>
  22. <I>This FAQ assumes that there is a Perforce Administrator who knows some
  23. of the more complex parts of Perforce, who can provide help, counseling,
  24. and deal with policy-specific issues....</I>
  25. <BR>&nbsp;
  26. <BR>&nbsp;
  27. <H5>
  28. <B>Client Stuff</B></H5>
  29. </DL>
  30.  
  31. <UL>
  32. <LI>
  33. <FONT COLOR="#000000"><A HREF="#clientspec">What's
  34. a client? What's a client spec? How do I tell what this client spec does
  35. and doesn't do? How do I add a new client?</A></FONT></LI>
  36.  
  37. <LI>
  38. <FONT COLOR="#000000"><A HREF="#viewotherclientspecs">How
  39. do I tell what some else's client spec looks like? How do I change the
  40. e-mail address for a user is, if it's not the same as their P4 user name?</A></FONT></LI>
  41. </UL>
  42.  
  43. <H5>
  44. <FONT COLOR="#000000">Non-admin Usage Stuff</FONT></H5>
  45.  
  46. <UL>
  47. <LI>
  48. <FONT COLOR="#000000"><A HREF="#add_deletefiles">How do you
  49. add/delete files? Can you retrieve a deleted file? How?</A></FONT></LI>
  50.  
  51. <LI>
  52. <FONT COLOR="#000000"><A HREF="#internalvars">On
  53. Windows/NT, how can I look at internal variables that the Perforce client
  54. uses to connect?</A></FONT></LI>
  55.  
  56. <LI>
  57. <FONT COLOR="#000000"><A HREF="#p4revert">What is/How do I do
  58. a p4 revert?</A></FONT></LI>
  59.  
  60. <LI>
  61. <FONT COLOR="#000000"><A HREF="#p4integ">What is/How do
  62. I do an integration?</A></FONT></LI>
  63.  
  64. <LI>
  65. <FONT COLOR="#000000"><A HREF="#who_has_opened">How can I find
  66. out who has a particular file checked out?</A></FONT></LI>
  67.  
  68. <LI>
  69. <FONT COLOR="#000000"><A HREF="#p4resolve">How do I do
  70. a p4 resolve</A></FONT></LI>
  71.  
  72. <LI>
  73. <FONT COLOR="#000000"><A HREF="#p4unsubmit">How do I
  74. "unsubmit" a changelist</A></FONT></LI>
  75.  
  76. <LI>
  77. <FONT COLOR="#000000"><A HREF="#p4modifychangelist">How
  78. do I "unsubmit" files stuck in a *pending* changelist</A></FONT></LI>
  79. </UL>
  80.  
  81. <H5>
  82. <FONT COLOR="#000000">Policy Stuff</FONT></H5>
  83.  
  84. <UL>
  85. <LI>
  86. <FONT COLOR="#000000"><A HREF="#crlf">How
  87. does Perforce deal with CR/LF issues? Can this be overridden?</A></FONT></LI>
  88.  
  89. <LI>
  90. <FONT COLOR="#000000"><A HREF="#binaries">Should
  91. we store binaries in Perforce? Why, or why not?</A></FONT></LI>
  92. </UL>
  93.  
  94. <H5>
  95. <FONT COLOR="#000000">Admin Issues (backups et al)</FONT></H5>
  96.  
  97. <UL>
  98. <LI><A HREF="#backups">Checkpoint/Journal Questions</A>
  99. <OL>
  100. <LI>
  101. <FONT COLOR="#000000"><A HREF="#whatischeckpoint">
  102. What is a checkpoint?</A></FONT></LI>
  103.  
  104. <LI>
  105. <FONT COLOR="#000000"><A HREF="#checkpointfrequency">
  106. When do I make a checkpoint? How often should I checkpoint my database?</A></FONT></LI>
  107.  
  108. <LI><FONT COLOR="#000000"><A HREF="#journals">
  109. What's a journal file? What's it good for?</A></FONT></LI>
  110.  
  111. <LI><FONT COLOR="#000000"><A HREF="#checkpointfails">
  112. What do I do if the checkpoint of the database fails?</A></FONT></LI>
  113.  
  114. <LI><FONT COLOR="#000000"><A HREF="#backupstrategy">
  115. So if I make checkpoints and have journaling enabled, do I have a good backup strategy?</A></FONT></LI>
  116. </OL>
  117.  
  118. <LI>
  119. <FONT COLOR="#000000"><A HREF="#machinedead">If the machine
  120. on which the Perforce depot dies, what do we do? If it runs out of space
  121. on the depot filesystem, what do we do?</A></FONT></LI>
  122.  
  123.  
  124. <LI>
  125. <FONT COLOR="#000000"><A HREF="#security">How do I handle
  126. security? (i.e. adding new IP address using p4 protect)</A></FONT></LI>
  127.  
  128. <LI>
  129. <FONT COLOR="#000000"><A HREF="#newuser">How do I add
  130. a new user?</A></FONT></LI>
  131.  
  132. <LI>
  133. <A HREF="#p4protect">What, exactly, does p4 protect
  134. do?</A></LI>
  135.  
  136. <LI>
  137. <FONT COLOR="#000000"><A HREF="#offlineback">How
  138. do I bring an off-line worker back online</A></FONT></LI>
  139.  
  140. <LI>
  141. <FONT COLOR="#000000"><A HREF="#backupworkspace">Should I back
  142. up clients? If so, what files should I back up and what files should I
  143. keep? How long should I keep backups of clients?</A></FONT></LI>
  144. </UL>
  145.  
  146. <HR WIDTH="100%">
  147. <UL>
  148. <LI>
  149. <A NAME="clientspec"></A><B><FONT COLOR="#000000">What's
  150. a client? What's a client spec? How do I tell what this client spec does
  151. and doesn't do? How do I add a new client?</FONT></B></LI>
  152. </UL>
  153.  
  154. <UL><I>Glossary</I>
  155. <UL>
  156. <LI>
  157. <B>depot</B> - the term usually applied to the Perforce repository, which
  158. lives on the other end of the network connection specified with $P4PORT.
  159. There's also a syntax used to specify the path names of files in th<FONT COLOR="#000000">e
  160. depot:</FONT><TT><FONT COLOR="#990000"> //depot/x/y/z/file.java</FONT>.</TT></LI>
  161.  
  162. <LI>
  163. <B>client</B> - the [local] disk area on a developer's machine, onto which
  164. read-only copies of the source files are copied. Usually there's one client
  165. per user and one client per machine, but that's completely up to the user
  166. and to the people who set it up. (The command p4 client allows you to change
  167. the mapping so that a file is stored, locally, to the directory/file you
  168. specify. See the next item for details.)</LI>
  169.  
  170. <LI>
  171. <B>client specification</B> - documented <A HREF="http://www.perforce.com/perforce/doc.982/cmdguide/quickstart.html">here</A>,
  172. the internal information specific to a Perforce client, that specifies
  173. the following:</LI>
  174.  
  175. <OL>
  176. <LI>
  177. The date/time the client was created.</LI>
  178.  
  179. <LI>
  180. The local directory name that's the top of the local copy of the file set
  181. retrieved from the depot.</LI>
  182.  
  183. <OL>
  184. <PRE><TT><FONT COLOR="#990000">Root:&nbsp;&nbsp; D:/src</FONT></TT></PRE>
  185. </OL>
  186.  
  187. <LI>
  188. An owner, which isn't that useful.</LI>
  189.  
  190. <LI>
  191. Lines at the end that look like</LI>
  192.  
  193. <OL>
  194. <PRE><TT><FONT COLOR="#990000">//depot/x/y/...&nbsp;&nbsp;&nbsp; //<I>clientname</I>/x/y/...
  195. //depot/x/z/%1&nbsp;&nbsp;&nbsp;&nbsp; //<I>clientname</I>/x/old-z/%1</FONT></TT></PRE>
  196. </OL>
  197.  
  198. <LI>
  199. The way to read this is "<I>left is the depot pathname and right is the
  200. local disk pathname"</I>. These lines are the meat of the client specification
  201. and can be a little tricky.</LI>
  202.  
  203. <UL>
  204. <LI>
  205. The first line says <I><FONT COLOR="#000000">"all files in depot directory
  206. /x/y on the depot should be installed in D:/src/x/y, preserving the
  207. path names below x/y"&nbsp;</FONT></I> (for this example). <U>Every "..."
  208. is a wild card meaning "everything from here down".</U></LI>
  209.  
  210. <LI>
  211. the second lines says "<FONT COLOR="#000000">the files in depot directory
  212. /x/z (but no subdirectories in it) should be put into D:/src/x/old-z"</FONT>.</LI>
  213. </UL>
  214.  
  215. <LI>
  216. The default client spec maps all depot files to the local disk, using:</LI>
  217.  
  218. <OL>
  219. <PRE><TT><FONT COLOR="#990000">//depot/...&nbsp;&nbsp;&nbsp; //<I>clientname</I>/...</FONT></TT></PRE>
  220. </OL>
  221.  
  222. <LI>
  223. Usually we'll make a client with the "default client specification" and
  224. use that to create new clients. For example, if the a client named XXX
  225. exists and has the perfect client spec for a new client to imitate, then</LI>
  226.  
  227. <OL>
  228. <PRE><TT><FONT COLOR="#990000">P4CLIENT=newclientname
  229. p4 client -t XXX</FONT></TT></PRE>
  230. </OL>
  231. <TT><FONT COLOR="#990000">&nbsp;</FONT></TT><FONT COLOR="#000000">will
  232. create the new client using the existing "XXX" client as a template. (Hint:
  233. </FONT><TT><FONT COLOR="#990000">p4 client</FONT></TT><FONT COLOR="#000000">
  234. uses the current directory as the default for the Root: of the local file
  235. set it'll retrieve, so you can save keystrokes by </FONT><FONT COLOR="#990000">chdir</FONT><FONT COLOR="#000000">'ing
  236. there before running </FONT><TT><FONT COLOR="#990000">p4 client</FONT></TT><FONT COLOR="#000000">.)</FONT></OL>
  237.  
  238. <LI>
  239. <B>client software</B> - the copy of <FONT COLOR="#990000">p4.exe</FONT>
  240. or <FONT COLOR="#990000">p4</FONT> ("client") that someone's downloaded
  241. from <A HREF="http://www.perforce.com">Perforce, Inc</A>. that connects
  242. to a database process ("server")&nbsp; that administers the depot.&nbsp;
  243. There are many platforms supported, which means there are many different
  244. machines for which you can download a new <FONT COLOR="#990000">p4</FONT>
  245. client executable. [Aside: <U>there are no legal restrictions at all w.r.t.
  246. Perforce client software</U> - the licenses are based on the number of
  247. legal users, and we can download client software for as many different
  248. platform types as we choose.]</LI>
  249. </UL>
  250. <I><FONT COLOR="#000000">How do I tell what this client spec does and doesn't
  251. do?</FONT></I>
  252. <BR>&nbsp;
  253. <UL>
  254. <LI>
  255. <TT><FONT COLOR="#990000">p4 client -o <I>clientname</I></FONT></TT><FONT COLOR="#000000">&nbsp;
  256. will tell you a lot about a remote client. The two items to stare at are
  257. "</FONT><FONT COLOR="#990000">Root:</FONT><FONT COLOR="#000000">" (where
  258. the local files are loaded) and "</FONT><FONT COLOR="#990000">View:</FONT><FONT COLOR="#000000">"
  259. (the mapping from depot-name to local-name).</FONT></LI>
  260.  
  261. <LI>
  262. <FONT COLOR="#000000"><U>Most client-spec headaches have to do with the
  263. view not including a new branch/codeline recently installed</U> - your
  264. build engineers can usually alert you these problems - and problems with
  265. wild cards in a "View:" line. ("..." and "%1", above, are both such wild
  266. cards and are documented <A HREF="http://www.perforce.com/perforce/doc.982/cmdguide/details.html">here</A>.
  267. In general, your build engineers and/or your local Perforce administrators
  268. should have a handle on this.)</FONT></LI>
  269. </UL>
  270. <I><FONT COLOR="#000000">How do I add a new client?</FONT></I>
  271. <BR>&nbsp;
  272. <UL>
  273. <LI>
  274. <FONT COLOR="#000000">See the item, above, that talks about </FONT><FONT COLOR="#990000">p4
  275. client -t XXX</FONT><FONT COLOR="#000000">.</FONT></LI>
  276. </UL>
  277. </UL>
  278. &nbsp;
  279. <HR WIDTH="100%">
  280. <UL>
  281. <LI>
  282. <A NAME="add_deletefiles"></A><B><FONT COLOR="#000000">How
  283. do you add/delete files? Can you retrieve a deleted file? How?</FONT></B></LI>
  284.  
  285. <BR>&nbsp;
  286. <UL>
  287. <LI>
  288. &nbsp;To <U>add</U> a file, run <FONT COLOR="#990000">p4 add filename</FONT>;
  289. to <U>delete</U> a file, run <FONT COLOR="#990000">p4 delete filename</FONT>.</LI>
  290.  
  291. <BR>In both cases, you've really just opened the file for add/delete and
  292. need to run <FONT COLOR="#990000">p4 submit</FONT> afterwards to get it
  293. checked into the depot.
  294. <LI>
  295. To retrieve a deleted file:</LI>
  296.  
  297. <UL>
  298. <LI>
  299. You need to know the filename in the form:</LI>
  300.  
  301. <UL>
  302. <PRE><TT><FONT COLOR="#990000">//depot/dev/src/sandbox/stella/GNUdepends.def</FONT></TT></PRE>
  303. </UL>
  304.  
  305. <LI>
  306. <FONT COLOR="#000000">You'll need some history information, so run the
  307. following command:</FONT></LI>
  308.  
  309. <UL>
  310. <PRE><TT><FONT COLOR="#990000">D:\src\dev\src><U>p4 filelog //depot/dev/src/sandbox/stella/GNUdepends.def
  311. </U>//depot/dev/src/sandbox/stella/GNUdepends.def
  312. ... #4 change 19737 delete on 1998/05/05 by stella@stella.greenwich 'Change to move stella's erro'
  313. ... ... delete into //depot/dev/src030100b01/sandbox/stella/GNUdepends.def#2
  314. ... #3 change 19611 edit on 1998/05/04 by stella@stella.sol 'Bits of hacking to support stag'
  315. ... ... branch into //depot/dev/sandbox/stella/GNUdepends.def#1
  316. ... ... branch into //depot/dev/src030100b01/sandbox/stella/GNUdepends.def#1</FONT></TT></PRE>
  317. </UL>
  318. <FONT COLOR="#000000">In this case, <U>revision #4 deleted the file</U>,
  319. and <U>revision #3 was the last revision that had "real" contents</U>.</FONT>
  320. <LI>
  321. <FONT COLOR="#000000">A fast way to look at the contents of revision #3
  322. of this file:</FONT></LI>
  323.  
  324. <UL>
  325. <PRE><TT><FONT COLOR="#990000">p4 print&nbsp; //depot/dev/src/sandbox/stella/GNUdepends.def#3</FONT></TT></PRE>
  326. </UL>
  327. <FONT COLOR="#000000">Note that the first line of output is a line of the
  328. form "</FONT><FONT COLOR="#990000"> <TT>//depot/dev/src/sandbox/stella/GNUdepends.def#3</TT></FONT><FONT COLOR="#000000">".</FONT>
  329. <BR><FONT COLOR="#000000">If you don't want that, run </FONT><TT><FONT COLOR="#990000">p4
  330. print -q</FONT><FONT COLOR="#000000"> </FONT></TT><FONT COLOR="#000000">instead
  331. of </FONT><TT><FONT COLOR="#990000">p4 print</FONT></TT><FONT COLOR="#000000">.</FONT>
  332. <LI>
  333. <FONT COLOR="#000000">To retrieve the contents and check 'em in again,
  334. you need to "re-add" the file:</FONT></LI>
  335.  
  336. <DL>
  337. <DL>
  338. <PRE><TT><FONT COLOR="#990000">p4 print -q&nbsp; GNUdepends.def#3 > newfile
  339. p4 add GNUdepends.def
  340. cp newfile&nbsp; GNUdepends.def
  341. p4 submit</FONT></TT></PRE>
  342. </DL>
  343. </DL>
  344. <FONT COLOR="#000000">(There's two other ways to do this: one is to branch
  345. revision #3 of the GNUdepends.def, creating a new version, but unfortunately
  346. it would need a different name; another would be to "p4 sync -f GNUdepends.def#3"
  347. and then move that copy to the side, then do the "p4 add" shown above.)</FONT></UL>
  348.  
  349. <LI>
  350. <FONT COLOR="#000000">The unasked question is <I>Can I expunge a file that
  351. I checked into the wrong place?</I> <U>That question is answered in the
  352. Perforce documentation, under "p4 obliterate", but this shouldn't be done
  353. without your Perforce administrator standing over you.</U> (That operation
  354. is completely irreversible.)</FONT></LI>
  355. </UL>
  356. </UL>
  357.  
  358. <HR WIDTH="100%">
  359. <UL>
  360. <LI>
  361. <A NAME="crlf"></A><B><FONT COLOR="#000000">How
  362. does Perforce deal with CR/LF issues? Can this be overridden?</FONT></B></LI>
  363. </UL>
  364.  
  365. <OL><I>Background</I>
  366. <OL>
  367. <OL>The machine on which the "p4" client software is run dictates the CR/LF
  368. behavior. If you extract the files from the Perforce depot using the Windows
  369. version of "p4" it'll have CR+LF as line separators <U>for text files</U>,
  370. even if you physically wrote the files to a Unix disk that was remotely
  371. mounted using NFS or Samba. (This means that the Macintosh version of the
  372. "p4" client uses CR for end-of-line, always, and the Unix client uses LF
  373. for end-of-line.)
  374. <BR>&nbsp;</OL>
  375. </OL>
  376. <I>How do you tell if a file is "text" or not?</I>
  377. <OL>&nbsp;
  378. <DL>If a file's checked in, run <FONT COLOR="#990000">p4 file XXX</FONT>
  379. where XXX is the name of the file. You'll get output of the form:
  380. <DL>
  381. <DL>
  382. <PRE><TT><FONT COLOR="#990000">//depot/dev/src/GNUdepends.def#3 - edit change 20027 (ktext)
  383. //depot/dev/src/GNUmakefile#188 - edit change 21753 (text)
  384. //depot/native/events/EventsGenCtl.bmp#3 - delete change 1103 (binary)</FONT></TT></PRE>
  385. </DL>
  386. </DL>
  387. <FONT COLOR="#000000">Unless it was specified when the user ran p4 add,
  388. the local Perforce client guessed based on the first few bytes of the file.
  389. (NUL characters and non-ASCII are dead giveaways - if they're present,
  390. the file <U>has</U> to be binary.)</FONT>
  391. <BR>&nbsp;</DL>
  392. </OL>
  393. <I><FONT COLOR="#000000">What if you it guessed wrong, and you need to
  394. change the type of a file so that it does end-of-line processing?</FONT></I>
  395. <OL>&nbsp;
  396. <OL><FONT COLOR="#000000">You'll need to open the existing file for editing,
  397. change its type, and submit the change:</FONT>
  398. <OL>
  399. <PRE><TT><FONT COLOR="#990000">p4&nbsp;&nbsp; edit&nbsp; -t text&nbsp; //depot/native/events/EventsGenCtl.bmp
  400. p4&nbsp;&nbsp; submit</FONT></TT></PRE>
  401. </OL>
  402. <FONT COLOR="#000000">In this case, you'll probably be treating a .bmp
  403. file like it's text, which is pretty silly, but this gets the point across.
  404. You can go back and forth with a file, if you choose - change the type
  405. of a file from text to binary, or binary to text. (The </FONT><U><FONT COLOR="#990000">k</FONT></U><FONT COLOR="#000000">
  406. in </FONT><U><FONT COLOR="#990000">ktext</FONT></U>, above, means "expand
  407. keywords like $Id: //depot/internal/staff/stella/P4AdminFAQ.html#18$ in the
  408. contents when it's fetched from the depot. There are other types, also:
  409. <TT><FONT COLOR="#990000">p4 help reopen</FONT></TT> lists 'em. There's
  410. a type for "long text files that are computer-generated such as PDF files"
  411. - be sure to note that one.)
  412. <BR>&nbsp;</OL>
  413. </OL>
  414. <I>Ways to force it to not interpret end-of-line, to leave the file contents
  415. alone:</I>
  416. <OL>&nbsp;
  417. <OL>Change the file type from text to binary, and make sure that it's byte-for-byte
  418. the exact contents you want.
  419. <BR>&nbsp;</OL>
  420. </OL>
  421. <I>How do I get Unix end-of-line processing behavior on my Windows Perforce
  422. client?</I>
  423. <OL>&nbsp;
  424. <OL>Short answer: I don't know. Certainly, you can edit the files on Unix,
  425. store what you want there, and change the file type to "binary" to guarantee
  426. that the contents aren't munged when you fetch 'em with the Windows client.
  427. that's probably the fastest, but ugliest way.</OL>
  428. </OL>
  429.  
  430. <HR WIDTH="100%"></OL>
  431.  
  432. <UL>
  433. <LI>
  434. <A NAME="viewotherclientspecs"></A><B><FONT COLOR="#000000">How
  435. do I tell what some else's client spec looks like? How do I change the
  436. e-mail address for a user is, if it's not the same as their P4 user name?</FONT></B></LI>
  437. </UL>
  438.  
  439. <UL><I><FONT COLOR="#000000">Looking at someone else's client...</FONT></I>
  440. <BR>&nbsp;
  441. <UL><FONT COLOR="#000000">To look at your client, you run:</FONT>
  442. <UL><TT><FONT COLOR="#990000">p4 client</FONT><FONT COLOR="#000000">&nbsp;&nbsp;</FONT></TT><FONT COLOR="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  443. (dumps you into an editor)</FONT></UL>
  444. <FONT COLOR="#000000">or</FONT>
  445. <UL><FONT COLOR="#990000"><TT>p4 client -o</TT>&nbsp;</FONT><FONT COLOR="#000000">&nbsp;&nbsp;
  446. (dumps information to standard output)</FONT></UL>
  447. <FONT COLOR="#000000">To look at someone else's client, run:</FONT>
  448. <UL>
  449. <PRE><TT><FONT COLOR="#990000">p4 -c <I>client-name</I> client</FONT></TT></PRE>
  450. </UL>
  451. or
  452. <UL>
  453. <PRE><TT><FONT COLOR="#990000">p4 -c <I>client-name</I>&nbsp; client -o</FONT></TT></PRE>
  454. </UL>
  455. <FONT COLOR="#000000">(Don't change this information (inside the editor)
  456. without eventually informing the user who uses it the most - they could
  457. get cranky about it!)</FONT>
  458. <BR>&nbsp;</UL>
  459. <I><FONT COLOR="#000000">Looking at someone else's user information...</FONT></I>
  460. <BR>&nbsp;
  461. <UL><FONT COLOR="#000000">To look at your user information, you run:</FONT>
  462. <UL><TT><FONT COLOR="#990000">p4 user</FONT></TT><FONT COLOR="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  463. (dumps you into an editor)</FONT></UL>
  464. <FONT COLOR="#000000">or</FONT>
  465. <UL><FONT COLOR="#990000"><TT>p4 user -o</TT>&nbsp;</FONT><FONT COLOR="#000000">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  466. (dumps information to standard output)</FONT></UL>
  467. <FONT COLOR="#000000">To look at someone else's user information, you run:</FONT>
  468. <UL><TT><FONT COLOR="#990000">p4&nbsp;<I> </I>user</FONT></TT><FONT COLOR="#000000">&nbsp;&nbsp;&nbsp;
  469. </FONT><I><FONT COLOR="#990000">their-name</FONT><FONT COLOR="#000000">&nbsp;&nbsp;&nbsp;
  470. </FONT></I><FONT COLOR="#000000">(dumps you into an editor)</FONT></UL>
  471. <FONT COLOR="#000000">or</FONT>
  472. <UL><TT><FONT COLOR="#990000">p4 -u <I>their-name</I> user -o</FONT></TT><FONT COLOR="#990000">&nbsp;</FONT><FONT COLOR="#000000">&nbsp;&nbsp;&nbsp;&nbsp;
  473. (dumps information to standard output)</FONT></UL>
  474. <FONT COLOR="#000000">(Note that, if it dumped you into an editor, the
  475. file's readonly. To modify another user's information, you will need to
  476. utter a couple of extra commands not included in this FAQ - see your local
  477. Perforce Administrator for those. )</FONT>
  478. <BR>&nbsp;</UL>
  479. <I><FONT COLOR="#000000">How would I change someone's e-mail address in
  480. the Perforce user database?</FONT></I>
  481. <BR>&nbsp;
  482. <UL><FONT COLOR="#000000">Run </FONT><TT><FONT COLOR="#990000">p4 user
  483. <I>user-name</I></FONT></TT><FONT COLOR="#990000"> </FONT><FONT COLOR="#000000">(which
  484. dumps you into an editor) and change it.</FONT>
  485. <BR>&nbsp;</UL>
  486. <I><FONT COLOR="#000000">Note - if you're trying to automate this...</FONT></I>
  487. <BR>&nbsp;
  488. <UL><FONT COLOR="#000000">Most commands that use the option </FONT><FONT COLOR="#990000">-o</FONT><FONT COLOR="#000000">
  489. to write to standard output have a </FONT><FONT COLOR="#990000">-i</FONT><FONT COLOR="#000000">
  490. option to read from standard input. By doing this, you could write a script
  491. that appends "@myplace.com" to the e-mail user with the commands:</FONT>
  492. <UL>
  493. <PRE><TT><FONT COLOR="#990000">p4 user -o ><I> tmp-file
  494. </I>sed '/^Email:/s/$/@myplace.com/' &lt; <I>tmp-file</I> | <U>p4 user -i</U></FONT></TT></PRE>
  495. </UL>
  496. <FONT COLOR="#000000">The underlined part will need a modification to succeed
  497. -&nbsp; it's deliberately omitted from this FAQ for security reasons. See
  498. your Perforce Adminstrators for details.</FONT>
  499.  
  500. <P><FONT COLOR="#000000">(If you do this sorta thing, put a lot more error
  501. checking into the script that you see here!)</FONT></UL>
  502. </UL>
  503. &nbsp;
  504. <HR WIDTH="100%">
  505. <UL>
  506. <LI>
  507. <A NAME="binaries"></A><B><FONT COLOR="#000000">Should
  508. we store binaries in Perforce? Why, or why not?</FONT></B></LI>
  509. </UL>
  510.  
  511. <UL><FONT COLOR="#000000"><I>Sure, but they can take up some space.</I>
  512. There are several things you need to do when you store a binary in Perforce:</FONT>
  513. <UL>
  514. <LI>
  515. <FONT COLOR="#000000">Make sure its file type is "</FONT><FONT COLOR="#990000">binary</FONT><FONT COLOR="#000000">"
  516. (or "</FONT><FONT COLOR="#990000">xbinary</FONT><FONT COLOR="#000000">")
  517. when you check it in. Binary files are stored in a different manner than
  518. text files, because with text files it makes sense to store a simple delta
  519. between two revisions. For certain generated text files (PostScript, Adobe
  520. Acrobat PDF files) and binaries it doesn't make sense, so pick the file
  521. type appropriately.</FONT></LI>
  522.  
  523. <LI>
  524. <FONT COLOR="#000000"><U>Perforce stores enough information to recreate
  525. each revision of the binary</U>, so if the binary is 100 Mb and you keep
  526. checking in new versions every day, you might run out of disk very quickly.</FONT></LI>
  527.  
  528. <LI>
  529. <FONT COLOR="#000000">A binary file stored in a branch doesn't immediately
  530. take up more space, but <U>has the potential to fill up each user's client
  531. area</U> by having multiple copies of [potentially] big files. [This can
  532. happen because a user might have multiple branches mapped to their disk,
  533. and they'd get a separate copy of the file for each branch.]</FONT></LI>
  534. </UL>
  535. <FONT COLOR="#000000">The main headache with storing binaries is that it's
  536. tempting to check in the complete release you developed using Perforce,
  537. so that "x.c" and "x.h" and "x.o" and "x.out" all appear in Perforce. That
  538. might not be the strategy you want, partly because it introduces an ambiguity:
  539. someone might update "x.c" or "x.h" but not realize that "x.out" is getting
  540. shipped, but wasn't updated. (That's dangerous.)</FONT>
  541.  
  542. <P>Addendum: a recent version of Perforce supports "compressed files" and
  543. can save a lot of space on the depot when used. If you need to store binaries
  544. in Perforce, it's handy to research this new feature.
  545.  
  546. <P>Also, there's a new file type called "tempobj" which stores "temporary
  547. object" files. It's a good way to check in the most recent revision of
  548. some object file, obsoleting all prior revisions, so that developers will
  549. be able to use this object (or library or executable) without recompiling
  550. it.</UL>
  551. &nbsp;
  552. <HR WIDTH="100%">
  553. <UL>
  554. <LI>
  555. <B><FONT COLOR="#000000">On Windows/NT,&nbsp;<A NAME="internalvars"></A>how
  556. can I look at internal variables that the Perforce client uses to connect?</FONT></B></LI>
  557.  
  558.  
  559. <P><I><FONT COLOR="#000000">Environment</FONT></I>
  560. <BR>&nbsp;
  561. <UL><FONT COLOR="#000000">There are the environment variables described
  562. here, but the most frequently used are <I>$P4PORT</I> and <I>$P4CLIENT</I>.</FONT>
  563. <BR>&nbsp;</UL>
  564. <I><FONT COLOR="#000000">Internal variables</FONT></I>
  565. <BR>&nbsp;
  566. <UL><FONT COLOR="#000000">In addition, p4 set shows some entries hidden
  567. [in the Windows registry, I believe] that can be set using</FONT>
  568. <UL>
  569. <PRE><FONT COLOR="#990000">p4 set&nbsp; P4PORT=<I>p4server:1666</I></FONT></PRE>
  570. </UL>
  571. <FONT COLOR="#000000">or</FONT>
  572. <UL>
  573. <PRE><FONT COLOR="#990000">p4 set -s P4CLIENT=<I>stella.newclientname</I></FONT></PRE>
  574. </UL>
  575. <FONT COLOR="#000000">To view this internal registry, type </FONT><TT><FONT COLOR="#990000">p4
  576. set</FONT></TT><FONT COLOR="#000000"> (with no arguments).</FONT>
  577. <BR>&nbsp;</UL>
  578. <I><FONT COLOR="#000000">Debugging this...</FONT></I>
  579. <BR>&nbsp;
  580. <OL>
  581. <LI>
  582. <FONT COLOR="#000000">If </FONT><FONT COLOR="#990000">p4 help</FONT><FONT COLOR="#000000">
  583. works, then </FONT><FONT COLOR="#990000">$P4PORT</FONT><FONT COLOR="#000000">
  584. is set correctly.</FONT></LI>
  585.  
  586. <LI>
  587. <FONT COLOR="#000000">If </FONT><FONT COLOR="#990000">p4 client -o</FONT><FONT COLOR="#000000">
  588. works, then </FONT><FONT COLOR="#990000">$P4CLIENT</FONT><FONT COLOR="#000000">
  589. is <U>probably</U> set correctly; read the output closely to make sure.</FONT></LI>
  590.  
  591. <LI>
  592. <FONT COLOR="#000000">If </FONT><FONT COLOR="#990000">p4 user -o</FONT><FONT COLOR="#000000">
  593. works, then it's getting the username out of the environment (good).</FONT></LI>
  594. </OL>
  595. </UL>
  596. &nbsp;
  597. <HR WIDTH="100%">
  598. <UL>
  599. <LI>
  600. <A NAME="p4revert"></A><B><FONT COLOR="#000000">What is/How do
  601. I do a p4 revert?</FONT></B></LI>
  602. </UL>
  603.  
  604. <UL><FONT COLOR="#000000">A file can be opened for add/delete/edit/integrate/branch,
  605. which flags the Perforce database with enough info to know who's changing
  606. what. These "markers" are cleared when you do run</FONT><FONT COLOR="#990000">
  607. p4 submit </FONT><FONT COLOR="#000000">or </FONT><FONT COLOR="#990000">p4
  608. revert </FONT><FONT COLOR="#000000">on those files.</FONT>
  609.  
  610. <P><FONT COLOR="#000000">To revert a file you've opened, run</FONT>
  611. <UL>
  612. <PRE><FONT COLOR="#990000">p4 revert&nbsp; file1&nbsp;&nbsp; [file2&nbsp; ...]</FONT></PRE>
  613. </UL>
  614. <FONT COLOR="#000000">This causes several things to happen:</FONT>
  615. <OL>
  616. <LI>
  617. <FONT COLOR="#000000">It's no longer marked as "open" in the Perforce database;</FONT></LI>
  618.  
  619. <LI>
  620. <FONT COLOR="#000000">A fresh copy of the revision of the <I>reverted</I>
  621. files that you started hacking on is copied back to your client area, since
  622. you might've made modifications that need to be obsoleted;</FONT></LI>
  623.  
  624. <LI>
  625. <FONT COLOR="#000000">The <I>reverted</I> files are marked read-only, as
  626. if you'd just run "p4 sync" on those files.</FONT></LI>
  627. </OL>
  628. <FONT COLOR="#000000">Note that you weren't given fresh copies of the top-level
  629. revision of the reverted files - they're left in exactly the state they
  630. were in before you ran "p4 add/delete/edit/integrate/branch".</FONT></UL>
  631. &nbsp;
  632. <HR WIDTH="100%">
  633. <UL>
  634. <LI>
  635. <A NAME="p4integ"></A><B><FONT COLOR="#000000">What is/How
  636. do I do an integration?&nbsp;<A NAME="p4resolve"></A>How
  637. do I do a p4 resolve?</FONT></B></LI>
  638.  
  639.  
  640. <P><FONT COLOR="#000000">In short, an integration is a command to merge
  641. changes from another codeline or a later revision of a file into a target
  642. revision managed by Perforce.</FONT>
  643. <OL>
  644. <LI>
  645. <FONT COLOR="#000000">For example, if you're editing revision #14 of a
  646. file and someone checks in revision #15, you'll need to <I>resolve</I>
  647. the new code into your working copy prior to submitting it to the depot.</FONT></LI>
  648.  
  649. <LI>
  650. <FONT COLOR="#000000">Another example is if you make a change to file.c
  651. in a branch and want to propogate the modified version to a parent/child
  652. branch of that file.</FONT></LI>
  653. </OL>
  654. <FONT COLOR="#000000">The detailed walk-through of an integration isn't
  655. included in this FAQ. To do this, look <A HREF="http://www.perforce.com/perforce/doc.973/cmdguide/html/conflict.htm">here</A>
  656. for the Perforce documentation on dealing with conflicts/integrations.</FONT>
  657.  
  658. <P><B><FONT COLOR="#000000">The most important thing to remember, when
  659. you're running "p4 resolve", is that <I>the file you're modifying is <U>your</U>
  660. file; any other files are <U>their</U> files</I>.&nbsp; </FONT></B><FONT COLOR="#000000">Why
  661. bother with this note? Well, much of the confusion doing the integrations
  662. comes from questions that "p4 resolve" asked you. You're expected to respond
  663. with things like "accept yours"&nbsp; or "accept theirs" or the like, and
  664. it's easiest to remember that <U>yours</U> always refers to the file that
  665. the "p4 integrate/p4 resolve/p4 submit" cycle will be modifying. It doesn't
  666. matter whether it's the parent or the child in the branch.</FONT></UL>
  667.  
  668. <UL>&nbsp;[Aside: you must always remember to <TT><FONT COLOR="#990000">p4
  669. submit</FONT></TT> the merge to complete the operation. Until that's done,
  670. you can <TT><FONT COLOR="#990000">p4 revert</FONT></TT> the changes (to
  671. deal with them <I>tomorrow</I>) or<TT><FONT COLOR="#990000"> p4 resolve
  672. -f&nbsp;</FONT></TT> the changes if you want a second chance at it.]</UL>
  673. &nbsp;
  674. <HR WIDTH="100%">
  675. <UL>
  676. <LI><A NAME="backups"></A>Checkpoint/Journal questions
  677. <p>
  678. <OL>
  679. <LI>
  680. <A name="whatischeckpoint"></A><B>What is a checkpoint?</B>
  681.  
  682. <P>
  683. A checkpoint is an human-readable&nbsp; file that contains all information
  684. necessary to recreate the Perforce databases but not the&nbsp; individual
  685. file revision contents.&nbsp; It's created by running the following
  686. command, replacing <i>P4ROOT</i> with the name of the Perforce server's
  687. root directory. (The <i>P4ROOT</i> directory is the one that the &quot;db.*&quot;
  688. files live in.) </P>
  689.  
  690. <DL>
  691. <PRE>&nbsp;<FONT COLOR="#990000">p4&nbsp;&nbsp;admin&nbsp;&nbsp;checkpoint</FONT></PRE>
  692. </DL>
  693. In older versions of Perforce that don't have the <tt>p4 admin</tt> subcommand:
  694. <DL>
  695. <PRE>&nbsp;<FONT COLOR="#990000">p4d&nbsp;&nbsp; -r&nbsp;&nbsp; <I>P4ROOT</I>&nbsp;&nbsp; -jc</FONT></PRE>
  696. </DL>
  697. <u>The administrator should always check the output of the command that
  698. created the checkpoint to make sure that there were no errors.</u>
  699. <p>
  700. <li>
  701. <A NAME="checkpointfrequency"></A><B>When do I make a checkpoint? How often should I checkpoint my database?&nbsp;&nbsp;</B>
  702. <p>
  703. This is your backup of the Perforce metadata, so it should be done
  704. &quot;regularly&quot;. (Probably every night or every other night is best - <U>at
  705. least once a week</U> unless you've analyzed the number of changes you
  706. make and believe that &quot;less often&quot; is appropriate.)&nbsp;
  707. <BR>&nbsp;
  708. <DL><I>Put the checkpoint and journal files and the backup of P4ROOT/depot
  709. on a different disk from the database!&nbsp;</I>&nbsp;
  710. <BR>&nbsp;</DL>
  711. Checkpoints are not created automatically: you must make checkpoints yourself,
  712. using &quot;at&quot; (on Windows/NT) or &quot;cron&quot; (on Unix).
  713. <p>
  714. <li>
  715. <A NAME="journals"></A><B>What's a journal file? What's it good for?&nbsp;</B>
  716. <p>
  717. In database parlance, the journal is the running transaction log that
  718. keeps track of all database modifications since the last checkpoint. It's the bridge between two checkpoints, and if you have Monday's
  719. checkpoint and the journal that was collected from then until Wednesday,
  720. those two files (as a unit) contain the same information as a checkpoint
  721. made Wednesday would contain. This is what makes it possible to restore
  722. the database to the most recently run transaction, instead of to
  723. the time of the last checkpoint operation.&nbsp;
  724.  
  725. <P><U>The journal is automatically enabled if you installed onto Windows/NT
  726. using the InstallShield installer, but not automatically enabled on any
  727. other platform.</U>&nbsp;
  728.  
  729. <P>If journalling is not enabled on your platform, or if you've
  730. disabled it at some point in the past, you can enable it easily.
  731. To enable journaling, run&nbsp;
  732. <BR><TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <FONT COLOR="#990000">p4&nbsp;
  733. set&nbsp; P4JOURNAL=fullpathname</FONT></TT>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  734. (on Windows/NT)&nbsp;
  735. <BR>or, on Unix, set the environment variable "P4JOURNAL" to a journal
  736. pathname prior to starting &quot;p4d&quot;. (There's a command-line argument, &quot;-J
  737. <I>journal</I>&quot;, that will set this, also. If you use the command-line
  738. way of setting the journal, you'll need to add that argument when you
  739. make a checkpoint.) In either case, you'll need
  740. to restart the Perforce server to enable this.&nbsp;
  741.  
  742. <P>The instructions to do this are in the Perforce manuals, but for reference,
  743. they are included here.
  744. <UL>
  745. <LI>
  746. to restore from a checkpoint, rename the db.* files and then run:</LI>
  747.  
  748. <BR><TT>&nbsp;&nbsp;&nbsp;&nbsp; <FONT COLOR="#990000">p4d&nbsp; -r&nbsp;<I>P4ROOT</I>&nbsp;
  749. -jr&nbsp; checkpoint-file</FONT></TT>&nbsp;
  750. <LI>
  751. to restore from the journal (immediately after restoring from a checkpoint):&nbsp;</LI>
  752.  
  753. <BR><TT>&nbsp;&nbsp;&nbsp;&nbsp; <FONT COLOR="#990000">p4d&nbsp; -r&nbsp;<I>P4ROOT</I>&nbsp;
  754. -jr&nbsp; journal-file</FONT></TT>&nbsp;
  755. <LI>
  756. to restore from both, rename the db.* files and then run:</LI>
  757.  
  758. <BR><TT>&nbsp;&nbsp;&nbsp;&nbsp; <FONT COLOR="#990000">p4d&nbsp; -r&nbsp;<I>P4ROOT</I>&nbsp;
  759. -jr&nbsp; checkpoint-file journal-file</FONT></TT></UL>
  760. (This operation can take several minutes to complete, depending on the
  761. size of the checkpoint/journal files.)
  762.  
  763. <P>Both the checkpoint-file and journal-file are made to be restored from
  764. exactly once, that is, you cannot restore from a checkpoint file and then
  765. try to restore <U>again</U> to the same &quot;db.*&quot; database files from that
  766. checkpoint - you'd have to move the db.* files out of the way first.
  767.  
  768. <p>
  769. <A NAME="checkpointfails"></A>
  770. <li><B>What do I do if the checkpoint of the database fails?&nbsp;</B>
  771. <p>
  772. It's probably best to stop the server, and contact
  773. <A HREF="mailto:support@perforce.com">Perforce Technical Support</A>.
  774. <p>
  775. That said, there could be several reasons that the
  776. checkpoint operation failed. Three possible cases follow:
  777. <ol>
  778. <li>
  779. You ran out of space on the device onto which the checkpoint data
  780. was written. This is an easy case: clean up the space issues and try
  781. the checkpoint operation again.
  782. <li>
  783. There was/is data corruption in the Perforce database itself. In this
  784. case, you'll need to talk with the Perforce Support folks. <u>If you
  785. have the most recent successful checkpoint and the journal that was made
  786. since then, you'll be able to restore the database easily.</u>
  787. <li>
  788. The disk on which the db.* files live died. In this case, you'll
  789. also want to talk to Perforce Support. The procedure to recover from
  790. that, they'll probably tell you, is to fix the disk errors and then
  791. restore from a checkpoint and the journal that's been kept since then.
  792. </ol>
  793. <p>
  794. <A NAME="backupstrategy"></A>
  795. <li><B>So if I make checkpoints and have journaling enabled, do I have a
  796. good backup strategy?&nbsp;&nbsp;</B>
  797. <p>
  798. Almost. The checkpoint+journal mechanism will protect your metadata,
  799. but the contents of each file's revisions are stored in subdirectories
  800. of the P4ROOT directory. Those should be backed up regularly, on the same
  801. schedule as the checkpoint file.&nbsp;
  802. </OL>
  803. </UL>
  804. <HR WIDTH="100%">
  805. <UL>
  806. <LI>
  807. <A NAME="machinedead"></A><B><FONT COLOR="#000000">If the machine
  808. on which the Perforce depot dies, what do we do? If it runs out of space
  809. on the depot filesystem, what do we do?</FONT></B></LI>
  810.  
  811.  
  812. <P><I><FONT COLOR="#000000">If the machine croaks...</FONT></I>
  813. <BR>&nbsp;
  814. <UL><FONT COLOR="#000000">If the machine croaks and you need to move the
  815. Perforce server to another machine, you'll need to take several easy steps
  816. (and one hard one):</FONT>
  817. <OL>
  818. <LI>
  819. <FONT COLOR="#000000"><B>Immediately send mail</B><I> </I>to <TT><A HREF="mailto:support@perforce.com">support@perforce.com</A></TT>
  820. asking for a license file for the replacement machine, unless it'll use
  821. the <U>same</U> IP address as the one that died. Include the IP address
  822. of the new machine, and be sure to stuff a $10 bill into the e-mail envelope.</FONT></LI>
  823.  
  824. <LI>
  825. <FONT COLOR="#000000">If you can get to the disk that has the depot files,
  826. copy them to the new machine. If not, read the section [below] about "what
  827. if the disk croaks?".</FONT></LI>
  828.  
  829. <LI>
  830. <FONT COLOR="#000000">Copy the new license file to the same directory as
  831. all the "db.*" files in the depot [on the new machine].</FONT></LI>
  832.  
  833. <LI>
  834. <FONT COLOR="#000000">Retrieve /etc/init.d/p4 from the old depot disk,
  835. if possible, and run </FONT><TT><FONT COLOR="#990000">/etc/init.d/p4 start</FONT></TT><FONT COLOR="#000000">.
  836. If that's not possible, set the variable P4ROOT and then run</FONT></LI>
  837.  
  838. <OL>
  839. <PRE><FONT COLOR="#990000">$P4ROOT/p4d -r $P4ROOT -p <U>1666</U></FONT></PRE>
  840. </OL>
  841. <FONT COLOR="#000000">Your site might use some other port number,
  842. like maybe 6999, and that'll go after the `-p' parameter.</FONT>
  843. <LI>
  844. <FONT COLOR="#000000">Send mail to your developers and make sure that they
  845. change $P4PORT in their environment (to point to a new machine) prior to
  846. using the client software.</FONT></LI>
  847. </OL>
  848. </UL>
  849. <I><FONT COLOR="#000000">If the disk croaks...</FONT></I>
  850. <BR>&nbsp;
  851. <UL>
  852. <OL>
  853. <LI>
  854. <FONT COLOR="#000000">Replace the disk, and restore the database from a
  855. backup using the checkpoint and journal files. (That's covered <A HREF="#whentobackup">above</A>,
  856. in the previous item.)</FONT></LI>
  857.  
  858. <LI>
  859. <FONT COLOR="#000000">Copy in a new license file, either obtained from
  860. <TT><A HREF="mailto:support@perforce.com">support@perforce.com</A></TT>
  861. or from an old backup.</FONT></LI>
  862.  
  863. <LI>
  864. <FONT COLOR="#000000">Restore the $P4ROOT/depot subdirectory from your
  865. backups.</FONT></LI>
  866.  
  867. <LI>
  868. <FONT COLOR="#000000">Start up the server with </FONT><TT><FONT COLOR="#990000">/etc/init.d/p4
  869. start</FONT></TT><FONT COLOR="#000000"> and stand back.</FONT></LI>
  870. </OL>
  871. </UL>
  872. <I><FONT COLOR="#000000">If the disk runs out of space...</FONT></I>
  873. <BR>&nbsp;
  874. <UL>
  875. <OL>
  876. <LI>
  877. If there wasn't database corruption, think seriously about moving $P4ROOT/depot
  878. to another disk and symlink'ing it or mounting it back.</LI>
  879.  
  880. <LI>
  881. If there was, call in your local Perforce admin-types. They'll want to
  882. restore from a checkpoint+journal combination. In this case, no data will
  883. be lost.</LI>
  884. </OL>
  885. </UL>
  886. </UL>
  887. &nbsp;
  888. <HR WIDTH="100%">
  889. <UL>
  890. <LI>
  891. <A NAME="who_has_opened"></A><B><FONT COLOR="#000000">How can
  892. I find out who has a particular file checked out?</FONT></B></LI>
  893.  
  894. <OL><FONT COLOR="#000000">The command </FONT><FONT COLOR="#990000">p4 opened</FONT><FONT COLOR="#000000">
  895. tells you what is opened on the current client.</FONT><FONT COLOR="#990000">
  896. p4 opened -a</FONT><FONT COLOR="#000000"> tells you what's opened on every
  897. client, so</FONT>
  898. <OL>
  899. <PRE><TT><FONT COLOR="#990000">p4 opened -a | grep <I>xxxxx</I></FONT></TT></PRE>
  900. </OL>
  901. <FONT COLOR="#000000">tells you every file that user <I><TT>xxxxx</TT></I>
  902. has checked out (along with all files named xxxxx that are opened.) In
  903. addition,</FONT>
  904. <OL>
  905. <PRE><TT><FONT COLOR="#990000">p4 opened -a&nbsp;&nbsp; <I>filename</I></FONT></TT></PRE>
  906. </OL>
  907. <FONT COLOR="#000000">tells you every client that has filename opened.</FONT></OL>
  908. </UL>
  909. &nbsp;
  910. <HR WIDTH="100%">
  911. <UL>
  912. <LI>
  913. <A NAME="newuser"></A><B><FONT COLOR="#000000">How do
  914. I add a new user?</FONT></B></LI>
  915.  
  916. <BR>&nbsp;
  917. <UL>
  918. <LI>
  919. To add a new user, just run a Perforce command as that user. It will attempt
  920. to add them to the list of Perforce users. However...</LI>
  921.  
  922. <LI>
  923. ... many sites use <FONT COLOR="#990000"><TT>p4 protect</TT>
  924. </FONT>to turn on/off access to codelines. It's important to run this command
  925. (as a perforce adminstrator) to grant permissions to the user.</LI>
  926. </UL>
  927. </UL>
  928.  
  929. <HR WIDTH="100%">
  930. <UL>
  931. <LI>
  932. <A NAME="p4protect"></A><B>What, exactly, does
  933. p4 protect do?</B></LI>
  934. </UL>
  935.  
  936. <UL>
  937. <OL>In short, it restricts what users can see what, and what IP addresses
  938. can access what codelines. Most of this should be left to the Perforce
  939. administrators, but a quite briefing on how to decode the <TT><FONT COLOR="#990000">p4
  940. protect</FONT></TT> output is:
  941. <OL><TT><FONT COLOR="#990000">d:\src\dev> p4 protect</FONT></TT>
  942. <BR><FONT COLOR="#990000"><TT>#&nbsp;&nbsp;&nbsp;&nbsp; </TT><I>comments
  943. deleted</I></FONT>
  944. <BR><TT><FONT COLOR="#990000">Protections:</FONT></TT>
  945. <OL><TT><FONT COLOR="#990000">super user root 207.82.17.* //depot/...</FONT></TT>
  946. <BR><TT><FONT COLOR="#990000">super user maggie 207.82.17.* //depot/...</FONT></TT>
  947. <BR><TT><FONT COLOR="#990000">super user maggie 206.14.136.34 //depot/...</FONT></TT>
  948. <BR><TT><FONT COLOR="#990000">super user brick 207.82.17.* //depot/...</FONT></TT>
  949. <BR><TT><FONT COLOR="#990000">super user brick 206.14.136.65 //depot/...</FONT></TT>
  950. <BR><TT><FONT COLOR="#990000">super user brick 209.185.70.* //depot/...</FONT></TT>
  951. <BR><TT><FONT COLOR="#990000">super user kevin 207.82.17.* //depot/...</FONT></TT>
  952. <BR><TT><FONT COLOR="#990000">super user stella 206.14.136.58 //depot/...</FONT></TT>
  953. <BR><TT><FONT COLOR="#990000">write user laurie 207.82.17.* //depot/...</FONT></TT>
  954. <BR><TT><FONT COLOR="#990000">write user carl 207.82.17.* //depot/dev/src/...</FONT></TT>
  955. <BR><TT><FONT COLOR="#990000">read user carl 206.14.136.44 //depot/dev/src030100b01/...</FONT></TT>
  956. <BR><TT><FONT COLOR="#990000">write user bigdaddy 207.82.17.* //depot/...</FONT></TT></OL>
  957. </OL>
  958. <FONT COLOR="#000000">The way to read this is:</FONT>
  959. <OL><TT><FONT COLOR="#990000"><I>permission&nbsp; </I>user<I>&nbsp; username&nbsp;&nbsp;
  960. IP-Address&nbsp;&nbsp;&nbsp; depot-pathname</I></FONT></TT></OL>
  961. <FONT COLOR="#000000">This means "this username, at this IP-Address,&nbsp;
  962. has the given permissions on files that match this "depot" pathname." So,
  963. for example:</FONT>
  964. <UL>
  965. <LI>
  966. <FONT COLOR="#000000">User "root" can do protected operations on the entire
  967. depot, but only from the internal company IP addresses. (Line 1)</FONT></LI>
  968.  
  969. <LI>
  970. <FONT COLOR="#000000">User "maggie" can do protected operations from
  971. the internal net and from his home IP address. (Lines 2-3)</FONT></LI>
  972.  
  973. <LI>
  974. <FONT COLOR="#000000">Carl can modify things in //depot/dev/src but can
  975. only read files in /depot/dev/src030100b01, and in that case, only from
  976. home.</FONT></LI>
  977. </UL>
  978. <FONT COLOR="#000000">By default, if the permission isn't explicitly granted
  979. in the "p4 protect" spec, it's denied completely to that user.</FONT>
  980.  
  981. <P>Note that this doesn't cover the mechanism added, in release 98.2, for
  982. "groups". That's covered in the manual.&lt;</OL>
  983. </UL>
  984. &nbsp;
  985. <HR WIDTH="100%">
  986. <UL>
  987. <LI>
  988. <A NAME="security"></A><B><FONT COLOR="#000000">how do
  989. I handle security? (i.e. adding new IP address using p4 protect)</FONT></B></LI>
  990.  
  991.  
  992. <P><I><FONT COLOR="#000000">At WebLogic...</FONT></I>
  993. <BR>&nbsp;
  994. <OL><FONT COLOR="#000000">Some places use </FONT><TT><FONT COLOR="#990000">p4
  995. protect</FONT></TT><FONT COLOR="#000000"> to limit what branches are visible
  996. to what IP addresses. For example, the main codeline is restricted to engineers
  997. who are on the internal network or dialing in from home on dedicated IP
  998. addresses - the output of</FONT>
  999. <UL>
  1000. <PRE><FONT COLOR="#990000">p4 protect</FONT></PRE>
  1001. </UL>
  1002. <FONT COLOR="#000000">at this company is something like this:</FONT>
  1003. <UL><TT><FONT COLOR="#990000">super maggie 209.14.136.34 //depot/dev/src030100b01/...</FONT></TT>
  1004. <BR><TT><FONT COLOR="#990000">super brick 209.82.17.* //depot/dev/src030100b01/...</FONT></TT>
  1005. <BR><TT><FONT COLOR="#990000">write stella 209.82.17.* //depot/...</FONT></TT>
  1006. <BR><TT><FONT COLOR="#990000">write stella 203.14.136.58 //depot/...</FONT></TT>
  1007. <BR><TT><FONT COLOR="#990000">write * * -//depot/dev/src/tutorial/...</FONT></TT></UL>
  1008. In this case, "stella" has write permission from internal IP addresses (209.82.17.*)
  1009. and from the one IP address he uses to connect to, from home (203.14.136.58).&nbsp;
  1010. In any case, write permission is disabled from all IP addresses ("*") for
  1011. the directory "//depot/dev/src/tutorial".
  1012.  
  1013. <P>The model is that we completely restrict access to anyone not explicitly
  1014. granted access via "<FONT COLOR="#990000">p4 protect</FONT>". (Normally,
  1015. Perforce doesn't require this - it was a decision made based on having
  1016. people connect to Perforce from outside the internal net.)
  1017. <BR>&nbsp;
  1018. <BR>(The above IP addresses aren't the real IP addresses used at WebLogic,
  1019. so anyone editing this FAQ should avoid "fixing" this.)
  1020.  
  1021. <P>If you cannot "<FONT COLOR="#990000">p4 sync</FONT>" some files to the
  1022. top revision, it could be that permissions haven't been granted for that
  1023. user.
  1024. <BR>&nbsp;</OL>
  1025. <I><FONT COLOR="#000000">Anywhere else...</FONT></I>
  1026. <BR>&nbsp;
  1027. <OL>Read <A HREF="http://www.perforce.com/perforce/doc.973/cmdguide/html/protecti.htm">here</A>
  1028. carefully. The most important details are:
  1029. <UL>
  1030. <LI>
  1031. There's no easy&nbsp; way to include comments in the "p4 protect" maps.
  1032. We've used the following syntax to include comments:</LI>
  1033.  
  1034. <OL>
  1035. <PRE>write * * -//depot/comment/***
  1036. write * * -//depot/comment/***_1a_remove_the_permissions_for_frozen_branches_here
  1037. write * * -//depot/comment/***</PRE>
  1038. </OL>
  1039.  
  1040. <LI>
  1041. <U>Order in the <FONT COLOR="#990000">p4 protect </FONT>specification is
  1042. significant</U>. The first permissions granted can be overridden by later
  1043. specs, so "less is more".</LI>
  1044.  
  1045. <BR>If you need real security, since it's far to easy to masquerade as
  1046. another user (but far harder to masquerade as another IP address!) try
  1047. to run one of the SSL mechanisms for Perforce work.</UL>
  1048. </OL>
  1049. </UL>
  1050.  
  1051. <HR WIDTH="100%">
  1052. <UL>
  1053. <LI>
  1054. <A NAME="offlineback"></A><B><FONT COLOR="#000000">How
  1055. do I bring an off-line worker back online</FONT></B></LI>
  1056. </UL>
  1057.  
  1058. <UL><FONT COLOR="#000000">Run </FONT><TT><FONT COLOR="#990000">p4 help
  1059. diff</FONT></TT><FONT COLOR="#000000"> to see what commands there are to
  1060. compare someone's local disk area to what Perforce thinks was originally
  1061. there. In particular, the following commands can be really helpful for
  1062. finding what files the developer's modified while disconnected:</FONT>
  1063. <BR>&nbsp;
  1064. <UL>
  1065. <PRE><FONT COLOR="#990000">cd [workspace root]
  1066. find . -type f -print | p4 -x - add
  1067. p4 diff -se ... | p4 -x - edit
  1068. p4 diff -sd ... | p4 -x - delete</FONT></PRE>
  1069. </UL>
  1070. <I><FONT COLOR="#000000">Note that the "</FONT><FONT COLOR="#990000">p4
  1071. -x - add</FONT><FONT COLOR="#000000">" will generate errors for files that
  1072. are already in Perforce - that's okay.</FONT></I>
  1073.  
  1074. <P><FONT COLOR="#000000">[Aside: users should be told to "never run 'chmod'
  1075. or 'rm' on a file that Perforce gave you unless you're disconnected".]</FONT></UL>
  1076. &nbsp;
  1077. <HR WIDTH="100%">
  1078. <UL>
  1079. <LI>
  1080. <A NAME="p4unsubmit"></A><B><FONT COLOR="#000000">How
  1081. do I "unsubmit" a changelist?&nbsp;<A NAME="p4modifychangelist"></A>How
  1082. do I "unsubmit" files stuck in a *pending* changelist?</FONT></B></LI>
  1083.  
  1084.  
  1085. <P><FONT COLOR="#000000">If you have a file associated with <U>pending</U>
  1086. change #12345, you have several options:</FONT>
  1087. <UL>
  1088. <LI>
  1089. <FONT COLOR="#000000">Run the resolve command (or whatever the operation
  1090. was that prevented the submission from completing) and then run</FONT></LI>
  1091.  
  1092. <UL>
  1093. <PRE><FONT COLOR="#990000">p4 submit -c 12345</FONT></PRE>
  1094. </UL>
  1095.  
  1096. <LI>
  1097. <FONT COLOR="#000000">Revert the individual files if you want to discard
  1098. the changes, then delete the change. One such example is...</FONT></LI>
  1099.  
  1100. <UL>
  1101. <PRE><FONT COLOR="#000000">D:\src></FONT><B><FONT COLOR="#990000">p4 describe -s 12345</FONT></B></PRE>
  1102.  
  1103. <PRE><FONT COLOR="#000000">Change 12345 by karena@karena.ave5 on 1998/04/16 14:44:05 *pending*</FONT></PRE>
  1104.  
  1105. <UL>
  1106. <PRE><FONT COLOR="#000000">fixed links</FONT></PRE>
  1107. </UL>
  1108.  
  1109. <PRE><FONT COLOR="#000000">Affected files ...</FONT></PRE>
  1110.  
  1111. <PRE><FONT COLOR="#000000">... //depot/internal/support/baystone/glossary.html#7 edit</FONT></PRE>
  1112.  
  1113. <PRE><FONT COLOR="#000000">D:\src></FONT><B><FONT COLOR="#990000">p4 revert&nbsp; //depot/internal/support/baystone/glossary.html</FONT></B></PRE>
  1114.  
  1115. <PRE><FONT COLOR="#000000">D:\src></FONT><B><FONT COLOR="#990000">p4 change -d 12345</FONT></B></PRE>
  1116. </UL>
  1117. <FONT COLOR="#000000">(The output above is somewhat contrived, and might
  1118. not be exactly what "</FONT><FONT COLOR="#990000">p4 describe</FONT><FONT COLOR="#000000">"
  1119. might've produced in this situation. The important parts - the "pending"
  1120. state, the change number, and the file list, should be close enough to
  1121. use this as an example.)</FONT>
  1122. <LI>
  1123. <FONT COLOR="#000000">Assign the files to another new change using</FONT><FONT COLOR="#990000">
  1124. p4 change </FONT><FONT COLOR="#000000">and </FONT><FONT COLOR="#990000">p4
  1125. reopen</FONT><FONT COLOR="#000000">:</FONT></LI>
  1126.  
  1127. <UL>
  1128. <PRE><FONT COLOR="#000000">D:\src></FONT><FONT COLOR="#990000">p4 change</FONT></PRE>
  1129. <I><FONT COLOR="#000000">(lots of edits of the change description, saving
  1130. the output in the editor. Let's assume that the change number that it created
  1131. was change #34346.)</FONT></I>
  1132. <PRE><FONT COLOR="#000000">D:\src></FONT><FONT COLOR="#990000">p4 reopen -c 34343&nbsp; <B>//depot/internal/support/baystone/glossary.html</B></FONT></PRE>
  1133. </UL>
  1134.  
  1135. <PRE><FONT COLOR="#000000">Of course, you'll still want to delete that pending change at some point.</FONT></PRE>
  1136. </UL>
  1137. </UL>
  1138.  
  1139. <PRE>
  1140. <HR WIDTH="100%"></PRE>
  1141.  
  1142. <UL>
  1143. <LI>
  1144. <A NAME="backupworkspace"></A><B><FONT COLOR="#000000">Should
  1145. I back up clients? If so, what files should I back up and what files should
  1146. I keep? How long should I keep backups of clients?</FONT></B></LI>
  1147.  
  1148.  
  1149. <P><U><FONT COLOR="#000000">This is specific to each company that implements
  1150. Perforce.</FONT></U>
  1151.  
  1152. <P><I><FONT COLOR="#000000">Back up the depot itself...</FONT></I>
  1153. <BR>&nbsp;
  1154. <UL><FONT COLOR="#000000">The most important thing to back up is the Perforce
  1155. depot, which is a set of three&nbsp; things: the checkpointed database,&nbsp;
  1156. the subdirectory (called "depot") that stores each revision of each file
  1157. that Perforce is managing, and the license file.</FONT>
  1158. <BR>&nbsp;</UL>
  1159. <I><FONT COLOR="#000000">If your Perforce Adminstrators are on the ball...</FONT></I>
  1160. <BR>&nbsp;
  1161. <UL><FONT COLOR="#000000">The information to recreate products should be
  1162. stored as files in Perforce, and the release <U>should</U> be recreateable
  1163. using only the files in Perforce. The "label" information is stored in
  1164. the Perforce databases (and hence, is in the backed-up checkpoint file),
  1165. so releases <U>should</U> be safe.</FONT>
  1166. <BR>&nbsp;</UL>
  1167. <I><FONT COLOR="#000000">But should I back up a Perforce client?</FONT></I>
  1168. <BR>&nbsp;
  1169. <OL>
  1170. <LI>
  1171. <FONT COLOR="#000000">Strictly speaking, it should not be necessary if
  1172. developers check in work frequently.</FONT></LI>
  1173.  
  1174. <LI>
  1175. <FONT COLOR="#000000">That said, it probably makes sense to archive the
  1176. Perforce client area that generates a release that's sent to customers,
  1177. so that when a patch needs to be made it can be built from <B>exactly the
  1178. same source and object files</B> that created the original release. (You
  1179. don't want to <U>have</U> to recompile everything to send out a patch,
  1180. unless you're regressing everything in sight. Compilers might've changed,
  1181. machine environments might've changed. Why borrow trouble?)</FONT></LI>
  1182. </OL>
  1183. <I><FONT COLOR="#000000">So I don't need to back up any Perforce clients
  1184. except my build clients?</FONT></I>
  1185. <BR>&nbsp;
  1186. <UL><FONT COLOR="#000000">Talk to your local Perforce Administrator-types.
  1187. They'll have an opinion on this, we can assure you.</FONT></UL>
  1188. </UL>
  1189. <BR><I>Last modified on 21 September 1998.</I>
  1190.  
  1191. </BODY>
  1192. </HTML>
# Change User Description Committed
#1 5415 michael Move user FAQ to //guest branch and provide pointers.
Remove old branching FAQ.
Update p...age to reference Perforce Software documentation. «		 19 years ago
//public/perforce/faq/admin.html
#6 3865 Jeff Bowles Minor changes to include comments on 'p4 admin' 21 years ago
#5 1959 Jeff Bowles Minor hacks to clean up links. 23 years ago
#4 112 Laura Wingerd Publish "Branching FAQ"
(pull in changes from //guest/laura_wingerd/perforce/faq/... ) 		26 years ago
#3 68 Jeff Bowles Updating to pull out some Weblogic-isms 26 years ago
#2 21 Jeff Bowles Moving a lot of checkpoint/journal questions into here. 26 years ago
#1 1 laura Add FAQs.
(Still needs index page.) 		26 years ago