Francois Gouget : testbot: Document CompareJobPriority(), particularly the Priority field.

[Alexandre Julliard]

Module: tools
Branch: master
Commit: dd51cc7f8afc40b6c583d5ac1b1922456da25eae
URL:    http://source.winehq.org/git/tools.git/?a=commit;h=dd51cc7f8afc40b6c583d5ac1...

Author: Francois Gouget <fgouget(a)codeweavers.com>
Date:   Tue Oct 24 19:04:55 2017 +0200

testbot: Document CompareJobPriority(), particularly the Priority field.

Its naming is quite unfortunate since higher values mean a lower
priority.

Signed-off-by: Francois Gouget <fgouget(a)codeweavers.com>
Signed-off-by: Alexandre Julliard <julliard(a)winehq.org>

---

 testbot/lib/WineTestBot/Jobs.pm | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/testbot/lib/WineTestBot/Jobs.pm b/testbot/lib/WineTestBot/Jobs.pm
index 3c7ce0d..c787e8a 100644
--- a/testbot/lib/WineTestBot/Jobs.pm
+++ b/testbot/lib/WineTestBot/Jobs.pm
@@ -399,6 +399,8 @@ sub CreateJobs(;$)
 
 sub CompareJobPriority
 {
+  # Process Jobs with a higher Priority value last (it's a niceness in fact),
+  # and older Jobs first.
   return $a->Priority <=> $b->Priority || $a->Id <=> $b->Id;
 }