--------------------------------------------------------------------------------------------
Perfin Installation Notes and Known Issues
--------------------------------------------------------------------------------------------
This file provides information on the Perfin installation and known issues.
1 / How to build Perfin ?
Follow these steps to build Perfin :
- set the JAVA_HOME environment variable ( i.e. c:\jdk1.3 or /usr/jdk1.3 )
- configure build.xml and set property ${intellij.home} to point to $IDEA_HOME.
This will include lib's from Intellij, since that's what we are using.
- run Ant on the build.xml file provided. Default target will create the dists.
- once the building process is complete, the 'dist' directory contains
one jar archives 'perfin.jar' and one tar.gz archive 'perfin.tar.gz'.
If you managed to build Perfin or just uses the perfin.jar that comes with
the distribution, you do the following to enable Intellij integration :
- add the jar (perfin.jar) archive to your $IDEA_HOME/plugins directory.
Note: If the directory doesn't exist, just create it.
2 / How to configure Perfin ?
Perfin stores all configuration data in the Intellij project file (ipr). Normaly
this is at the end of the file. The attributes are desinged to be self documenting.
3 / Known Issues
There are not really any known limitations in Perfin, but the way Perforce work and the
way Intellij currently supports filesystem integration does put some limitations
on the solution :
- Several rename/move after eachother requires intermediate submit's to the perforce
repository. This is because Perforce leaves an integrated file in a state of
<branch> or <add rel='nofollow' onclick='return false;'>. It does not yet exist in the Perfoce depot and thus cannot
be renamed/moved. Perforce still doesn't have the notation of rename or move,
only integate.
- Intellij does not yet provide a way for plugins to hinder an action from taking
place. This enables you to acctually do the above without it taking affect
in the repository. Perfin will still try though and print the response from
Perforce in Intellij console (dos-box if you are on Windows).
- The same as above applies to files added without an additional submit to the
repository.
--------------------------------------------------------------------------------------------
(C) Niclas Olofsson, isMobile.com