From 3f68c63721f90e97aa9f5c8e297c7c84b7f9659d Mon Sep 17 00:00:00 2001 From: Matěj Cepl Date: Fri, 24 Sep 2010 12:45:54 +0200 Subject: Push unfinished documentation to a separate branch --- docs/StockResponses-bugzilla-gnome-org.txt | 76 - docs/html/BZPage.html | 1521 --------------- docs/html/Color.html | 746 -------- docs/html/GLOBALS.html | 406 ---- docs/html/Logger.html | 471 ----- docs/html/MozillaBugzilla.html | 250 --- docs/html/PersistentPageMod.html | 445 ----- docs/html/RHBugzillaPage.html | 1500 --------------- docs/html/XMLRPCMessage.html | 562 ------ docs/html/allclasses-frame.html | 77 - docs/html/allclasses-noframe.html | 78 - docs/html/help-doc.html | 160 -- docs/html/index-all.html | 898 --------- docs/html/index.html | 27 - docs/html/overview-bzpage.js.html | 36 - docs/html/overview-clipboard.js.html | 30 - docs/html/overview-color.js.html | 36 - docs/html/overview-frame.html | 63 - docs/html/overview-logger.js.html | 36 - docs/html/overview-main.js.html | 30 - docs/html/overview-mozillabzpage.js.html | 36 - docs/html/overview-offline-support.js.html | 30 - docs/html/overview-persistent-page-mod.js.html | 36 - docs/html/overview-rhbzpage.js.html | 36 - docs/html/overview-summary-bzpage.js.html | 915 --------- docs/html/overview-summary-clipboard.js.html | 327 ---- docs/html/overview-summary-color.js.html | 407 ---- docs/html/overview-summary-logger.js.html | 301 --- docs/html/overview-summary-main.js.html | 366 ---- docs/html/overview-summary-mozillabzpage.js.html | 188 -- docs/html/overview-summary-offline-support.js.html | 307 --- .../overview-summary-persistent-page-mod.js.html | 228 --- docs/html/overview-summary-rhbzpage.js.html | 1092 ----------- docs/html/overview-summary-util.js.html | 453 ----- docs/html/overview-summary-xmlrpc.js.html | 322 ---- docs/html/overview-summary.html | 216 --- docs/html/overview-tree.html | 128 -- docs/html/overview-util.js.html | 30 - docs/html/overview-xmlrpc.js.html | 30 - docs/html/stylesheet.css | 39 - docs/jsdoc.xml | 1966 -------------------- 41 files changed, 14901 deletions(-) delete mode 100644 docs/StockResponses-bugzilla-gnome-org.txt delete mode 100644 docs/html/BZPage.html delete mode 100644 docs/html/Color.html delete mode 100644 docs/html/GLOBALS.html delete mode 100644 docs/html/Logger.html delete mode 100644 docs/html/MozillaBugzilla.html delete mode 100644 docs/html/PersistentPageMod.html delete mode 100644 docs/html/RHBugzillaPage.html delete mode 100644 docs/html/XMLRPCMessage.html delete mode 100644 docs/html/allclasses-frame.html delete mode 100644 docs/html/allclasses-noframe.html delete mode 100644 docs/html/help-doc.html delete mode 100644 docs/html/index-all.html delete mode 100644 docs/html/index.html delete mode 100644 docs/html/overview-bzpage.js.html delete mode 100644 docs/html/overview-clipboard.js.html delete mode 100644 docs/html/overview-color.js.html delete mode 100644 docs/html/overview-frame.html delete mode 100644 docs/html/overview-logger.js.html delete mode 100644 docs/html/overview-main.js.html delete mode 100644 docs/html/overview-mozillabzpage.js.html delete mode 100644 docs/html/overview-offline-support.js.html delete mode 100644 docs/html/overview-persistent-page-mod.js.html delete mode 100644 docs/html/overview-rhbzpage.js.html delete mode 100644 docs/html/overview-summary-bzpage.js.html delete mode 100644 docs/html/overview-summary-clipboard.js.html delete mode 100644 docs/html/overview-summary-color.js.html delete mode 100644 docs/html/overview-summary-logger.js.html delete mode 100644 docs/html/overview-summary-main.js.html delete mode 100644 docs/html/overview-summary-mozillabzpage.js.html delete mode 100644 docs/html/overview-summary-offline-support.js.html delete mode 100644 docs/html/overview-summary-persistent-page-mod.js.html delete mode 100644 docs/html/overview-summary-rhbzpage.js.html delete mode 100644 docs/html/overview-summary-util.js.html delete mode 100644 docs/html/overview-summary-xmlrpc.js.html delete mode 100644 docs/html/overview-summary.html delete mode 100644 docs/html/overview-tree.html delete mode 100644 docs/html/overview-util.js.html delete mode 100644 docs/html/overview-xmlrpc.js.html delete mode 100644 docs/html/stylesheet.css delete mode 100644 docs/jsdoc.xml diff --git a/docs/StockResponses-bugzilla-gnome-org.txt b/docs/StockResponses-bugzilla-gnome-org.txt deleted file mode 100644 index c1420fc..0000000 --- a/docs/StockResponses-bugzilla-gnome-org.txt +++ /dev/null @@ -1,76 +0,0 @@ -<> - -<> -= Stock responses for incomplete bugs = -'''As of Bugzilla 2.20 we now have the opportunity to have the stock responses pasted at once into the comment text field. Hence this page is mostly ''obsolete''. If you have bugedit permissions you should see the paste buttons just beneath the text input box, if the bug has the status UNCONFIRMED or NEEDINFO.''' - -Here are some responses to cut and paste into bugzilla for common situations. The whole lot is available as a <> to download. - -'''When changing the stock responses please file a bug [[https://bugzilla.gnome.org/enter_bug.cgi?product=bugzilla.gnome.org|here]] to ensure bugzilla.gnome.org is updated as well.''' This is needed as the stock responses are now integrated into bugzilla.gnome.org, but must be updated manually. - -<> -== If the bug is a crasher and no stack trace is provided == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>Without a stack trace from the crash it's very hard to determine what caused it. Can you get us a stack trace? Please see {{{http://live.gnome.org/GettingTraces}}} for more information on how to do so. Thanks in advance!|| - -<> -== If the bug is not described well == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>This bug report isn't very useful because it doesn't describe the bug well. If you have time and can still reproduce the bug, please read {{{https://bugzilla.gnome.org/bug-HOWTO.html}}} and add a more useful description to this bug.|| - -<> -== If the bug is not described well and it's a crasher == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>This bug report isn't very useful because it doesn't describe the bug well. If you have time and can still reproduce the bug, please read {{{https://bugzilla.gnome.org/bug-HOWTO.html}}} and add a description of how to reproduce this bug.<
><
>You'll also need to add a stack trace; please see {{{http://live.gnome.org/GettingTraces}}} for more information about how to do so.<
>Thanks in advance!|| - -<> -== If the stack trace is incomplete or without debugging symbols == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>Unfortunately, that stack trace is missing some elements that will help a lot to solve the problem, so it will be hard for the developers to fix that crash. Can you get us a stack trace with debugging symbols? Please see {{{http://live.gnome.org/GettingTraces}}} for more information on how to do so. Thanks in advance!|| - -<> -== If the bug is in an obsolete version of the application == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>However, you are using a version that is too old and not supported anymore. GNOME developers are no longer working on that version, so unfortunately there will not be any bug fixes for the version that you use.<
><
>By upgrading to a newer version of GNOME you could receive bug fixes and new functionality. You may need to upgrade your Linux distribution to obtain a newer version of GNOME.<
>Please feel free to reopen this bug if the problem still occurs with a newer version of GNOME.|| - -<> -== If the bug hasn't been touched for more than a year AND its status is UNCONFIRMED AND It is not an enhancement bug == -This stock response has to be incorporated by bugzilla, see GnomeBug:591222. - -||<#FFF8ED> This bug was reported against a version which is not supported any more. Developers are no longer working on this version so there will not be any bug fixes for it.<
>Can you please check again if the issue you reported here still happens in a recent version of GNOME and update this report by adding a comment and adjusting the 'Version' field?<
><
>Again thank you for reporting this and sorry that it could not be fixed for the version you originally used here.<
><
>Without feedback this report will be closed as INCOMPLETE after 6 weeks. || - - - -<> -== If the stack trace indicates a mozilla crash == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>This trace indicates that Mozilla (which was being used by the program) was responsible for the crash, or alternatively that the program was compiled against a different version of Mozilla. Make sure the program was built against the most recent mozilla, and if you can duplicate the crash in mozilla itself, report the bug to {{{http://bugzilla.mozilla.org/}}}|| - -<> -== If the bug is not GNOME == - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>However, this application does not track its bugs in the GNOME bugzilla. We kindly ask you to report the bug to the application authors. For a selective list of other bug tracking systems please consult http://live.gnome.org/Bugsquad/TriageGuide/NonGnome. <
><
>If the affected third party application has a bug tracking system you should investigate whether a bug for the reported issue is already filed in this system. If it has not been filed yet please do so. Also ensure that both bug reports contain a link to each other.<
>Thanks in advance!|| - -== If the bug is a duplicate == - -||<#FFF8ED> Thanks for the bug report. This particular bug has already been reported into our bug tracking system, but please feel free to report any further bugs you find.|| - -'''OR''' - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>This particular bug has already been reported into our bug tracking system, but the maintainers need more information to fix the bug. Could you please answer the questions in the other report in order to help the developers?|| - -'''OR''' - -||<#FFF8ED> Thanks for taking the time to report this bug.<
>This particular bug has already been reported into our bug tracking system, but we are happy to tell you that the problem has already been fixed. It should be solved in the next software version. You may want to check for a software upgrade.|| - -'''AND''' -remember to change the summary of the original bug to include keywords or a better way to explain the problem from the duped bug, in order to prevent more duplicates. - -== NEEDINFO bugs without a response from submitter == -If, after 6 weeks, the reporter still hasn't responded, the bug status should be changed to "RESOLVED" and the resolution to "INCOMPLETE" with a comment similar to: - -||<#FFF8ED> Closing this bug report as no further information has been provided after more than 6 weeks. Please feel free to reopen this bug if you can provide the information asked for. Thanks!|| - - -== Evince rendering bug, missing concerned file and poppler version == -||<#FFF8ED> Thanks for the bug report. Unfortunately it lacks some information that may help us in finding the cause of the bug. Can you, if possible, attach the file causing the crash? Also this may be a Poppler Bug (the backend used by Evince to render PDF), could you please supply the poppler version and type? You can find it in the Help->About menu in Evince. || diff --git a/docs/html/BZPage.html b/docs/html/BZPage.html deleted file mode 100644 index cc2086c..0000000 --- a/docs/html/BZPage.html +++ /dev/null @@ -1,1521 +0,0 @@ - - - - - -BZPage - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  File  Class  Tree  Index  Help 
-		 - - -
- PREV CLASS - NEXT CLASS - FRAMES   - NO FRAMES   -  - - -
- SUMMARY: FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- -
- - -

Class BZPage

-
Object
-   |
-   +--BZPage
-
- - -
-
- -
class - BZPage - - -
- -

- Defined in bzpage.js

-

- -
- - - - - - - - - - - - - - - - - - - - - - - - -
-Constructor Summary
- - - BZPage(win, config) - -
-             - -
- - - -  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- -  Object - - - - - addStuffToTextBox(id, stuff) - -
-            - Add object to the text box (comment box or status whiteboard) -
- -  void - - - - - addToCCList(who) - -
-            - adds a person to the CC list, if it isn't already there -
- -  void - - - - - addToCommentsDropdown(pkg, cmd) - -
-            - Adds new option to the 'comment_action' scroll down box -
- -  void - - - - - centralCommandDispatch(cmdLabel, cmdParams) - -
-            - Actual execution function -
- -  Object - - - - - changeAssignee(newAssignee) - -
-            - Add XGL to the CC list -
- -  void - - - - - checkComments() - -
-            - Set background color of all comments made by reporter in ReporterColor color -
- -  Object - - - - - clickMouse(targetID) - -
-            - Send mouse click to the specified element -
- -  Object - - - - - collectComments() - -
-            - -
- -  void - - - - - commentsWalker(fce) - -
-            - -
- -  Object - - - - - createNewButton(location, after, pkg, id) - -
-            - Generic function to add new button to the page. -
- -  void - - - - - executeCommand(cmd) - -
-            - Take the ID of the package/id combination, and execute it -
- -  void - - - - - generateButtons() - -
-            - -
- -  Object - - - - - getAttachments() - -
-            - collect the list of attachments in a structured format -
- -  Object - - - - - getBugId() - -
-            - Get the ID of the bug. -
- -  Object - - - - - getCCList() - -
-            - a collect a list of emails on CC list -
- -  Object - - - - - getDefaultBugzillaMaintainer(component) - -
-            - Return maintainer which is per default by bugzilla - (which is not necessarily the one who is default maintainer per component) -
- -  Object - - - - - getInstalledPackages(cfg) - -
-            - -
- -  Object - - - - - getLogin() - -
-            - Get login of the currently logged-in user. -
- -  Object - - - - - getOptionValue(id) - -
-            - -
- -  Object - - - - - getOwner() - -
-            - -
- -  Object - - - - - getPassword() - -
-            - returns password from the current storage, or if there isn't - one, then it will ask user for it. -
- -  Object - - - - - getReporter() - -
-            - Get the current email of the reporter of the bug. -
- -  Object - - - - - getVersion() - -
-            - Get the current version of the Fedora release ... -
- -  Object - - - - - hasKeyword(str) - -
-            - Check for the presence of a keyword -
- -  Object - - - - - idContainsWord(id, str) - -
-            - generalized hasKeyword ... -
- -  void - - - - - removeStuffFromTextBox(id, stuff) - -
-            - Remove a keyword from the element if it is there -
- -  Object - - - - - selectOption(id, label) - -
-            - Select option with given label on the
- -  Object - - - - - setNeedinfoReporter() - -
-            - Set the bug to NEEDINFO state - - -
- -  void - - - - - setUpLogging() - -
-            - -
- - - -

- - - - - - - - - - - - - - - -
- Constructor Detail -
- -

-BZPage

-
BZPage(win, config)
- - - - - - - - - - - - - -
- - - - - - - - - - - - -
- Method Detail -
- - - - -

addStuffToTextBox

- 
Object addStuffToTextBox(id, stuff)
- -
    Add object to the text box (comment box or status whiteboard)
- - - - -
    - Parameters: - -
      id - String with the id of the element -
    - -
      stuff - String/Array to be added to the comment box -
    - -
- - - - -
    - Returns: -
      - none -
    -
- - - - - -
- - -

addToCCList

- 
void addToCCList(who)
- -
    adds a person to the CC list, if it isn't already there
- - - - -
    - Parameters: - -
      who - String with email address or "self" if the current user of the bugzilla should be added -
    - -
- - - - - - - - -
- - -

addToCommentsDropdown

- 
void addToCommentsDropdown(pkg, cmd)
- -
    Adds new option to the 'comment_action' scroll down box
- - - - -
    - Parameters: - -
      pkg - String package name -
    - -
      cmd - String with the name of the command If the 'comment_action' scroll down box doesn't exist, this function will set up new one. -
    - -
- - - - - - - - -
- - -

centralCommandDispatch

- 
void centralCommandDispatch(cmdLabel, cmdParams)
- -
    Actual execution function
- - - - -
    - Parameters: - -
      cmdLabel - String with the name of the command to be executed -
    - -
      cmdParams - Object with the appropriate parameters for the command -
    - -
- - - - - - - - -
- - -

changeAssignee

- 
Object changeAssignee(newAssignee)
- -
    Add XGL to the CC list
- - - - -
    - Parameters: - -
      evt - Event which made this function active -
    - -
- - - - -
    - Returns: -
      - none -
    -
- - - - - -
- - -

checkComments

- 
void checkComments()
- -
    Set background color of all comments made by reporter in ReporterColor color
- - - - - - - - - - - -
- - -

clickMouse

- 
Object clickMouse(targetID)
- -
    Send mouse click to the specified element
- - - - -
    - Parameters: - -
      String - ID of the element to send mouseclick to -
    - -
- - - - -
    - Returns: -
      - None -
    -
- - - - - -
- - -

collectComments

- 
Object collectComments()
- - - - - - - - - - - -
- - -

commentsWalker

- 
void commentsWalker(fce)
- - - - - - - - - - - -
- - -

createNewButton

- 
Object createNewButton(location, after, pkg, id)
- -
    Generic function to add new button to the page. Actually copies new button - from the old one (in order to have the same look-and-feel, etc.
- - - - -
    - Parameters: - -
      location - Object around which the new button will be added -
    - -
      after - Boolean before or after location ? -
    - -
      pkg - String which package to take the command from -
    - -
      id - String which command to take -
    - -
- - - - -
    - Returns: -
      - none -
    -
- - - - - -
- - -

executeCommand

- 
void executeCommand(cmd)
- -
    Take the ID of the package/id combination, and execute it
- - - - -
    - Parameters: - -
      String - combined package + "//" + id combination Fetches the command object from this.installedPackages and then goes through all commands contained in it, and calls this.centralCommandDispatch to execute them. -
    - -
- - - - - - - - -
- - -

generateButtons

- 
void generateButtons()
- - - - - - - - - - - -
- - -

getAttachments

- 
Object getAttachments()
- -
    collect the list of attachments in a structured format
- - - - - - - -
    - Returns: -
      - Array of arrays, one for each attachments; each record has string name of the attachment, integer its id number, string of MIME type, integer of size in kilobytes, and the whole element itself -
    -
- - - - - -
- - -

getBugId

- 
Object getBugId()
- -
    Get the ID of the bug.
- - - - - - - -
    - Returns: -
      - string -
    -
- - - - - -
- - -

getCCList

- 
Object getCCList()
- -
    a collect a list of emails on CC list
- - - - - - - -
    - Returns: -
      - Array with email addresses as Strings. -
    -
- - - - - -
- - -

getDefaultBugzillaMaintainer

- 
Object getDefaultBugzillaMaintainer(component)
- -
    Return maintainer which is per default by bugzilla - (which is not necessarily the one who is default maintainer per component)
- - - - - - - -
    - Returns: -
      - String with the maintainer's email address -
    -
- - - - - -
- - -

getInstalledPackages

- 
Object getInstalledPackages(cfg)
- - - - - - - - - - - -
- - -

getLogin

- 
Object getLogin()
- -
    Get login of the currently logged-in user.
- - - - - - - -
    - Returns: -
      - String with the login name of the currently logged-in user -
    -
- - - - - -
- - -

getOptionValue

- 
Object getOptionValue(id)
- - - - - - - - - - - -
- - -

getOwner

- 
Object getOwner()
- - - - - - - - - - - -
- - -

getPassword

- 
Object getPassword()
- -
    returns password from the current storage, or if there isn't - one, then it will ask user for it.
- - - - - - - -
    - Returns: -
      - String with the password -
    -
- - - - - -
- - -

getReporter

- 
Object getReporter()
- -
    Get the current email of the reporter of the bug.
- - - - - - - -
    - Returns: -
      - string -
    -
- - - - - -
- - -

getVersion

- 
Object getVersion()
- -
    Get the current version of the Fedora release ... even if changed meanwhile - by bug triager.
- - - - - - - -
    - Returns: -
      - string (integer for released Fedora, float for RHEL, rawhide) -
    -
- - - - - -
- - -

hasKeyword

- 
Object hasKeyword(str)
- -
    Check for the presence of a keyword
- - - - -
    - Parameters: - -
      str - String with the keyword -
    - -
- - - - -
    - Returns: -
      - Boolean -
    -
- - - - - -
- - -

idContainsWord

- 
Object idContainsWord(id, str)
- -
    generalized hasKeyword ... search in the value of the box with given id
- - - - -
    - Parameters: - -
      id - String with ID of the element we want to check -
    - -
      str - String to be searched for -
    - -
- - - - -
    - Returns: -
      - Boolean found? -
    -
- - - - - -
- - -

removeStuffFromTextBox

- 
void removeStuffFromTextBox(id, stuff)
- -
    Remove a keyword from the element if it is there
- - - - -
    - Parameters: - -
      id - String with the id of the element -
    - -
      stuff - String/Array with keyword(s) to be removed -
    - -
- - - - - - - - -
- - -

selectOption

- 
Object selectOption(id, label)
- -
    Select option with given label on the