blob: 7c0cd161d5d081d9d81aaf5bd5ef21861b4fbed8 [file] [log] [blame]
% Getting the Photran Sources from Git
{\scriptsize Last modified July 22, 2013}
This describes how to check out the source code for the current \textit{development} version
of Photran. At any given time, this is the version of Photran that will be released the
following June.
The source code you check out using this document is \textit{not} guaranteed to be stable.
There are rare points in time when it may not even compile. So, if you have problems following
the instructions in this document, please ask for help on the ptp-dev mailing list --
\textbf{Before you begin\dots}
\item Photran's source code \textit{will not compile} if you are using the wrong version of Eclipse!
You will need to install \textit{Eclipse Classic}, also known as the \textit{Eclipse SDK},
which includes the Eclipse Platform, Java development tools, and Plug-in Development Environment.
(Since Photran is a set of Eclipse plug-ins, you need a distribution of Eclipse that includes the Plug-in
Development Environment.) What version you need depends on the time of year.
\item Between January and June, you need to be running the most recent
milestone build (in preparation for the upcoming release, which occurs in June).
To download the latest milestone build, browse to \\
\centerline{\url{}} \\
and click on the link for ``4.x Stream Stable Build.''
This will take you to a page where you can download the Eclipse SDK.
(For example, in January--June, 2013, you will need the 4.3 Stable Stream Build
for the upcoming Eclipse Kepler release train.)
\item Between July and December, you can use the latest release.
Download Eclipse Classic from \\
(For example, in June--December, 2012, you will download Eclipse 4.2 Classic.)
\item You will need to be running a Java 6 or later Java Virtual Machine (JVM).
\item \textit{(Optional)} You may want to install the following Eclipse plug-ins, although none of them are necessary:
\item \textbf{Subclipse} provides Subversion support -- \url{}
\item \textbf{FindBugs} is a static analysis/bug detection tool for Java -- \url{}
\item \textbf{EclEmma} is a tool which helps you determine the code coverage of your JUnit tests -- \url{}
\item \textbf{Metrics} provides code metrics for Java code -- \url{}
\textbf{Part~I. Install the CDT SDK, EGit, and Photran} %, and Environment Descriptions}
First, you will need to install the C/C++ Development Tools Software Development Kit (CDT SDK),
EGit, and the most recent stable release of Photran itself. Photran reuses some parts of CDT, and the
CDT SDK is required to view the source code for CDT. EGit provides support for the Git distributed
version control system in Eclipse; it is required to access the Git repositories at the Eclipse Foundation
which contain Photran and CDT's source code. Installing the latest release of Photran ensures that Fortran
files will be properly syntax highlighted (among other things), which is helpful when writing tests.
It is also required when setting an API baseline in Part~II below.
\item Start Eclipse. Inside Eclipse, click on the ``Help'' menu, and choose ``Install New Software...''
\item In the ``Work with:'' combo box, choose the update site for the latest Eclipse release train.
As of July, 2013, this should be labeled ``Kepler --''
\item Expand the ``Collaboration'' category
\item Under ``Collaboration,'' check the box next to ``Eclipse EGit''
\item Expand the ``Programming Languages'' category
\item Under ``Programming Languages,'' check the box next to ``C/C++ Development Tools SDK'' (Be sure the name ends with ``SDK''!)
\item Under ``Programming Languages,'' check the box next to ``Fortran Development Tools (Photran)''
\item Click ``Next''
\item The wizard will show the complete list of plug-ins to be installed; click ``Next''
\item Accept the terms of the license agreement, and click ``Finish''
\item Installation may take several minutes. Restart Eclipse when prompted.
% \item After Eclipse restarts, again click on the ``Help'' menu, and choose ``Install New Software...''
% \item Click the ``Add...'' button. In the ``Location'' field, type
% \item In the ``Work with:'' combo box, choose the update site you just entered, i.e.,
% \item Expand the ``PDE/API Tools Environment Description'' category
% \item Under ``PDE/API Tools Environment Description,'' check the boxes next to the following:
% \begin{itemize}
% \item PDE/API Tools Environment Descriptions J2SE 15
% \item PDE/API Tools Environment Descriptions J2SE 16
% \item PDE/API Tools Environment Descriptions J2SE 17
% \end{itemize}
% \item Click ``Next''
% \item The wizard will show the list of environment descriptions to be installed; click ``Next''
% \item Accept the terms of the license agreement, and click ``Finish''
% \item Installation may take several minutes. Restart Eclipse when prompted.
\textbf{Part~II. Set an API Baseline}
Eclipse plug-ins are required to follow very strict rules when making changes to their application
programming interface (API). The Eclipse Plug-in Development Environment's API Tooling component enforces
these rules. You must configure it with an API baseline so it can compare the current source code
with the latest stable release, in order to detect API changes.
\item In Eclipse, if you are running Windows or Linux, click on the ``Window'' menu; if you are running Mac OS X, click on the ``Eclipse'' menu.
Choose ``Preferences'' from the menu.
\item Expand the ``Plug-in Development'' category, and choose ``API Baselines''
\item Click ``Add Baseline...''
\item Enter ``Default'' for the name
\item Click ``Reset''
\item Click ``Finish''
\item Click ``OK''
\item If prompted to ``Do a full build now?'', click ``Yes''
\textbf{Part~III. Clone the Photran Git repository and check out Photran's source code}
\textit{\textbf{Important:} If you already have an earlier version of the Photran source code (e.g., if you checked it out from CVS before we moved to Git),
you must \textit{delete} the existing projects from your workspace. The Git import wizard will not overwrite them; it will give an error message and fail.}
\item Switch to the ``Git Repository Exploring'' perspective. (From the ``Window'' menu, choose ``Open Perspective'', and ``Other...''; choose ``Git Repository Exploring'', and click ``OK.'')
\item From the ``File'' menu, choose ``Import...''
\item Under ``Git'', choose ``Projects from Git'', and click ``Next''
\item Select ``URI'', and click ``Next''
\item In the URI field, enter one of the following.
\item Most people will enter \\
\item If you are a committer at the Eclipse Foundation, enter \\
replacing \texttt{username} with your committer username.
\item Click ``Next''
\item All branches will be selected by default; click ``Next''
\item Make sure the local directory is OK (or change it if you want your local Git repository stored somewhere else); then click ``Next''
\item The repository will be downloaded (it may spend several minutes ``receiving objects'').
\item Ensure that "Import existing projects" is selected and ``Working Directory'' is selected from the list; then click ``Next''
\item All projects are selected by default; click ``Finish''
\item Switch back to the Java perspective. The Package Explorer view should now contain several new projects with Photran's source code. There should be no compilation errors (although there will be a few warnings).