Helix SwarmHelix Swarm

README.html

  • //
  • guest/
  • fredric_fredricson/
  • P4DB/
  • main/
  • README.html #13
  • View
  • Commits
  • Open Download .zip Download (25 KB) 
  1. <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
  2. <html>
  3. <head>
  4.    <meta http-equiv="Content-Type" 
  5.             content="text/html; charset=iso-8859-1">
  6.  
  7.    <meta    name="Generator"
  8.          content="Emacs (text editor)">
  9.  
  10.    <meta    name="Author"             
  11.          content="fredric@mydata.se">
  12.  
  13.    <meta    name="Description" 
  14.          content="Information on how to install and maintain P4DB">
  15.  
  16. 	    <title>Administrators README file for P4DB</title>
  17.  
  18. <style TYPE="text/css"><!--
  19. body {
  20.     font-family:      Arial, Helvetica, SanSerif, SansSerif, Sans-Serif ;
  21.     font-size: 10pt ;
  22.     background-color: #e0e0ff ;
  23. }
  24. body.p4dbreadme {
  25.     font-family:      Arial, Helvetica, Sans-Serif ;
  26.     font-size: 10pt ;
  27.     background-color: white ;
  28. }
  29. h3.p4dbreadme ,h4.p4dbreadme {
  30.     margin-right: 20pt ; 
  31. }  
  32. h1.p4dbreadme {
  33.     font-size: 16pt ;
  34.     font-weight: bold ;
  35.     text-align: center ;
  36. }
  37. h2.p4dbreadme  {
  38.     font-size: 14pt ;
  39.     font-weight: bold ;
  40.     margin-left: 0pt ;
  41. /*    border-top: solid 2pt #e0e0e0;*/
  42. /*    border-left: solid 2pt #e0e0e0;*/
  43.     padding-top: 4pt ;
  44.     padding-left: 4pt ;
  45. }
  46. h3.p4dbreadme  {
  47.     font-size: 12pt ;
  48.     margin-left: 6pt ;
  49.     font-weight: normal ;
  50.     text-decoration: underline ;
  51. }
  52. h4.p4dbreadme {
  53.     font-size: 10pt ;
  54.     font-weight: normal ;
  55.     margin-left: 16pt ;
  56.     text-decoration: underline ;
  57. }
  58. ul.Norm, ol.Norm, dl.Norm { 
  59.     margin-left: 20pt ;
  60.     margin-right: 20pt ;
  61. }
  62. dt.Norm {
  63.     text-decoration: underline ;
  64. }
  65. P.Norm {
  66.     margin-left: 20pt ;
  67.     margin-right: 20pt ;
  68. }
  69. P.Note {
  70.     margin-left: 30pt;
  71.     margin-right: 30pt ;
  72.     background-color: #FFE0E0 ;
  73.  }
  74. .TOC {
  75.     margin-left: 40pt ;
  76. }
  77. --></style>
  78. </head>
  79. <body class="p4dbreadme">
  80.  
  81. <!-- *************************************************************************** -->
  82. <h1 class="p4dbreadme">Administrators README for P4DB Version 4.0</h1>
  83.  
  84. <!-- --------------------------------------------------------------------------  -->
  85. <h2 class="p4dbreadme">Introduction</h2>
  86.  
  87. <P Class="Norm">
  88.     This is a README for P4DB, a CGI based p4 depot browser written by
  89.     Fredric Fredricson (<a href="mailto:Fredric.Fredricson@bonetmail.com">fredric@mydata.se</a>)
  90. <P Class="Norm">
  91.     The graphic "Branch Relationships" page is written by <b>Todd Short</b> 
  92.     (see Todd's <A href="branchGraph.readme.txt">readme file</A>). <br>
  93.     More credits <A href="#Credits">at the end</A>.
  94. </P>
  95. <P Class="Norm">The README
  96.     is intended for administrators and others that want to install, maintain,
  97.     and possibly contribute to, P4DB.
  98. </P>
  99.  
  100. <!-- --------------------------------------------------------------------------  -->
  101. <h2 class="p4dbreadme">Table Of Contents</h2>
  102. <P Class=TOC>
  103. <ul class=TOC>
  104. <li>
  105. <a href="#About">About</a>
  106.  
  107. <li>
  108. <a href="#Software">Software Requirements</a>
  109.  
  110. <li>
  111. <a href="#Supported_platforms">Platforms and Compatibility</a>
  112.  
  113. <li>
  114. <a href="#Installation">Installation and Configuration</a>
  115.  
  116. <li>
  117. <a href="#Known">Known Bugs</a>
  118.  
  119. <li>
  120. <a href="#Diffs">What's New</a>
  121.  
  122. <li>
  123. <a href="#Licensing">Licensing</a>
  124.  
  125. <li>
  126. <a href="#Warranty">Warranty</a>
  127.  
  128. <li>
  129. <a href="#Contrib">Would You Like To Contribute?</a>
  130.  
  131. <li>
  132. <a href="#Doc">Design Documentation</a>
  133.  
  134. <li>
  135. <a href="#Credits">Credits</a>
  136.  
  137. </ul>
  138. </P>
  139.  
  140.  
  141. <!-- --------------------------------------------------------------------------  -->
  142. <a NAME="About"></a>
  143. <h2 class="p4dbreadme">About</h2>
  144.  
  145. <P Class="Norm">
  146.  
  147.     P4DB is designed to provide a user friendly and intuitive
  148.     interface to the p4 depot. Information is presented using a web
  149.     browser and most pages combine output from two or more p4
  150.     commands. <br>
  151.     The driving force behind the development has been my needs as a
  152.     manager for a software team, the needs for our project leaders to
  153.     document changes in the code line and the need for our programmers 
  154.     to analyze changes in the code line (and most important, of
  155.     course, the need for me as a frustrated software engineer promoted
  156.     to my level of incompetence to get my hands on a nice little
  157.     programming project). 
  158.  
  159. <P Class="Norm">
  160.     The browser is written in perl and developed on a Linux/Apache
  161.     system and has been tested mainly with Firefox although some of
  162.     our users use MS Explorer and no problems has been reported. 
  163.  
  164. <h3 class="p4dbreadme">Why P4DB?</h3>
  165.  
  166. <P Class="Norm">
  167.     P4DB is inspired by a depot browser, perfbrowse.perl,
  168.     made available by
  169.     <a href="http://www.perforce.com">Perforce</a> at 
  170.     <a href="http://www.perforce.com/perforce/loadsupp.html#browse">
  171.     http://www.perforce.com/perforce/loadsupp.html#browse</a>
  172.     Perfbrowse.perl is written in perl and the author is unknown to
  173.     me.
  174.  
  175. <P Class="Norm">
  176.     The idea is also stolen so I can't claim that one.
  177.  
  178. <P Class="Norm">
  179.     I liked perfbrowse.perl very much but wanted just a little more
  180.     functionality. I started to add functionality and it quickly got
  181.     out of hand. Soon I had a huuuge perl script that I could no
  182.     longer maintain. Once I realized that I can write a perl script
  183.     that is about 2-4 times the size of the script that I can maintain
  184.     I decided to rewrite it all from the start as a set of small,
  185.     maintainable, perl scripts. I leave to others to judge if I
  186.     succeeded in my mission. 
  187. <br>
  188.    <i>(Maybe I should mention that it took much more time than I
  189.        anticipated).</i> 
  190.  
  191.  
  192. <!-- --------------------------------------------------------------------------  -->
  193. <a NAME="Software"></a>
  194. <h2 class="p4dbreadme">Software requirements</h2>
  195.  
  196. <P Class="Norm">
  197.     P4DB version 4.0 requires:
  198.      <UL Class="Norm">
  199.     <li>
  200.         Perl 5.004 or newer with the CGI.pm and GD.pm modules
  201. 	installed.
  202. 	 <br>
  203. 	The CGI.pm module can be downloaded from 
  204. 	<a href="http://www.cpan.org/">http://www.cpan.org/</a>
  205. 	<A href="http://search.cpan.org/search?dist=CGI.pm">(link to
  206. 	CGI.pm)</A>.
  207. 	<br>
  208. 	The gd library is available at 
  209. 	<A href="http://www.boutell.com/gd">http://www.boutell.com/gd</A> 
  210. 	and the GD.pm module at <A
  211. 	href="http://stein.cshl.org/WWW/software/GD/GD.html">
  212. 	http://stein.cshl.org/WWW/software/GD/GD.html</A>
  213. 	<hr>
  214.     <li>
  215.         A http server that supports CGI:s. Apache
  216. 	will do just fine.
  217. 	<hr>
  218.     <li>
  219.         P4 server 2004.2 or later.
  220.     </UL>
  221. </P>
  222.  
  223. <!-- --------------------------------------------------------------------------  -->
  224. <a NAME="Supported_platforms"></a>
  225. <h2 class="p4dbreadme">Supported platforms and compatibility</h2>
  226.  
  227. <P Class="Norm">
  228.     There is no real "list of supported platforms" simply because
  229.     there is no real support for P4DB. I just write it, test it a little, and
  230.     release it. 
  231.     
  232. <P Class="Norm">
  233.     <b>Http server:</b>
  234.     <br>
  235.         P4DB is developed on a Linux box running Fedora Core 3 and Apache,
  236. 	runs in production on RedHat 7.2/Apache, and has been reported
  237. 	to run on SUN/Solaris and NT/IIS platforms as well. The NT
  238. 	platform require MKS toolkit or similar and some tweaking,
  239. 	though.
  240. <P Class="Norm">
  241.     <b>Browser:</b>
  242.     <br>
  243.         All development work is done using FireFox version 1.0 (preview)
  244. 	but I usually perform some basic testing with MS-Explorer and sometimes 
  245. 	Netscape.
  246. 	P4DB should work with a recent browser with reasonable
  247. 	support for CSS (Cascaded Style Sheets) and
  248. 	javascript.
  249.     <br>
  250. 	P4DB is <u>not</u> designed for character mode browsers such
  251. 	as Lynx. 
  252.     <br>
  253.         And, by the way, the P4DB use cookies. Without cookies enabled you will
  254. 	not even be able to log in to P4DB. 
  255.  
  256. <!-- --------------------------------------------------------------------------  -->
  257. <a NAME="Installation"></a>
  258. <h2 class="p4dbreadme">Installation and configuration</h2>
  259. <P Class="Norm">
  260.     NOTE: This installation description assumes that the reader is
  261.     familiar with http servers, cgi scripts and, to a small degree,
  262.     perl.  
  263.  
  264. <h3 class="p4dbreadme">First: Where to install</h3>
  265. <P Class="Norm">
  266.     Other than the obvious, that is somewhere in a http servers CGI
  267.     path, I recommend you to set up a http server on your p4 server
  268.     and run P4DB on that server. The main reasons are that it improves
  269.     response time and reduce network load.
  270.  
  271. <h3 class="p4dbreadme">How to install</h3>
  272.  
  273.     <P Class="Norm">
  274.     If you use Linux and downloaded the tarball (that is, not the zip-file) you 
  275.     can follow the instructions below. If not, go to "Installation without <tt>install.pl</tt>"
  276.     <ol Class="Norm">
  277.         <li>
  278. 	    You obviously got to this README. Together
  279. 	    with README.html file you got:
  280. 	    <ul>
  281. 	        <li><tt>install.pl</tt>
  282. 		<li><tt>cgi_files.tar</tt>
  283. 		<li><tt>P4CGI.html</tt>
  284. 		<li><tt>P4DB.conf.txt</tt>
  285. 	    </ul>
  286. 	    Move all these files together with <tt>README.html</tt>
  287. 	    to the cgi-bin directory used by the web server or wherever
  288. 	    you want P4DB installed. Or you could just move the original 
  289. 	    tarball or zip archive and unpack it. 
  290. 	<li>
  291. 	    Type "<tt>perl install.pl</tt>" To install
  292. 	    all scripts.
  293. 	    <br>
  294. 	    Install.pl will unpack all cgi scripts
  295. 	    and modifies the first line to contain the path to perl.
  296. 	    <br>For details, see the <tt><a href="install.pl">install.pl</a></tt>
  297. 	    script.
  298. 	<li>
  299. 	    The file <tt>index.cgi</tt> is the start page
  300. 	    for P4DB. Create your links to it..
  301.     </ol>
  302.     
  303.     <P Class="Norm">
  304.     This is the theory, at least. I have not tested
  305.     it on many systems
  306.  
  307.     <h4 class="p4dbreadme">Installation without <tt>install.pl</tt></h4>
  308.  
  309.     <P Class="Norm">
  310.         If <tt>install.pl</tt> don't work
  311. 	for you here is what it does that you need to do manually:
  312. 	<ol Class="Norm">
  313. 	    <li>
  314. 	        Verify that perl and the perl module CGI.pm
  315. 		is available
  316. 	    <li>
  317. 	        Unpack cgi_file.tar (<tt>tar -xf cgi_files.tar</tt>) or
  318. 		cgi_file.zip
  319. 	    <li>
  320. 	        Find path to perl
  321. 	    <li>
  322. 	        Change first line of every file with extension
  323. 		".cgi", ".pl" or ".perl" to contain correct path to perl
  324. 	</ol>
  325.     </blockquote>
  326.  
  327.     <h3 class="p4dbreadme">How to configure</h3>
  328.  
  329.     <h4 class="p4dbreadme">Basic configuration</h4>
  330.  
  331.     <P Class="Norm">
  332.         The basic configuration file is named P4DB.conf. The file 
  333. 	is not included in the package but a sample configuration
  334. 	file called <tt><a href="P4DB.conf.txt">P4DB.conf.txt</a></tt> is.
  335.     <p class=Norm>
  336.  	Copy the file P4DB.conf.txt to P4DB.conf
  337. 	and modify it. The instructions are included in the file.
  338.     <p class=Norm>
  339.         Each p4 user that should be able to use P4DB must have at least read
  340. 	access from the machine that P4DB runs on to the parts of the depot he/she
  341. 	should have access to through P4DB.
  342. 	P4 groups may come in handy here.
  343. 	
  344. <a NAME="SecurityNote1"></a>
  345.        <P class=Note>
  346. 	    <B>Security Note 1:</B><br> P4DB asks for a p4 user to access
  347. 	    the depot. <b>It is wise to give users read priviliges
  348. 	    only on the P4DB host.</b> This protects the depot from
  349. 	    errors in P4DB that <u>might</u> affect the depot status.
  350.  
  351.        <P class=Note>
  352. 	    <B>Security Note 2:</B><br> P4DB does not provide any strong access
  353. 	    protection or other security. It is not possible to modify
  354. 	    the depot using P4DB so poorly trained or inexperienced
  355. 	    operators should not be able to damage the depot.
  356.  
  357. <a NAME="SecurityNote3"></a>
  358.        <P class=Note>
  359. 	    <B>Security Note 3:</B><br> 
  360. 	    During the login procedure the p4 user name and password are
  361. 	    transmitted unencrypted over the network. 
  362. 	    If this is not acceptable you should use the SSL (Secure Sockets Layer)
  363. 	    and TLS (Transport Layer Security) protocols. 
  364. 	    Unfortunately I am not an expert in these matters and can not
  365. 	    give you any help here other than point you to the 
  366. 	    <a href="http://httpd.apache.org/docs-2.0/mod/mod_ssl.html">mod_ssl module documentation</a>
  367. 	    in Apache.
  368.  
  369. 	<p class="Norm">
  370. 	I also recommend that you read the <a href="#Warranty">Warranty</a>-paragraph.
  371.  
  372.     <h4 class="p4dbreadme">Configure file types (for viewers)</h4>
  373.         <P Class="Norm">
  374.         P4DB will let users view some file types using applications
  375. 	like MS-Word for Word-file etc.  This can be configured in a
  376. 	file <a href="viewConfig.pm">viewConfig.pm</a>.  Default will
  377. 	let you view HTML, gif, jpeg, MS-Word, MS-Powerpoint, and
  378. 	Acrobat (PDF) formats.  See file <a href="viewConfig.pm">
  379. 	viewConfig.pm</a> for details.
  380.  
  381. <!-- --------------------------------------------------------------------------  -->
  382. <a NAME="Known"></a>
  383. <h2 class="p4dbreadme">Known bugs</h2>
  384.  
  385.     <P Class="Norm">
  386.     <ul Class="Norm">
  387.     <li>
  388.         A serious case of Feature Bloat.
  389.     </ul>	
  390.  
  391.  
  392. <!-- --------------------------------------------------------------------------  -->
  393. <a NAME="Diffs"></a>
  394. <h2 class="p4dbreadme">Diffs between versions</h2>
  395.  
  396.     <h4 class="p4dbreadme">New to P4DB 4.0:</h4>
  397.  
  398.     <dl class="Norm">
  399.     <dt class="Norm">Added a login page
  400.         <dd>P4DB now requires the user to log in and supply a p4 user and a password. 
  401.          See also <a href="#SecurityNote3">Security Note 3</a>
  402.     <dt class="Norm">Require 2004.2
  403.         <dd>P4DB require both the client and server to be of version 2004.2 or newer.
  404. 	The reason for this is that P4DB use the ticket based authentication introduced in
  405. 	this release.
  406.     </dl>
  407.  
  408.     <h4 class="p4dbreadme">New to P4DB 3.1:</h4>
  409.     <p class="Norm">
  410.     P4DB 3.1 is a frame-less version of 3.0. The frame stuff was not appreciated
  411.     by the users at all. The main problem was that 
  412.     it made it difficult to take the URL and slap it in an email to another
  413.     developer to point something out, something the users do frequently.
  414.     <p class="Norm">    
  415.     Another thing that really killed the frame based solution was the (wonderful!) 
  416.     tabs in Netscape 7 and other Mozilla-based browsers. No doubt the next version
  417.     of MS-Explorer will have some similar feature if they have the slightest clue
  418.     in Redmond. With frames the "open in new tab"-feature became somewhat awkward.
  419.     <p class="Norm">    
  420.     Apart from the above the follwing things have changed:
  421.     <dl class="Norm">
  422.     <dt class="Norm"> The "p4 annotate" command is used to view files.
  423.         <dd>The "annotate" command provides a nice view of a complete file history.
  424. 	Previous versions of P4DB did part of this using the p4pr.perl script written 
  425. 	by Bob Sidebotham, but the "p4 annotate" provides more info. Thank you, Perforce.
  426.     <dt class="Norm"> The header comes in two flavours, pulldown menues and buttons. 
  427.         <dd>The pulldown menues or buttons are used to select page. The pulldown menu
  428. 	use less space but Explorer does not display all menu options (you have to scroll)
  429. 	and this makes buttons more convenient. The user selects in the User Preferences
  430. 	page.
  431.     <dt class="Norm"> The user can specify start page.
  432.         <dd>The script "index.cgi" does not really display anything, it only forwards
  433. 	the user to the start page. Default is "intro.cgi" but the user can modify this
  434. 	using a button in the page header.
  435.     <dt class="Norm"> A few other small improvements..
  436.         <dd>I have made some small improvements to the branch and label views and to
  437. 	quite a few other pages as well.
  438.         
  439.     </dl>
  440.     
  441.  
  442.     <h4 class="p4dbreadme">New to P4DB 3.0:</h4>
  443.     <p class="Norm">
  444.     P4DB is, again, completley rewritten (well.. almost) only this
  445.     time I did not add much functionality other than a completley
  446.     different user interface that I hope will be more efficient.
  447.     <P class=Note>
  448.     	NOTE! Configuration file for 2.1 not compatible with 3.0.
  449.     <p class="Norm">
  450.     Here are a few of the changes:
  451.     <dl Class="Norm">
  452.     <dt class="Norm">User defined "shortcuts"
  453.         <dd>A user can define her own personal "shortcuts". Pretty
  454.         much like browser bookmarks/favorites only bookmarks
  455.         can not really be used for a frame-based web applications.
  456.     <dt class="Norm">Graphic "Branch Relationships" page.
  457.         <dd>Displays branch relationships in a graph. Contributed by
  458.         Todd Short. Requires the GD.pm perl module.
  459.     <dt class="Norm">Next and previous keys in change view
  460.         <dd>When you view a change there are next and previous links
  461.         that displays next and previous changes. If you entered the
  462.         page asking for changes for a specific path in the depot the
  463.         next and previous links will follow this path.
  464.     <dt class="Norm">(Almost) all formatting done in CSS
  465.         <dd>Output formatting is specified in a CSS file (P4DB.css).
  466.     <dt class="Norm">Full descriptions are always shown
  467.         <dd>Change descriptions are never displayed in a truncated
  468.         form (in 2.1 displaying a full change description was
  469.         sometimes an option).
  470.     <dt class="Norm">Removed "shortcut files"
  471.         <dd>P4DB 2.1 had some optional "shortcut files" that the
  472.         administrator could specify. They are gone. I never liked the
  473.         idea myself (even though it was mine).
  474.     <dt class="Norm">Java browswer no longer part of P4BD
  475.         <dd>The Java browser was optional and never really well
  476.         integrated with P4DB. 
  477.     </dl>
  478.     
  479.     <h4 class="p4dbreadme">New to P4DB 2.1:</h4>
  480.     <dl Class="Norm">
  481.     <dt class="Norm">Better support for jobs and fixes
  482.         <dd><ul>
  483. 	    <li>The file log page contains a "Fixes" section that list
  484. 	        closed jobs related to this file.
  485. 	    <li>The Depot Tree Browser page contains a link to view
  486. 	        jobs related to files below current position.
  487. 	    <li>Improved the job list
  488. 	    </ul>
  489.     <dt class="Norm">Works for p4 2001.1
  490.         <dd>There is a nice feature in 2001.1 that P4DB use to make
  491.         label cross reference in file log page much, much faster.
  492.     <dt class="Norm">Warning levels for unused users and clients in P4 Users and
  493.         groups page configurable
  494.         <dd>The warning level are set in the configuration file
  495.     <dt class="Norm">&quot;#include&quot; in c-files links to file search
  496.         <dd>The colorC.pl script makes #includes links to file search cgi. (Silly 
  497. 	    feature that was easy to implement)
  498.     <dt class="Norm">Warning level for unused users and clients configurable.
  499.         <dd>The user and client lists will print a warning next to users and clients 
  500. 	    that has not been accessed for a number of weeks. This number is now
  501. 	    configurable in <tt>P4DB.conf</tt>.
  502.     </dl>
  503.     <h4 class="p4dbreadme">New to P4DB 2.01:</h4>
  504.     <dl Class="Norm">
  505.     <dt class="Norm">Works for p4 2000.2beta
  506.         <dd>The jobspec command was changed and now P4DB understands
  507.         both 2000.2beta as well as 2000.1 thru 98.2.
  508.     <dt class="Norm">Works for p4 2000.1
  509.         <dd>The depot statistics did not work properly for p4 release
  510.         2000.1
  511.     <dt class="Norm">Made easier to port
  512.         <dd>The configuration file now contains fields for command to redirect to
  513.         null device and command to redirect to stdout. This makes it
  514.         easier to port P4DB to NT that thinks /dev/null is called
  515.         NUL:.
  516. 	<P class=Note>
  517. 	Configuration file for 2.0 not compatible with 2.01
  518. 	<br>
  519. 	<br>
  520.     <dt class="Norm">Java GUI browser improved
  521.         <dd>Can now handle filenames containing spaces
  522.     <dt class="Norm">Label diff view rewritten
  523.         <dd>The old code was buggy and difficult to maintain
  524.     <dt class="Norm">Made some code more maintainable
  525.         <dd>Modified client view and label view code to make it more maintainable.
  526.     </dl>
  527.     <h4 class="p4dbreadme">Diff earlier version of P4DB to 2.0:</h4>
  528.     <P Class="Norm">
  529.        The difference is so huge that I do not care
  530.        to list it. P4DB 2.0 can simply do much more than earlier versions.
  531.  
  532. <!-- --------------------------------------------------------------------------  -->
  533. <a NAME="Licensing"></a>
  534. <h2 class="p4dbreadme">Licensing</h2>
  535.  
  536.     <P Class="Norm">
  537.     There is no license for P4DB.
  538.     You are free to use it for any purpose.
  539.     <br>
  540.     I might decide to apply GPL to it some
  541.     time in the future but I doubt that I will bother....
  542.  
  543. <!-- --------------------------------------------------------------------------  -->
  544. <a NAME="Warranty"></a>
  545. <h2 class="p4dbreadme">Warranty</h2>
  546.  
  547.     <P Class="Norm">
  548.     If you get any problems because of these scripts I promise 
  549.     to feel sorry for you. Other than that you are
  550.     on your own.
  551.     <P Class=Note>
  552.     Please note for the record that I do not even claim that 
  553.     P4DB can be used to browse the P4 depot. I will also inform 
  554.     you that even though the intention is that P4DB should not 
  555.     in any way modify the depot
  556.     status I can make no promises that this is can not happen.<br><br>
  557.     And please remember that it would be easy for someone to grab the
  558.     P4DB code, insert a few malicious lines of code, and
  559.     &quot;release&quot; it with this &quot;Trojan Horse&quot;.
  560.  
  561. <!-- --------------------------------------------------------------------------  -->
  562.  
  563. <a NAME="Contrib"></a>
  564. <h2 class="p4dbreadme">Would you like to contribute?</h2>
  565.  
  566.     <P Class="Norm">
  567.     If you would like to contribute changes/improvements/new functions 
  568.     the best way is to become a registered user at the 
  569.     <a href="http://public.perforce.com/public/index.html" 
  570.        title="Link to Perforce Public Depot">
  571.     Perforce Public Depot</a>, branch from 
  572.     <tt>//guest/fredric_fredricson/P4DB/main/...</tt>, make the changes and
  573.     send me a 
  574.     <a href="mailto:Fredric.Fredricson@bonetmail.com" title="Mailto-link to me">
  575.     email</a>.<br> 
  576.     I can of course not promise that I will like your
  577.     changes and immediately integrate them to P4DB but if not you can
  578.     always start you own competing version of P4DB, I do not mind.
  579.     <p class="Norm">
  580.     If Perforce Public Depot does not work for you you can just send
  581.     me an 
  582.     <a href="mailto:Fredric.Fredricson@bonetmail.com" title="Mailto-link to me">
  583.     email</a> and describe the changes.
  584.     
  585.     <h3 class="p4dbreadme">What would be a contribution?</h3>
  586.     <P Class="Norm">
  587.         I will be glad for any kind of contributions 
  588. 	ranging from corrections of my bad English to new interesting
  589. 	functionality. Nice letters are also welcome.
  590.  
  591. <!-- --------------------------------------------------------------------------  -->
  592. <a NAME="Doc"></a>
  593. <h2 class="p4dbreadme">Design documentation</h2>
  594.  
  595.     <P Class="Norm">
  596.     The most important documentation is in the P4CGI.pm module. 
  597.     This modules is used by all scripts and contains
  598.     a set of common functions that are useful or defines some common "look
  599.     and feel" or both.
  600.     <P Class="Norm">
  601.     The P4CGI.pm module is documented using
  602.     perlpod (see perlpod man page). To get a HTML page 
  603.     containing documentation
  604.     type:
  605.     <br>
  606.     <tt>pod2html P4CGI.pm ><a href="P4CGI.html">P4CGI.html</a></tt>
  607.     (There is one distributed with P4DB, for convenience)
  608.     <P Class="Norm">
  609.     For other files: more often than not the
  610.     code is commented.
  611.     <P Class="Norm">
  612.     There are three different files 'types'
  613.     in the design:
  614.     <dl COMPACT Class="Norm">
  615.       <dt class="Norm"> P4CGI.pm
  616.       <dd> - A perl module containing functions that
  617.              I find useful and all other scripts use
  618.       <dt class="Norm"> *.cgi
  619.       <dd> - A set of cgi scripts that are used as ...eh..
  620.              cgi-scripts.
  621.     </dl>
  622.     <P Class="Norm">
  623.     The code also uses the CGI.pm perl module.
  624.     This module should be part of the "standard distribution" of perl (if there
  625.     is such a thing). If you do not have the module it is available for download at 
  626.     <a href="http://www.cpan.org">www.cpan.org</a>.
  627.  
  628.     <P Class="Norm">
  629.     As a part of my personal religion the -w
  630.     flag is always turned on and 'use strict' flag is also set. I have never
  631.     had any reason to regret this particular peculiarity of mine but it might
  632.     cause some warning messages that will be printed to the browsers error
  633.     log.
  634.  
  635.     <P Class="Norm">
  636.     Performance has not been a great issue.
  637.     I assume that these cgi's will not have thousands 
  638.     of hits each day and
  639.     the design has focused on ease of 
  640.     development rather than speed.
  641.  
  642. <!-- --------------------------------------------------------------------------  -->
  643. <a NAME="Credits"></a>
  644. <h2 class="p4dbreadme">Credits</h2>
  645.  
  646.     <P Class="Norm">
  647.     An incomplete list of people that has contributed to P4DB in different ways:
  648.     <ul Class="Norm">
  649.          <li>Diane Holt - Diane has also released her own version of P4DB 
  650. 	     adapted to NT. I think it's available in Perforce Public Depot.
  651. 	 <li>Lawrence You
  652. 	 <li>Ron Shalhoup
  653. 	 <li>Rob Chandhok
  654. 	 <li>Carl Martinsson - A colleague of mine that use P4DB a lot and 
  655. 	     contributed a lot of ideas for new functions.
  656. 	 <li>Eric Engberg - Provided valuable information on how to
  657. 	     facilitate ports to NT/Apache.
  658. 	 <li>Lee Marzke - For valuable bug reporting
  659. 	 <li>Todd Short - For the graphic branch graphs
  660. 	 <li>Scott Roland - For a suggestion on how to mark deleted directories in the depot tree view
  661. 	 <li>Charles Hardin - For some bug fixes and XML view 
  662.      </ul>
  663.     <P Class="Norm">
  664.      There are more but these are the only names I found in my records.
  665. </body>
  666. </html>
# Change User Description Committed
#13 4989 Fredric Fredricson P4DB: Some small fixed in documentation and make shortcut icon
configurable 		20 years ago
#12 4883 Fredric Fredricson P4DB:
* Added a warning in intro page for untested versions
* Some CSS changes
* Updated... info in README file and on intro page «		 20 years ago
#11 4834 Fredric Fredricson P4DB: Incremented version to 4.0beta1 20 years ago
#10 4237 Fredric Fredricson P4DB: Maybe the final submit for P4DB 3.1.0 21 years ago
#9 4216 Fredric Fredricson P4DB: Another partial submit on my way to P4DB 3.1... 21 years ago
#8 4176 Fredric Fredricson P4DB: Still working my way to P4DB 3.1... 21 years ago
#7 4069 Fredric Fredricson P4DB: More changes on the way to 3.1 21 years ago
#6 4046 Fredric Fredricson P4DB: First submit for 3.1.
* Removed frame-stuff and some related files
* Added new page... header
* Started update of documentation
* Changed a lot of CGI:s to conform to new "look and feel"
Still a lot to do:
- clean up stuff (especially the javascript)
- Fix the file list to use new annotate-command
- Clean up and document css-file
- and more....... «		 21 years ago
#5 2922 Fredric Fredricson P4DB: Started to update README for 3.0 22 years ago
#4 2875 Fredric Fredricson P4DB 3.0 first beta... 22 years ago
#3 1922 Fredric Fredricson P4DB: Some updates of the README file 23 years ago
#2 1913 Fredric Fredricson P4DB: Updated file log view with a link to branch graph and
the README with information a...bout the branchGraph cgi «		 23 years ago
#1 1638 Fredric Fredricson P4DB: Added all (I think) files for P4DB 23 years ago