Documentation patch: clean-up identation after commiting patch for bug 198020: Bugzilla Guide contains no admin docs for flags.
git-svn-id: svn://10.0.0.236/trunk@165091 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
jocuri%softhome.net
@@ -632,8 +632,8 @@
|
||||
<listitem>
|
||||
<para>
|
||||
If the manager thinks the feature should go into the product
|
||||
before version 2.0 can be released, he sets the flag to
|
||||
<quote>+</quote>. Otherwise, he sets it to <quote>-</quote>.
|
||||
before version 2.0 can be released, he sets the flag to
|
||||
<quote>+</quote>. Otherwise, he sets it to <quote>-</quote>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@@ -664,14 +664,15 @@
|
||||
<varlistentry>
|
||||
<term><computeroutput>-</computeroutput></term>
|
||||
<listitem><simpara>
|
||||
The status has been set negatively. (The question has been answered <quote>no</quote>.)
|
||||
The status has been set negatively. (The question has been answered <quote>no</quote>.)
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><computeroutput>+</computeroutput></term>
|
||||
<listitem><simpara>
|
||||
The status has been set positively. (The question has been answered <quote>yes</quote>.)
|
||||
</simpara></listitem>
|
||||
The status has been set positively.
|
||||
(The question has been answered <quote>yes</quote>.)
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
@@ -679,7 +680,7 @@
|
||||
Actually, there's a fourth value a flag can have --
|
||||
<quote>unset</quote> -- which shows up as a blank space. This
|
||||
just means that nobody has expressed an opinion (or asked
|
||||
someone else to express an opinion) about this bug or attachment.
|
||||
someone else to express an opinion) about this bug or attachment.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
@@ -814,7 +815,7 @@
|
||||
<para>
|
||||
This describes the flag in more detail. At present, this doesn't
|
||||
whos up anywhere helpful; ideally, it would be nice to have
|
||||
it show up as a tooltip. This field
|
||||
it show up as a tooltip. This field
|
||||
can be as long as you like, and can contain any character you want.
|
||||
</para>
|
||||
</section>
|
||||
@@ -824,58 +825,58 @@
|
||||
|
||||
<para>
|
||||
Default behaviour for a newly-created flag is to appear on
|
||||
products and all components, which is why <quote>__Any__:__Any__</quote>
|
||||
is already entered in the <quote>Inclusions</quote> box.
|
||||
If this is not your desired behaviour, you must either set some
|
||||
exclusions (for products on which you don't want the flag to appear),
|
||||
or you must remove <quote>__Any__:__Any__</quote> from the Inclusions box
|
||||
and define products/components specifically for this flag.
|
||||
products and all components, which is why <quote>__Any__:__Any__</quote>
|
||||
is already entered in the <quote>Inclusions</quote> box.
|
||||
If this is not your desired behaviour, you must either set some
|
||||
exclusions (for products on which you don't want the flag to appear),
|
||||
or you must remove <quote>__Any__:__Any__</quote> from the Inclusions box
|
||||
and define products/components specifically for this flag.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To create an Inclusion, select a Product from the top drop-down box.
|
||||
You may also select a specific component from the bottom drop-down box.
|
||||
(Setting <quote>__Any__</quote> for Product translates to,
|
||||
<quote>all the products in this Bugzilla</quote>.
|
||||
Selecting <quote>__Any__</quote> in the Component field means
|
||||
You may also select a specific component from the bottom drop-down box.
|
||||
(Setting <quote>__Any__</quote> for Product translates to,
|
||||
<quote>all the products in this Bugzilla</quote>.
|
||||
Selecting <quote>__Any__</quote> in the Component field means
|
||||
<quote>all components in the selected product.</quote>)
|
||||
Selections made, press <quote>Include</quote>, and your
|
||||
Product/Component pairing will show up in the <quote>Inclusions</quote> box on the right.
|
||||
</para>
|
||||
Selections made, press <quote>Include</quote>, and your
|
||||
Product/Component pairing will show up in the <quote>Inclusions</quote> box on the right.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To create an Exclusion, the process is the same; select a Product from the
|
||||
top drop-down box, select a specific component if you want one, and press
|
||||
<quote>Exclude</quote>. The Product/Component pairing will show up in the
|
||||
<quote>Exclusions</quote> box on the right.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This flag <emphasis>will</emphasis> and <emphasis>can</emphasis> be set for any
|
||||
products/components that appearing in the <quote>Inclusions</quote> box
|
||||
(or which fall under the appropriate <quote>__Any__</quote>).
|
||||
This flag <emphasis>will not</emphasis> appear (and therefore cannot be set) on
|
||||
any products appearing in the <quote>Exclusions</quote> box.
|
||||
<emphasis> IMPORTANT: Exclusions override inclusions.</emphasis>
|
||||
top drop-down box, select a specific component if you want one, and press
|
||||
<quote>Exclude</quote>. The Product/Component pairing will show up in the
|
||||
<quote>Exclusions</quote> box on the right.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may select a Product without selecting a specific Component,
|
||||
but it is illegal to select a Component without a Product, or to select a
|
||||
Component that does not belong to the named Product. Doing so as of
|
||||
this writing (2.18rc3) will raise an error... even if all your products
|
||||
have a component by that name.
|
||||
<para>
|
||||
This flag <emphasis>will</emphasis> and <emphasis>can</emphasis> be set for any
|
||||
products/components that appearing in the <quote>Inclusions</quote> box
|
||||
(or which fall under the appropriate <quote>__Any__</quote>).
|
||||
This flag <emphasis>will not</emphasis> appear (and therefore cannot be set) on
|
||||
any products appearing in the <quote>Exclusions</quote> box.
|
||||
<emphasis> IMPORTANT: Exclusions override inclusions.</emphasis>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You may select a Product without selecting a specific Component,
|
||||
but it is illegal to select a Component without a Product, or to select a
|
||||
Component that does not belong to the named Product. Doing so as of
|
||||
this writing (2.18rc3) will raise an error... even if all your products
|
||||
have a component by that name.
|
||||
</para>
|
||||
|
||||
<para><emphasis>Example:</emphasis> Let's say you have a product called
|
||||
<quote>Jet Plane</quote> that has thousands of components. You want
|
||||
to be able to ask if a problem should be fixed in the next model of
|
||||
plane you release. We'll call the flag <quote>fixInNext</quote>.
|
||||
But, there's one component in <quote>Jet Plane,</quote>
|
||||
called <quote>Pilot.</quote> It doesn't make sense to release a
|
||||
new pilot, so you don't want to have the flag show up in that component.
|
||||
So, you include <quote>Jet Plane:__Any__</quote> and you exclude
|
||||
<quote>Jet Plane:Pilot</quote>.
|
||||
to be able to ask if a problem should be fixed in the next model of
|
||||
plane you release. We'll call the flag <quote>fixInNext</quote>.
|
||||
But, there's one component in <quote>Jet Plane,</quote>
|
||||
called <quote>Pilot.</quote> It doesn't make sense to release a
|
||||
new pilot, so you don't want to have the flag show up in that component.
|
||||
So, you include <quote>Jet Plane:__Any__</quote> and you exclude
|
||||
<quote>Jet Plane:Pilot</quote>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@@ -903,94 +904,95 @@
|
||||
Bugzilla database, but stop users from setting any new flags of this type.
|
||||
To do this, uncheck <quote>active</quote>. Deactivated
|
||||
flags will still show up in the UI if they are ?, +, or -, but they
|
||||
may only be cleared (unset), and cannot be changed to a new value.
|
||||
may only be cleared (unset), and cannot be changed to a new value.
|
||||
Once a deactivated flag is cleared, it will completely disappear from a
|
||||
bug/attachment, and cannot be set again.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="flags-create-field-requestable">
|
||||
<title>Requestable</title>
|
||||
<para>
|
||||
New flags are, by default, <quote>requestable</quote>, meaning that they
|
||||
offer users the <quote>?</quote> option, as well as <quote>+</quote> and <quote>-</quote>.
|
||||
To remove the ? option, uncheck <quote>requestable</quote>.
|
||||
</para>
|
||||
</section>
|
||||
<section id="flags-create-field-requestable">
|
||||
<title>Requestable</title>
|
||||
<para>
|
||||
New flags are, by default, <quote>requestable</quote>, meaning that they
|
||||
offer users the <quote>?</quote> option, as well as <quote>+</quote>
|
||||
and <quote>-</quote>.
|
||||
To remove the ? option, uncheck <quote>requestable</quote>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="flags-create-field-cclist">
|
||||
<title>CC List</title>
|
||||
<section id="flags-create-field-cclist">
|
||||
<title>CC List</title>
|
||||
|
||||
<para>
|
||||
If you want certain users to be notified every time this flag is
|
||||
set to ?, -, +, or unset, add them here. This is a comma-separated
|
||||
list of email addresses that need not be restricted to Bugzilla usernames..
|
||||
</para>
|
||||
</section>
|
||||
<para>
|
||||
If you want certain users to be notified every time this flag is
|
||||
set to ?, -, +, or unset, add them here. This is a comma-separated
|
||||
list of email addresses that need not be restricted to Bugzilla usernames..
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="flags-create-field-specific">
|
||||
<title>Specifically Requestable</title>
|
||||
<para>
|
||||
By default this box is checked for new flags, meaning that users may make
|
||||
flag requests of specific individuals. Unchecking this box will remove the
|
||||
text box next to a flag; if it is still requestable, then requests may
|
||||
only be made <quote>to the wind.</quote> Removing this after specific
|
||||
requests have been made will not remove those requests; that data will
|
||||
stay in the database (though it will no longer appear to the user).
|
||||
</para>
|
||||
</section>
|
||||
<section id="flags-create-field-specific">
|
||||
<title>Specifically Requestable</title>
|
||||
<para>
|
||||
By default this box is checked for new flags, meaning that users may make
|
||||
flag requests of specific individuals. Unchecking this box will remove the
|
||||
text box next to a flag; if it is still requestable, then requests may
|
||||
only be made <quote>to the wind.</quote> Removing this after specific
|
||||
requests have been made will not remove those requests; that data will
|
||||
stay in the database (though it will no longer appear to the user).
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="flags-create-field-multiplicable">
|
||||
<title>Multiplicable</title>
|
||||
<para>
|
||||
Any flag with <quote>Multiplicable</quote> set (default for new flags is 'on')
|
||||
may be set more than once. After being set once, an unset flag
|
||||
of the same type will appear below it with <quote>addl.</quote> (short for
|
||||
<quote>additional</quote>) before the name. There is no limit to the number of
|
||||
times a Multiplicable flags may be set on the same bug/attachment.
|
||||
</para>
|
||||
</section>
|
||||
<section id="flags-create-field-multiplicable">
|
||||
<title>Multiplicable</title>
|
||||
<para>
|
||||
Any flag with <quote>Multiplicable</quote> set (default for new flags is 'on')
|
||||
may be set more than once. After being set once, an unset flag
|
||||
of the same type will appear below it with <quote>addl.</quote> (short for
|
||||
<quote>additional</quote>) before the name. There is no limit to the number of
|
||||
times a Multiplicable flags may be set on the same bug/attachment.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section> <!-- flags-create -->
|
||||
</section> <!-- flags-create -->
|
||||
|
||||
<section id="flags-delete">
|
||||
<title>Deleting a Flag</title>
|
||||
<section id="flags-delete">
|
||||
<title>Deleting a Flag</title>
|
||||
|
||||
<para>
|
||||
When you are at the <quote>Administer Flag Types</quote> screen,
|
||||
you will be presented with a list of Bug flags and a list of Attachment
|
||||
Flags.
|
||||
</para>
|
||||
<para>
|
||||
To delete a flag, click on the <quote>Delete</quote> link next to
|
||||
the flag description.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
Once you delete a flag, it is <emphasis>gone</emphasis> from
|
||||
your Bugzilla. All the data for that flag will be deleted.
|
||||
Everywhere that flag was set, it will disappear,
|
||||
and you cannot get that data back. If you want to keep flag data,
|
||||
but don't want anybody to set any new flags or change current flags,
|
||||
unset <quote>active</quote> in the flag Edit form.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
<para>
|
||||
When you are at the <quote>Administer Flag Types</quote> screen,
|
||||
you will be presented with a list of Bug flags and a list of Attachment
|
||||
Flags.
|
||||
</para>
|
||||
<para>
|
||||
To delete a flag, click on the <quote>Delete</quote> link next to
|
||||
the flag description.
|
||||
</para>
|
||||
<warning>
|
||||
<para>
|
||||
Once you delete a flag, it is <emphasis>gone</emphasis> from
|
||||
your Bugzilla. All the data for that flag will be deleted.
|
||||
Everywhere that flag was set, it will disappear,
|
||||
and you cannot get that data back. If you want to keep flag data,
|
||||
but don't want anybody to set any new flags or change current flags,
|
||||
unset <quote>active</quote> in the flag Edit form.
|
||||
</para>
|
||||
</warning>
|
||||
</section>
|
||||
|
||||
<section id="flags-edit">
|
||||
<title>Editing a Flag</title>
|
||||
<para>
|
||||
To edit a flag's properties, just click on the <quote>Edit</quote>
|
||||
link next to the flag's description. That will take you to the same
|
||||
form described in the <quote>Creating a Flag</quote> section.
|
||||
</para>
|
||||
</section>
|
||||
<section id="flags-edit">
|
||||
<title>Editing a Flag</title>
|
||||
<para>
|
||||
To edit a flag's properties, just click on the <quote>Edit</quote>
|
||||
link next to the flag's description. That will take you to the same
|
||||
form described in the <quote>Creating a Flag</quote> section.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
</section> <!-- flags-admin -->
|
||||
</section> <!-- flags-admin -->
|
||||
|
||||
<!-- XXX We should add a "Uses of Flags" section, here, with examples. -->
|
||||
<!-- XXX We should add a "Uses of Flags" section, here, with examples. -->
|
||||
|
||||
</section> <!-- flags -->
|
||||
</section> <!-- flags -->
|
||||
|
||||
<section id="voting">
|
||||
<title>Voting</title>
|
||||
|
||||
Reference in New Issue
Block a user