| Next revision | Previous revision |
| faq:getsourcecode [2009/10/16 10:55] – created xuesheng | faq:getsourcecode [2011/09/24 15:44] (current) – external edit 127.0.0.1 |
|---|
| Since POPFile is written in Perl most of the source code is actually shipped with each release. The cross-platform, Mac OS X and Windows versions share the same POPFile code. The Windows version of POPFile includes some additional programs which are shipped as binary files (e.g. the Message Capture utility) and the source for these extra programs can be found in the project's source code repository, along with the rest of the source code. | Since POPFile is written in Perl most of the source code is actually shipped with each release. The cross-platform, Mac OS X and Windows versions share the same POPFile code. The Windows version of POPFile includes some additional programs which are shipped as binary files (e.g. the Message Capture utility) and the source for these extra programs can be found in the project's source code repository, along with the rest of the source code. |
| |
| POPFile is maintained by a team of developers known as the POPFile Core Team. To make it easy to keep track of changes to the source code the POPFile Core Team use the [[http://subversion.tigris.org| Subversion]] version control system. Subversion acts as a central repository for the source code and remembers every change ever written to it: every change to every file, and even changes to the directory tree itself, such as the addition, deletion, and rearrangement of files and directories. This makes it easy to answer questions such as “What files were used to build the 1.1.1 release?” or “Who was the last person to change this file, and what changes did he make?” | POPFile is maintained by a team of developers known as the POPFile Core Team. To make it easy to keep track of changes to the source code the POPFile Core Team use the [[http://subversion.apache.org/| Subversion]] version control system. Subversion acts as a central repository for the source code and remembers every change ever written to it: every change to every file, and even changes to the directory tree itself, such as the addition, deletion, and rearrangement of files and directories. This makes it easy to answer questions such as “What files were used to build the 1.1.1 release?” or “Who was the last person to change this file, and what changes did he make?” |
| |
| Normally special software (a Subversion client) is used to access the Subversion repository. However it is also possible to browse the repository via a standard web browser via the [[/browser|Browse Source]] link in the menu shown near the top of this page. | Normally special software (a Subversion client) is used to access the Subversion repository. However it is also possible to browse the repository using a standard web browser via the [[/browser|Browse Source]] link in the menu shown near the top of every page on this site. |
| |
| |
| ===== Browsing the source code ===== | ===== Browsing the source code ===== |
| |
| In addition to the current development files for POPFile, the Subversion repository contains all of the source files used for the current and past releases. The repository is organized into a large number of directories. The current POPFile 1.x development work is stored in the **b0_22_2** branch and the source for the each POPFile release is stored in separate sub-directories within the **tags** directory. (There is also a **trunk** directory but so far no release has been made using files from the trunk.) | In addition to the current development files for POPFile, the Subversion repository contains all of the source files used for the current and past releases. The repository is organized into a large number of directories. The current POPFile 1.x development work is stored in the **[[/browser/branches/b0_22_2|b0_22_2 branch]]** and the source for the each POPFile release is stored in separate sub-directories within the **[[/browser/tags|tags]]** directory. (There is also a **trunk** directory but so far no release has been made using files from this directory.) |
| |
| Here are some useful source code links which can be accessed via a standard browser: | Here are some useful source code links which can be accessed via a standard browser: |
| |
| * [[/browser/branches/b0_22_2|Current POPFile 1.x development]] (current work towards the next 1.x release) | * [[/browser/branches/b0_22_2|Current POPFile 1.x development]] (current work towards the next 1.x.x release) |
| |
| | * [[/browser/tags/v1_1_3|Files used for the 1.1.3 release]] |
| | * [[/browser/tags/v1_1_2|Files used for the 1.1.2 release]] |
| * [[/browser/tags/v1_1_1|Files used for the 1.1.1 release]] | * [[/browser/tags/v1_1_1|Files used for the 1.1.1 release]] |
| * [[/browser/tags/v1_1_0|Files used for the 1.1.0 release]] | |
| * [[/browser/tags/v1_0_1|Files used for the 1.0.1 release]] | |
| * [[/browser/tags/v1_0_0|Files used for the 1.0.0 release]] | |
| |
| Each of these links lead to a directory containing the following sub-directories: | Each of these links leads to a directory containing the following sub-directories: |
| * **engine** contains the files for the main POPFile program | * **engine** contains the files for the main POPFile program |
| * **macosx** contains additional files used to build the Mac OS X installers | * **macosx** contains additional files used to build the Mac OS X installers |
| * **windows** contains additional files used to build the installer and some utilities used by the Windows version of POPFile | * **windows** contains additional files used to build the installer and some utilities used by the Windows version of POPFile (e.g. the Message Capture utility) |
| |
| The browser interface can be used to display source files with syntax highlighting, show the changes between any two versions of a file and allow a particular file to be downloaded (via the "Original format" link at the foot of the page displaying the file). | The browser interface can be used to display source files with syntax highlighting, show the changes between any two versions of a file and allow a particular file to be downloaded (via the "Original format" link at the foot of the page displaying the file). |
| ===== Alternative methods to obtain the source code ===== | ===== Alternative methods to obtain the source code ===== |
| |
| There are over 200 source files for the main POPFile program so using the "Original format" link at the foot of the "Browse Source" pages to get one file at a time would be rather tedious and time-consuming. As an alternative we provide tarballs which are updated every two hours from our Subversion repository. The [[/downloads/popfile_0_22_2.tgz| 0_22_2 branch]] tarball is generated from the subversion branch that leads to the next release of POPFile and you should generally be able to use it on a daily basis (YMMV, though). It is the branch where POPFile 1.x.x comes from. | There are over 200 source files for the main POPFile program so using the "Original format" link at the foot of the "Browse Source" pages to get one file at a time would be rather tedious and time-consuming. As an alternative we provide tarballs which are updated every two hours from our Subversion repository. The [[/downloads/popfile_0_22_2.tgz| 0_22_2 branch tarball]] is generated from the subversion branch that leads to the next release of POPFile and you should generally be able to use it on a daily basis (YMMV, though). It is the branch where POPFile 1.x.x comes from. |
| |
| If you are really interested in obtaining the source code then the best way is to use a Subversion client. There are clients available for Windows, Mac OS X, Fedora, Red Hat, Debian, Ubuntu, Solaris, and other systems. These clients may be stand-alone (command-line or GUI), desktop-integrated (e.g. using Windows context menu) or IDE plugins (e.g. for Eclipse). [[http://subversion.tigris.org/]] has a large selection of download links for Subversion clients. | If you are really interested in obtaining the source code then the best way is to use a Subversion client. There are clients available for Windows, Mac OS X, Fedora, Red Hat, Debian, Ubuntu, Solaris, and other systems. These clients may be stand-alone (command-line or GUI), desktop-integrated (e.g. using Windows context menu) or IDE plugins (e.g. for Eclipse). |
| |
| | See [[http://subversion.apache.org/]] for up-to-date Subversion information, documentation and download links. |
| | |
| | Subversion's old site at [[http://subversion.tigris.org/]] used to include a selection of [[http://subversion.tigris.org/links.html#clients| Subversion client]] links for various operating systems but at present the new site does not seem to include a similar list. However the **Internet Archive Wayback Machine** contains an old copy of [[http://web.archive.org/web/20100117043726/http://subversion.tigris.org/links.html| the missing page]] (//The "17 January 2010" entry in the archive appears to be the most recent page with information - newer versions in the archive have no content//).This is very long page; look for the **Subversion Clients** section which has lists of //Stand-alone clients//, //Desktop-integrated clients//, //IDE plug-in clients// and //Other plug-in clients//. |
| | |
| | See also Wikipedia's [[http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients| Comparison of Subversion clients]] page which has details of over 40 clients for a wide range of platforms. |
| |
| ===== URLs for use with Subversion clients ===== | ===== URLs for use with Subversion clients ===== |
| | %%svn://getpopfile.org/branches/b0_22_2/macosx%% | | | %%svn://getpopfile.org/branches/b0_22_2/macosx%% | |
| | %%svn://getpopfile.org/branches/b0_22_2/windows%% | | | %%svn://getpopfile.org/branches/b0_22_2/windows%% | |
| | |
| | ^ Files used to build the POPFile 1.1.3 release ^ |
| | | %%svn://getpopfile.org/tags/v1_1_3/engine%% | |
| | | %%svn://getpopfile.org/tags/v1_1_3/macosx%% | |
| | | %%svn://getpopfile.org/tags/v1_1_3/windows%% | |
| | |
| | ^ Files used to build the POPFile 1.1.2 release ^ |
| | | %%svn://getpopfile.org/tags/v1_1_2/engine%% | |
| | | %%svn://getpopfile.org/tags/v1_1_2/macosx%% | |
| | | %%svn://getpopfile.org/tags/v1_1_2/windows%% | |
| |
| ^ Files used to build the POPFile 1.1.1 release ^ | ^ Files used to build the POPFile 1.1.1 release ^ |
| | %%svn://getpopfile.org/tags/v1_1_1/macosx%% | | | %%svn://getpopfile.org/tags/v1_1_1/macosx%% | |
| | %%svn://getpopfile.org/tags/v1_1_1/windows%% | | | %%svn://getpopfile.org/tags/v1_1_1/windows%% | |
| |
| ^ Files used to build the POPFile 1.1.0 release ^ | |
| | %%svn://getpopfile.org/tags/v1_1_0/engine%% | | |
| | %%svn://getpopfile.org/tags/v1_1_0/macosx%% | | |
| | %%svn://getpopfile.org/tags/v1_1_0/windows%% | | |
| |
