From e0c78af855b66e5db8eeab9578a8198ffd6fe361 Mon Sep 17 00:00:00 2001 From: David Anderson Date: Wed, 16 Nov 2005 07:51:39 +0000 Subject: [PATCH] *** empty log message *** svn path=/trunk/boinc/; revision=8864 --- doc/boinc_news.inc | 11 ++++++- doc/create_project.php | 1 + doc/db_dump.php | 73 +++++++++--------------------------------- doc/download.php | 2 +- doc/web_rpc.php | 39 ++++++++++++++++++---- 5 files changed, 60 insertions(+), 66 deletions(-) diff --git a/doc/boinc_news.inc b/doc/boinc_news.inc index 42f6c8b040..70eaf9b715 100644 --- a/doc/boinc_news.inc +++ b/doc/boinc_news.inc @@ -2,6 +2,15 @@ $project_news = array( +array("November 15, 2005", + "Aggregate credit data + (user and host credit data summed over all BOINC projects) + is now available in XML format. + This data can be used for applications + (like the 'Featured participant' above) + that reflect overall contribution to BOINC project. + " +), array("November 1, 2005", "IBM's World Community Grid has launched a BOINC-based project (currenly Linux only)." @@ -11,7 +20,7 @@ array("October 28, 2005", in a podcast at www.enterpriseleadership.org." ), array("October 20, 2005", - "Version 5.2.2 of the BOINC client software has been release. + "Version 5.2.2 of the BOINC client software has been released. It includes a simpler registration procedure, security enhancements, and numerous other improvements." ), diff --git a/doc/create_project.php b/doc/create_project.php index 4d22e51917..d21ccb66bc 100644 --- a/doc/create_project.php +++ b/doc/create_project.php @@ -142,6 +142,7 @@ Communicating with participants via the web Miscellaneous diff --git a/doc/db_dump.php b/doc/db_dump.php index b40a5d24ec..dccdb99b78 100644 --- a/doc/db_dump.php +++ b/doc/db_dump.php @@ -126,65 +126,22 @@ htmlspecialchars(" e129b5fa44ed8ba58e41c472822f2807 ")," -
-NOTE: YOU CAN IGNORE THE FOLLOWING; -ALL PROJECTS EXPORT THE SAME INFO NOW. + +

Exporting statistics data

-A project can decide what data to export, -and how it is divided into files. -This is described by a file db_dump.xml of the following form: +Projects: to export statistics data, include an entry like +".html_text(" + + + db_dump -d 2 -dump_spec ../db_dump_spec.xml + db_dump.out + 24 hours + + +")." +in your config.xml file. +Make sure the file db_dump_spec.xml is in your project's +root directory. "; -echo html_text(" - - - x
- x - x - - n - - x - - ... - - ... - -"); -echo " -An 'enumeration' is a listing of particular table. -The fields are: -"; -list_start(); -list_item("table", "'user', 'host' or 'team'"); -list_item("filename", "The base filename."); -list_item("sort", "The sorting criterion: - 'total_credit', 'expavg_credit', or 'id'. - 'id' is the default." -); -list_end(); -echo -"An 'output' is a file or set of files containing an enumeration. -The fields are:"; -list_start(); -list_item("recs_per_file", - "If present, the listing is divided into multiple files - with the given number of records per file. - The file names have the form xxx_N, - where xxx is the base filename. - For views that are ordered by ID, - each file contains a fixed-size segment of the ID range, - not a fixed number of records. - If the database ID allocation has gaps, - files will have fewer than this number of records. -

- If zero or absent, - the listing is written to a single file." -); -list_item("detail", - "If present, records are 'detailed': - user records include a list of hosts, - and team records include a list of users." -); -list_end(); page_tail(); ?> diff --git a/doc/download.php b/doc/download.php index fddd53697f..e2d5aeb053 100755 --- a/doc/download.php +++ b/doc/download.php @@ -212,7 +212,7 @@ if ($xml) {

Download information can be restricted by platform and/or version number, - and can be down in XML format. + and can be obtained in XML format. Details. "; page_tail(); diff --git a/doc/web_rpc.php b/doc/web_rpc.php index 0613f381b5..0b8f27d598 100644 --- a/doc/web_rpc.php +++ b/doc/web_rpc.php @@ -5,6 +5,13 @@ page_head("Web Remote Procedure Calls (RPCs)"); echo "

+BOINC projects export a number of Web RPCs +that can be used to create, query and update +accounts and host records. +These can be used for +account management systems and +credit statistics web sites. +

BOINC's RPC mechanisms have the following conventions:

-

Account creation

-

-The following RPCs are used to create accounts, -typically as part of an -Account Management System.

Create account

"; @@ -56,7 +58,32 @@ list_item( list_end(); echo " -

Query/modify existing account

+

Look up account

+"; +list_start(); +list_item("URL", "project_url/lookup_account.php"); +list_item( + "input", + "email_addr: email address +
passwd_hash: the MD5 hash of the concatenation + of the user's password and the email address. +"); +list_item( + "output", + html_text(" + [ N ] + [ XXX ] + + ") +); +list_item( + "action", + "If an account with the given email address and password hash exists, + return its account key." +); + +list_end(); +echo "

Get account info

";