Bug 1107722 - Remove TODO markers in documentation. r,a=dkl.

diff --git a/docs/en/rst/administering/parameters.rst b/docs/en/rst/administering/parameters.rst
index 8e3e6123157aaf3168e6f8ff922bc390f4d0be87..6be8831dcf82335dc4aa409359be2de0172fc705 100644 (file)
--- a/docs/en/rst/administering/parameters.rst
+++ b/docs/en/rst/administering/parameters.rst
@@ -395,9 +395,6 @@ makeproductgroups
     when new products are created. If this is on, the groups will be
     used for querying bugs.
 
-    .. todo:: This is spectacularly unclear. I have no idea what makeproductgroups
-              does - can someone explain it to me? Convert this item into a bug on checkin.
-
 chartgroup
     The name of the group of users who can use the 'New Charts' feature. Administrators should ensure that the public categories and series definitions do not divulge confidential information before enabling this for an untrusted population. If left blank, no users will be able to use New Charts.
 

diff --git a/docs/en/rst/index.rst b/docs/en/rst/index.rst
index b877920c643a3c81cfc63acbf9d13d3bd7703bd3..b4ca1107ed63f9e0e26fa7ef96c9b360111a228b 100644 (file)
--- a/docs/en/rst/index.rst
+++ b/docs/en/rst/index.rst
@@ -27,5 +27,3 @@ Bugzilla Documentation
    installing/apache
    installing/apache-windows
    installing/iis
-
-.. todolist::

diff --git a/docs/en/rst/installing/backups.rst b/docs/en/rst/installing/backups.rst
index f20b3021ab6e5461de75be8569d280686cc979e6..c4d1ec8631a43ae7afe1e1db3be73648e3cf6295 100644 (file)
--- a/docs/en/rst/installing/backups.rst
+++ b/docs/en/rst/installing/backups.rst
@@ -21,8 +21,6 @@ See the
 `mysqldump documentation <http://dev.mysql.com/doc/mysql/en/mysqldump.html>`_
 for more information on :file:`mysqldump`.
 
-.. todo:: Mention max_allowed_packet? Convert this item to a bug on checkin.
-
 PostgreSQL
 ----------
 

diff --git a/docs/en/rst/installing/linux.rst b/docs/en/rst/installing/linux.rst
index 97192fac3a27fc9a628a98e38c2c2fd8f9e44419..f1c69410eb4c569479cd65051fe0f6a0b081c58f 100644 (file)
--- a/docs/en/rst/installing/linux.rst
+++ b/docs/en/rst/installing/linux.rst
@@ -179,9 +179,6 @@ Or, you can pass an individual module name:
    distribution you are using, but are often called
    :file:`<packagename>-devel`.
 
-   .. todo:: Give examples for Debian/Ubuntu and RedHat.
-             Convert this item to a bug after checkin.
-
 .. _linux-config-webserver:
 
 Web Server

diff --git a/docs/en/rst/installing/quick-start.rst b/docs/en/rst/installing/quick-start.rst
index 220421bcef7e36db554b21b76e2574bb698a1148..0d34d12edb42aad120345a4fffe7d3d7e655727c 100644 (file)
--- a/docs/en/rst/installing/quick-start.rst
+++ b/docs/en/rst/installing/quick-start.rst
@@ -166,12 +166,8 @@ Test Server
 
 :command:`./testserver.pl http://localhost/`
 
-All the tests should pass. You will get warnings about deprecation from
-the ``Chart::Base`` Perl module; just ignore those.
-
-.. todo:: Chart::Base gives confusing deprecation warnings :-|
-          https://rt.cpan.org/Public/Bug/Display.html?id=79658 , unfixed for
-          2 years. :bug:`1070117`.
+All the tests should pass. You may get warnings about deprecation from
+the ``Chart::Base`` Perl module; if so, just ignore them.
 
 Access Via Web Browser
 ======================

diff --git a/docs/en/rst/style.rst b/docs/en/rst/style.rst
index aa3957b95ae1cfa7f94abe139a3cf5e4ea2b691f..a1d6d78351fa3140e3fedad0b1fb11bfbb5aa23e 100644 (file)
--- a/docs/en/rst/style.rst
+++ b/docs/en/rst/style.rst
@@ -64,11 +64,13 @@ Other block types:
 .. warning:: This is a warning of a potential serious problem you should be
    aware of.
 
-.. todo:: This is some documentation-related task that still needs doing.
-   
 Use both of the above block types sparingly. Consider putting the information
 in the main text, omitting it, or (if long) placing it in a subsidiary file.
 
+.. todo:: This is some documentation-related task that still needs doing.
+          This is useful for short-term todos during development; however,
+          consider filing a bug for todos which will persist longer.
+
 Code gets highlighted using Pygments. Choose the highlighter at the top of
 each file using:
 

diff --git a/docs/en/rst/using/finding.rst b/docs/en/rst/using/finding.rst
index 414e30cbae2522127f10ee2acde460456ab26e2a..515f2e37de5f5ec02eaf0590065a2b1edb018709 100644 (file)
--- a/docs/en/rst/using/finding.rst
+++ b/docs/en/rst/using/finding.rst
@@ -33,10 +33,6 @@ would search only in that product.
 You can also use it to go directly to a bug by entering its number or its
 alias.
 
-.. todo:: Need to incorporate the full reference, and link it properly from
-          the GUI. https://bugzilla.mozilla.org/page.cgi?id=quicksearch.html
-          Turn this item into a bug after checkin.
-
 Simple Search
 =============
 
@@ -101,9 +97,6 @@ There are three fields in each row of a boolean search.
 Multiple Charts
 ---------------
 
-.. todo:: This needs rewriting for the new UI.
-          Turn this item into a bug after checkin.
-          
 The terms within a single row of a boolean chart are all
 constraints on a single piece of data. If you are looking for
 a bug that has two different people cc'd on it, then you need
@@ -248,9 +241,6 @@ Remember Search As:
 Adding and Removing Tags on Bugs
 ================================
 
-.. todo:: Looks like you can no longer do this from search results; is that right?
-          Turn this item into a bug after checkin.
-          
 You can add and remove tags from individual bugs, which let you find and
 manage bugs more easily. Tags are per-user and so are only visible and editable
 by the user who created them. You can then run queries using tags as a criteria,

diff --git a/docs/en/rst/using/tips.rst b/docs/en/rst/using/tips.rst
index a481492759daf280151cc6bc12eb04fe65a375a1..411d457fdbeff2e6b49b621bfcef020a357193d1 100644 (file)
--- a/docs/en/rst/using/tips.rst
+++ b/docs/en/rst/using/tips.rst
@@ -79,12 +79,6 @@ reference on supported Markdown structures, please see the
 `syntax help <https://bugzilla.mozilla.org/page.cgi?id=markdown.html>`_ link
 next to the Markdown checkbox for new comments.
 
-.. todo:: The above link isn't ideal, but we can't easily link to the user's
-          Bugzilla because the docs aren't always on a Bugzilla (e.g.
-          when they are on ReadTheDocs). Best solution is to port the
-          Markdown guide to ReST.
-          Turn this item into a bug after checkin.
-          
 To use the Markdown feature, make sure that :guilabel:`Enable Markdown
 support for comments` is set to :guilabel:`on`
 in your :ref:`user-preferences` and that you also check the :guilabel:`Use