Commit 0c985b24110112dcfcbe1c543562260458a07202

Luke Dashjr 2012-07-27T23:42:05

RPC: Writeup on poolpriority command usage

diff --git a/API-README b/API-README
index a00a0dc..6ea5a53 100644
--- a/API-README
+++ b/API-README
@@ -177,6 +177,7 @@ The list of requests - a (*) means it requires privileged access - and replies a
  poolpriority|N,... (*)
                none           There is no reply section just the STATUS section
                               stating the results of changing pool priorities
+                              See usage below
 
  disablepool|N (*)
                none           There is no reply section just the STATUS section
@@ -274,8 +275,15 @@ The list of requests - a (*) means it requires privileged access - and replies a
 When you enable, disable or restart a GPU or PGA, you will also get Thread messages
 in the cgminer status window
 
-When you switch to a different pool to the current one, you will get a
-'Switching to URL' message in the cgminer status windows
+The 'poolpriority' command can be used to reset the priority order of pools.
+Each pool should be listed by id number in order of preference (first = most
+preferred). Any pools not listed will be prioritized after the ones that are,
+in an undefined order. If the priority change affects the miner's preference
+for mining, it may switch immediately.
+
+When you switch to a different pool to the current one (including by priority
+change), you will get a 'Switching to URL' message in the cgminer status
+windows
 
 Obviously, the JSON format is simply just the names as given before the '='
 with the values after the '='