Changes between Version 19 and Version 20 of AppDebug

Timestamp:

Oct 7, 2009, 12:04:33 PM (15 years ago)

Author:

davea

Comment:

--

AppDebug

@@ -3 +3 @@
 Some suggestions for debugging applications: 
 
-== Standalone mode ==
+== Testing without a BOINC client ==
 
-When you have built your application and linked it with the BOINC libraries, you can run it in 'standalone mode' (without a BOINC core client present). To do this, put instances of all input files in the same directory (with the proper logical, not physical, names). The application should run and produce output files (also with their logical names). You can run the program under a debugger. When you run an application in standalone mode, the BOINC API will recognize this and take it into account. A couple of things to note:
- * If your application does graphics, it will open a graphics window. Closing this window will exit your application.
- * boinc_time_to_checkpoint() will always return false, so your application will never checkpoint.
+When you have built your application and linked it with the BOINC libraries,
+you can run it in 'standalone mode' (without a BOINC core client present).
+To do this, put instances of all input files in the same directory (with the proper logical, not physical, names).
+The application should run and produce output files (also with their logical names).
+You can run the program under a debugger.
+When you run an application in standalone mode, the BOINC API will recognize this and take it into account.
 
-== Using the anonymous platform mechanism ==
+Note: {{{boinc_time_to_checkpoint()}}} will always return false, so your application will never checkpoint.
 
-Once your application works in standalone mode you'll want to run it from the BOINC core client. This will exercise the various forms of interaction with the core client. To get this process started, create a test project, add an application version and some work, then run the core client. It will download everything and run your application, which will possibly crash.
-At this point you'll want to start experimenting with your application. It would be very tedious to create a new application version for each change. It's far easier to use BOINC's [AnonymousPlatform anonymous platform] mechanism. To do this:
+== Testing with a BOINC client but no project ==
+
+Once your application works in standalone mode,
+the next step is to run it under the BOINC client.
+This will exercise the various forms of interaction with the client.
+If you already have a working project, skip to the next section.
+
+You can test an application under the BOINC client,
+but without a project server, as shown in the following example.
+This example assumes that your executable name is '''test.exe''',
+and that it has an input file with logical name '''in''' and physical name '''input.txt''',
+and an output file with logical name '''out''' and physical name '''output.txt'''.
+
+ * Make a directory and put the BOINC client there.  Note: you'll need a 6.10.14 or later client.
+ * Put the file [http://boinc.berkeley.edu/trac/browser/trunk/boinc/samples/client_state_save.xml samples/client_state_save.xml] in it.
+ * Create a file '''account_test.xml''' containing
+{{{
+<account>
+    <master_url>http://test.test</master_url>
+    <project_name>test_project</project_name>
+</account>
+}}}
+ * Create a file '''cc_config.xml''' containing
+{{{
+<cc_config>
+    <options>
+        <skip_cpu_benchmarks/>
+        <unsigned_apps_ok/>
+    </options>
+</cc_config>
+}}}
+ * Make a subdirectory '''projects/test.test'''; put '''test.exe''' and '''input.txt''' there.
+ * To run the BOINC client (and your app) type
+{{{
+ cp client_state_save.xml client_state.xml ; boinc
+}}}
+ (or do the equivalent on Windows).
+
+The client should run your app and then sleep.
+Check '''projects/test.test/output.txt''' to verify that it worked.
+
+You can run the BOINC Manager after running the client,
+and verify that its various functions
+(fraction done reporting, elapsed time reporting, suspend/resume, etc.)
+are working.
+
+== Testing with a BOINC client and project ==
+
+If you have a working BOINC project,
+you can test applications by repeatedly deploying new app versions in the project.
+However, this is tedious if you need to make a lot of fixes.
+It's easier to use BOINC's [AnonymousPlatform anonymous platform] mechanism.
+To do this:
  * Following the [AnonymousPlatform directions], create a file 'app_info.xml' in the client's project_* directory, with the appropriate name and version number of your application.
  * Each time you build a new version of your application, copy the executable into the project_* directory, making sure it has the appropriate name. Then restart the core client.