Changes between Initial Version and Version 1 of SourceCodeGit

Timestamp:

Jul 17, 2012, 10:11:58 AM (12 years ago)

Author:

romw

Comment:

Initial Draft

SourceCodeGit

@@ +1 @@
+= Getting source code =
+
+The BOINC source code is stored in a Git repository.
+Various versions of the code are available at any given point:
+
+'''Development'''
+
+The SVN trunk contains the latest source code for all components of BOINC.
+It is always under development, and has not necessarily been thoroughly tested.
+Use it if you need a recently-added feature.
+
+'''Client software'''
+
+The client software (client and manager) is maintained as follows:
+
+ * The code for each release is 'tagged'.
+  For example, the code for version 6.3.14 is tagged with '''boinc_core_release_6_3_14'''.
+ * A 'branch' is created for each released minor version.
+  For example, the branch '''boinc_core_release_6_2''' is the code for the latest release of version 6.2.
+
+'''Server software'''
+
+For all software other than the client (i.e., server, web, and API)
+a "stable" version is kept in a branch, '''server_stable'''.
+Don't use the server software in a client tag or branch; it probably isn't stable.
+
+Notes:
+ * There is no formal testing process for server software.
+   Every so often, when no bugs have been reported recently,
+   we copy trunk to server_stable.
+ * Because of limited resources, bug fixes to server software are normally
+   NOT back-ported from trunk to server_stable.
+
+For these reasons: '''trunk is typically a better choice
+than server_stable for server software'''.
+
+== Using Git ==
+
+On Unix, use the the following commands to clone the repository:
+{{{
+git clone git://isaac.ssl.berkeley.edu/boinc.git
+}}}
+
+On Windows, get a Git client like [SourceCodeGit/Windows Git on Windows].
+Right-click on the parent directory, select 'Git Clone...',
+and fill in the dialog with one of the above URLs. There is no need to add 'git clone' in front of it. 
+
+All the additional dependency files are now stored in [source:build-depends-vs2005 build-depends-vs2005], get them using {{{git clone git://isaac.ssl.berkeley.edu/build-depends-vs2005.git}}}.
+The dependencies should be stored in the same parent directory as the BOINC source code, for example:
+{{{
++-+ source
+    |
+    + boinc
+    | |
+    | + api
+    | + client
+    | + clientgui
+    | + etc...
+    |
+    + build_depends_vs2005
+    | |
+    | + curl
+    | + openssl
+    | + wxwidgets
+    | + zlib
+}}}
+
+When you have older source code, I found that deleting all previous source code and downloading it fresh, will fix the breaks in building BOINC. Make sure to backup your own code prior to deleting the source code. 
+
+== Browsing source code via the web ==
+
+You can browse the boinc code via [/browser a web-based interface].
+This is useful for getting individual files, or seeing the revision history.
+
+== Source code road map ==
+
+The BOINC source tree includes the following directories:
+
+ '''api'''::
+        The BOINC API (for applications).
+ '''apps'''::
+        Some test applications.
+ '''client'''::
+        The BOINC core client.
+ '''clientgui'''::
+        The BOINC Manager.
+ '''clientscr'''::
+        The BOINC screensaver for Windows.
+ '''clienttray'''::
+        The BOINC Tray component (checks for user activity on Windows).
+ '''db'''::
+        The database schema and C++ interface layer.
+ '''html/ops'''::
+        PHP files for the operational web interface.
+ '''html/user'''::
+        PHP files for the participant web interface.
+ '''html/inc'''::
+        PHP include files.
+ '''html/languages'''::
+        Translation files for project websites.
+ '''lib'''::
+        Code that is shared by more than one component (core client, scheduling server, etc.).
+ '''locale'''::
+        Translation files for BOINC Manager.
+ '''py'''::
+        Python modules used by tools.
+ '''sched'''::
+        The scheduling server, feeder, and file upload handler.
+ '''samples'''::
+        Several [ExampleApps example applications] together with Windows and Mac project files and a Linux makefile for building the applications. It also includes Windows versions of some libraries (GLUT, jpeglib, etc.) that many applications will need, but which are not part of BOINC.
+ '''test'''::
+        Test scripts.
+ '''tools'''::
+        Operational utility programs.
+ '''win_build'''::
+        Project files for compiling the client under Windows, and the Windows installer.
+ '''zip'''::
+        Compression functions; not used by BOINC, but may be useful for applications.