TEXT   12

flags

Guest on 23rd July 2022 01:51:04 PM

  1. Flags
  2. *****
  3.  
  4. If you have the editcomponents permission, you can edit Flag Types
  5. from the main administration page. Clicking the Flags link will bring
  6. you to the Administer Flag Types page. Here, you can select whether
  7. you want to create (or edit) a Bug flag or an Attachment flag.
  8.  
  9. The two flag types have the same administration interface, and the
  10. interface for creating a flag and editing a flag have the same set of
  11. fields.
  12.  
  13.  
  14. Flag Properties
  15. ===============
  16.  
  17. Name
  18.    This is the name of the flag. This will be displayed to Bugzilla
  19.    users who are looking at or setting the flag. The name may contain
  20.    any valid Unicode characters except commas and spaces.
  21.  
  22. Description
  23.    The description describes the flag in more detail. It is visible in
  24.    a tooltip when hovering over a flag either in the Show Bug or Edit
  25.    Attachment pages. This field can be as long as you like and can
  26.    contain any character you want.
  27.  
  28. Category
  29.    You can set a flag to be visible or not visible on any combination
  30.    of products and components.
  31.  
  32.    Default behaviour for a newly created flag is to appear on all
  33.    products and all components, which is why "__Any__:__Any__" is
  34.    already entered in the Inclusions box. If this is not your desired
  35.    behaviour, you must either set some exclusions (for products on
  36.    which you don't want the flag to appear), or you must remove
  37.    "__Any__:__Any__" from the Inclusions box and define
  38.    products/components specifically for this flag.
  39.  
  40.    To create an Inclusion, select a Product from the top drop-down
  41.    box. You may also select a specific component from the bottom drop-
  42.    down box. (Setting "__Any__" for Product translates to "all the
  43.    products in this Bugzilla". Selecting  "__Any__" in the Component
  44.    field means "all components in the selected product.") Selections
  45.    made, press Include, and your Product/Component pairing will show
  46.    up in the Inclusions box on the right.
  47.  
  48.    To create an Exclusion, the process is the same: select a Product
  49.    from the top drop-down box, select a specific component if you want
  50.    one, and press Exclude. The Product/Component pairing will show up
  51.    in the Exclusions box on the right.
  52.  
  53.    This flag *will* appear and *can* be set for any
  54.    products/components appearing in the Inclusions box (or which fall
  55.    under the appropriate "__Any__"). This flag *will not* appear (and
  56.    therefore *cannot* be set) on any products appearing in the
  57.    Exclusions box. *IMPORTANT: Exclusions override inclusions.*
  58.  
  59.    You may select a Product without selecting a specific Component,
  60.    but you cannot select a Component without a Product. If you do so,
  61.    Bugzilla will display an error message, even if all your products
  62.    have a component by that name. You will also see an error if you
  63.    select a Component that does not belong to the selected Product.
  64.  
  65.    *Example:* Let's say you have a product called "Jet Plane" that has
  66.    thousands of components. You want to be able to ask if a problem
  67.    should be fixed in the next model of plane you release. We'll call
  68.    the flag "fixInNext". However, one component in "Jet Plane" is
  69.    called "Pilot", and it doesn't make sense to release a new pilot,
  70.    so you don't want to have the flag show up in that component. So,
  71.    you include "Jet Plane:__Any__" and you exclude "Jet Plane:Pilot".
  72.  
  73. Sort Key
  74.    Flags normally show up in alphabetical order. If you want them to
  75.    show up in a different order, you can use this key set the order on
  76.    each flag. Flags with a lower sort key will appear before flags
  77.    with a higher sort key. Flags that have the same sort key will be
  78.    sorted alphabetically.
  79.  
  80. Active
  81.    Sometimes you might want to keep old flag information in the
  82.    Bugzilla database but stop users from setting any new flags of this
  83.    type. To do this, uncheck active. Deactivated flags will still show
  84.    up in the UI if they are "?", "+", or "-", but they may only be
  85.    cleared (unset) and cannot be changed to a new value. Once a
  86.    deactivated flag is cleared, it will completely disappear from a
  87.    bug/attachment and cannot be set again.
  88.  
  89. Requestable
  90.    New flags are, by default, "requestable", meaning that they offer
  91.    users the "?" option, as well as "+" and "-". To remove the "?"
  92.    option, uncheck "requestable".
  93.  
  94. Specifically Requestable
  95.    By default this box is checked for new flags, meaning that users
  96.    may make flag requests of specific individuals. Unchecking this box
  97.    will remove the text box next to a flag; if it is still
  98.    requestable, then requests cannot target specific users and are
  99.    open to anyone (called a request "to the wind" in Bugzilla).
  100.    Removing this after specific requests have been made will not
  101.    remove those requests; that data will stay in the database (though
  102.    it will no longer appear to the user).
  103.  
  104. Multiplicable
  105.    Any flag with Multiplicable:guilabel: set (default for new flags is
  106.    'on') may be set more than once. After being set once, an unset
  107.    flag of the same type will appear below it with "addl." (short for
  108.    "additional") before the name. There is no limit to the number of
  109.    times a Multiplicable flags may be set on the same bug/attachment.
  110.  
  111. CC List
  112.    If you want certain users to be notified every time this flag is
  113.    set to "?", "-", or "+", or is unset, add them here. This is a
  114.    comma-separated list of email addresses that need not be restricted
  115.    to Bugzilla usernames.
  116.  
  117. Grant Group
  118.    When this field is set to some given group, only users in the group
  119.    can set the flag to "+" and "-". This field does not affect who can
  120.    request or cancel the flag. For that, see the Request Group field
  121.    below. If this field is left blank, all users can set or delete
  122.    this flag. This field is useful for restricting which users can
  123.    approve or reject requests.
  124.  
  125. Request Group
  126.    When this field is set to some given group, only users in the group
  127.    can request or cancel this flag. Note that this field has no effect
  128.    if the Grant Group field is empty. You can set the value of this
  129.    field to a different group, but both fields have to be set to a
  130.    group for this field to have an effect.
  131.  
  132.  
  133. Deleting a Flag
  134. ===============
  135.  
  136. When you are at the Administer Flag Types screen, you will be
  137. presented with a list of Bug flags and a list of Attachment Flags.
  138.  
  139. To delete a flag, click on the Delete link next to the flag
  140. description.
  141.  
  142. Warning: Once you delete a flag, it is *gone* from your Bugzilla.
  143.   All the data for that flag will be deleted. Everywhere that flag was
  144.   set, it will disappear, and you cannot get that data back. If you
  145.   want to keep flag data, but don't want anybody to set any new flags
  146.   or change current flags, unset active in the flag Edit form.
  147.  
  148. ======================================================================
  149.  
  150. This documentation undoubtedly has bugs; if you find some, please file
  151. them here.

Raw Paste


Login or Register to edit or fork this paste. It's free.