Changes between Version 10 and Version 11 of Prefs2

Timestamp:

Sep 17, 2019, 4:53:57 PM (5 years ago)

Author:

davea

Comment:

--

Prefs2

@@ -1 +1 @@
 = Computing preferences, version 2 =
-
-Note: the motivation for this is discussed [PrefsRemodel here].
-
-== Static and dynamic parameters ==
-
-Various parameters control and limit
-BOINC's use of computing, memory, storage, and network communication.
-"Static" parameters don't vary over time;
-for example storage-related parameters are static.
-"Dynamic" parameters can change in response to factors external to BOINC
-(such as time of day, non-BOINC CPU usage, etc.).
-Dynamic parameters include limits on #CPUs, RAM usage, and network throughput.
 
 This document describes a new system for "computing preferences" in BOINC.
 This system lets users express, as a set of logical rules,
-how dynamic parameters vary as a function of external factors.
+how dynamic parameters of resource usage vary as a function of external factors.
+
+Note: the motivation for this is discussed [PrefsRemodel here]; that document is otherwise deprecated.
 
 The goals of this system include:
@@ -22 +12 @@
  * Extensibility: make it possible to add new external factors
    (such as the current cost of electricity) without modifying the client.
+
+== Static and dynamic parameters ==
+
+Various parameters control and limit
+BOINC's use of computing, memory, storage, and network communication.
+
+"Dynamic" parameters can change in response to factors external to BOINC
+(such as time of day, non-BOINC CPU usage, etc.).
+These include:
+
+ cpu_usage_limit:: CPU throttling fraction (0..1)
+ dont_use_cpu:: don't run any jobs
+ dont_use_gpu:: don't run GPU jobs
+ dont_do_file_xfer:: don't do file xfers
+ dont_use_network:: don't do any network communication at all
+ max_bytes_sec_down:: max download data rate
+ max_bytes_sec_up:: max upload data rate
+ max_ncpus:: max # of CPUs to use
+ max_ncpus_pct:: max % of CPUs to use
+ ram_max_used_frac:: max fraction of RAM to use
+
+"Static" parameters don't vary over time.
+These include:
+
+ confirm_before_connecting:: ask before creating network connection
+ cpu_scheduling_period:: time between rescheduling jobs
+ disk_max_used_gb:: max disk usage
+ disk_max_used_pct:: max % of disk to use
+ disk_min_free_gb:: min free disk space
+ dont_verify_images:: don't verify image files
+ hangup_if_dialed:: hang up modem connection when done
+ leave_apps_in_memory:: suspend (rather than quit) non-running jobs
+ work_buf_additional_days:: when request work, ask for this much beyond min
+ work_buf_min_days:: keep at least this much work
 
 The XML representation of parameters:
@@ -45 +69 @@
 External factors are stored in a "prefs dictionary",
 which is a name -> value map.
-Examples:
-
- * "idle_time": # seconds since last user input
- * "time": time of day
- * "on_batteries": whether system is running on batteries
- * app_name: whether a given application is running
- * "non_boinc_cpu_usage": fraction of CPU used for non-BOINC apps recently
-
-These values are updated periodically by the client.
+The following entries are maintained by the BOINC client:
+
+ idle_time:: # seconds since last user input
+ time:: time of day
+ on_batteries:: system is running on batteries
+ app_name:: whether a given application is running
+ non_boinc_cpu_usage:: fraction of CPU used for non-BOINC apps recently
+ daily_xfer_mb_N:: number of MB of file transfer in last N days
+ on_ac_power:: system is running on AC power (Android)
+ on_usb_power:: system is running on USB power (Android)
+ wifi_online:: !WiFi network connection exists (Android)
+ user_active:: system thinks user is active (Android)
+ battery_charge:: battery charge level, 0..100 (Android)
+ battery_temperature:: battery temperature, Centigrade (Android)
+
 In addition, external programs can add items to the dictionary,
 and update their values, via GUI RPCs.
@@ -99 +129 @@
 </time_range>
 }}}
+x and y are hours (0..24).
+The first start/end apply to all days.
+This is overwritten by day_of_week elements.
 
 == Conditions ==