Skip to content

Commit 0facc12

Browse files
committed
Add indexing for roundup-admin references.
1 parent cba1b0f commit 0facc12

File tree

5 files changed

+31
-5
lines changed

5 files changed

+31
-5
lines changed

doc/customizing.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1004,6 +1004,8 @@ property holds a link to the user that created the issue.
10041004
setkey(property)
10051005
~~~~~~~~~~~~~~~~
10061006

1007+
.. index:: roundup-admin; setting assignedto on an issue
1008+
10071009
Select a String property of the class to be the key property. The key
10081010
property must be unique, and allows references to the items in the class
10091011
by the content of the key property. That is, we can refer to users by
@@ -1738,7 +1740,7 @@ Put together, these settings appear in the tracker's ``schema.py`` file::
17381740
# db.security.addPermissionToRole('Anonymous', 'Edit', cl)
17391741

17401742
.. index::
1741-
single: roundup-admin; class permissions
1743+
single: roundup-admin; view class permissions
17421744

17431745
You can use ``roundup-admin security`` to verify the permissions
17441746
defined in the schema. It also verifies that properties specified in
@@ -4031,9 +4033,10 @@ is fiddling around so you can actually use the new category.
40314033
Populating the new category class
40324034
:::::::::::::::::::::::::::::::::
40334035

4034-
If you haven't initialised the database with the ``roundup-admin``
4035-
"initialise" command, then you can add the following to the tracker
4036-
``initial_data.py`` under the comment::
4036+
If you haven't initialised the database with the
4037+
"``roundup-admin initialise``" command, then you
4038+
can add the following to the tracker ``initial_data.py``
4039+
under the comment::
40374040

40384041
# add any additional database creation steps here - but only if you
40394042
# haven't initialised the database with the admin "initialise" command
@@ -4045,6 +4048,8 @@ Add::
40454048
category.create(name="chaco")
40464049
category.create(name="weave")
40474050

4051+
.. index:: roundup-admin; create entries in class
4052+
40484053
If the database has already been initalised, then you need to use the
40494054
``roundup-admin`` tool::
40504055

doc/design.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1089,6 +1089,8 @@ interesting can simply be written in Python using the Roundup database
10891089
module.)
10901090

10911091

1092+
.. index:: roundup-admin; command line specification
1093+
10921094
Command Interface Specification
10931095
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10941096

@@ -1133,6 +1135,8 @@ commands, they are printed one per line (default) or joined by commas
11331135
(with the -list) option.
11341136

11351137

1138+
.. index:: roundup-admin; usage in scripts
1139+
11361140
Usage Example
11371141
~~~~~~~~~~~~~
11381142

doc/installation.txt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ An RDBMS
6767
used if available. One of these is recommended if you are anticipating a
6868
large user base (see `choosing your backend`_ below).
6969

70+
.. index:: roundup-admin:: reindex subcommand
71+
7072
Xapian full-text indexer
7173
The Xapian_ full-text indexer is also supported and will be used by
7274
default if it is available. This is strongly recommended if you are
@@ -237,6 +239,8 @@ Configuring your first tracker
237239
environment variable or specify the full path to
238240
the command in the next step.
239241

242+
.. index:: roundup-admin; install subcommand
243+
240244
c. Install a new tracker with the command ``roundup-admin install``.
241245
You will be asked a series of questions. Descriptions of the provided
242246
templates can be found in `choosing your template`_ below. Descriptions
@@ -277,6 +281,8 @@ Configuring your first tracker
277281
you've initialised the tracker - it's just better to have valid values
278282
for this stuff now.
279283

284+
.. index:: roundup-admin; initialise subcommand
285+
280286
d. Initialise the tracker database with ``roundup-admin initialise``.
281287
You will need to supply an admin password at this step. You will be
282288
prompted::
@@ -377,7 +383,7 @@ other backends at any time using the instructions in the `administration
377383
guide`_.
378384

379385
Regardless of which backend you choose, Roundup will attempt to initialise
380-
a new database for you when you run the roundup-admin "initialise" command.
386+
a new database for you when you run the "``roundup-admin initialise``" command.
381387
In the case of MySQL and PostgreSQL you will need to have the appropriate
382388
privileges to create databases.
383389

doc/upgrading.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Contents:
2727
Migrating from 1.6.X to 2.0.0
2828
=============================
2929

30+
.. index:: roundup-admin; updateconfig subcommand
31+
3032
Upgrade tracker's config.ini file
3133
--------------------------------------
3234
Once you have installed the new roundup, use::
@@ -1512,6 +1514,8 @@ the same spec except the key column name needs a size. So an index on
15121514
Migrating from 1.4.x to 1.4.2
15131515
=============================
15141516

1517+
.. index:: roundup-admin; migrate subcommand
1518+
15151519
You should run the "roundup-admin migrate" command for your tracker once
15161520
you've installed the latest codebase.
15171521

doc/user_guide.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -663,6 +663,11 @@ IMAPS_CRAM:
663663

664664
imaps_cram username:password@server [mailbox]
665665

666+
.. index:: ! roundup-admin
667+
single: roundup-admin; usage
668+
single: roundup-admin; data formats
669+
pair: roundup-admin; designator
670+
666671
Command Line Tool
667672
=================
668673

@@ -780,6 +785,8 @@ and feed it to roundup-admin on standard input. E.G.
780785

781786
(for more details see https://issues.roundup-tracker.org/issue2550789.)
782787

788+
.. index:: ! roundup-admin; usage in scripts
789+
783790
Using with the shell
784791
--------------------
785792

0 commit comments

Comments
 (0)