conf/documentation.conf: Document the keys influencing seppuku.bbclass

diff --git a/classes/seppuku.bbclass b/classes/seppuku.bbclass
index 716fdab..9fdcbbd 100644 (file)
--- a/classes/seppuku.bbclass
+++ b/classes/seppuku.bbclass
@@ -123,7 +123,7 @@ def seppuku_reopen_bug(opener, file, product, component, bug_number, bugname, te
 
     import urllib
     param = urllib.urlencode( { "product" : product, "component" : component, "longdesclength" : 2,
-                                "short_desc" : bugname, "comment" : text, "knob" : "reopen" } )
+                                "short_desc" : bugname, "comment" : text, "knob" : "reopen", "id" : bug_number } )
     result = opener.open( file + param )
     if result.code != 200:
         return False
@@ -184,8 +184,8 @@ python seppuku_do_report() {
         opener  = urllib2.build_opener(urllib2.HTTPCookieProcessor(cj))
         login   = bb.data.getVar("SEPPUKU_LOGIN", data, True)
         query   = bb.data.getVar("SEPPUKU_QUERY", data, True)
-        file    = bb.data.getVar("SEPPUKU_FILE",  data, True)
-        post    = bb.data.getVar("SEPPUKU_POST",  data, True)
+        newbug  = bb.data.getVar("SEPPUKU_NEWREPORT",  data, True)
+        reopen  = bb.data.getVar("SEPPUKU_ADDCOMMENT",  data, True)
         user    = bb.data.getVar("SEPPUKU_USER",  data, True)
         pass    = bb.data.getVar("SEPPUKU_PASS",  data, True)
         product = bb.data.getVar("SEPPUKU_PRODUCT", data, True)
@@ -218,9 +218,9 @@ python seppuku_do_report() {
             return NotHandled
 
         if bug_number and not bug_open:
-            if not seppuku_reopen_bug(opener, file, product, component, bug_number, bugname, text):
+            if not seppuku_reopen_bug(opener, reopen, product, component, bug_number, bugname, text):
                 bb.note("Failed to reopen the bug report")
-        else seppuku_file_bug(opener, file, product, component, bugname, text):
+        else seppuku_file_bug(opener, newbug, product, component, bugname, text):
             bb.note("Filing a bugreport failed")
 
     return NotHandled

diff --git a/conf/documentation.conf b/conf/documentation.conf
index f5be55e..1d2762a 100644 (file)
--- a/conf/documentation.conf
+++ b/conf/documentation.conf
@@ -108,3 +108,22 @@ SOURCE_MIRROR_FETCH[doc] = "Switch marking build as source fetcher. Used to skip
 
 BBINCLUDELOGS[doc] = "Boolean switch to get log printed on failure."
 BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure."
+
+
+# seppuku bbclass
+SEPPUKU_AUTOBUILD[doc] = "This is an autobuild, broken packages are cleaned automatically. Don't define this at all if this is not an autobuild"
+SEPPUKU_USER[doc]     = "The login-name for the bugzilla account"
+SEPPUKU_PASS[doc]     = "The password for this account"
+#SEPPUKU_LOGIN         = "http://bugzilla.openmoko.org/cgi-bin/bugzilla/query.cgi?"
+SEPPUKU_LOGIN[doc]    = "path to the login script of the bugzilla, note the ? at the end"
+#SEPPUKU_QUERY         = "http://bugzilla.openmoko.org/cgi-bin/bugzilla/query.cgi?"
+SEPPUKU_QUERY[doc]    = "The query script of the bugzilla"
+#SEPPUKU_NEWREPORT     = "http://bugzilla.openmoko.org/cgi-bin/bugzilla/post_bug.cgi?bug_file_loc=http%3A%2F%2F&version=unspecified&priority=P2&bug_severity=normal&op_sys=Linux&rep_platform=Neo1973&"
+SEPPUKU_NEWREPORT[doc]= "This is the url used to create a new bug report, note the defaults for version and priority and more, and the trailing &"
+#SEPPUKU_ADDCOMMENT     = "http://bugzilla.openmoko.org/cgi-bin/bugzilla/process_bug.cgi?bug_file_loc=http%3A%2F%2F&version=unspecified&longdesclength=2&priority=P2&bug_severity=normal&op_sys=Linux&rep_platform=Neo1973&knob=reopen&target_milestone=Phase+0"
+SEPPUKU_ADDCOMMENT[doc]= "The url used to reopen bug reports and to add another new comment"
+
+#SEPPUKU_PRODUCT       = "OpenMoko"
+SEPPUKU_PRODUCT[doc]  = "The product inside the bugtracker"
+#SEPPUKU_COMPONENT     = "autobuilds"
+SEPPUKU_COMPONENT[doc]= "The component inside the bugtracker"