Skip to content

Commit 9912355

Browse files
committed
Fix code formatting, add link for Configuring Compression.
1 parent feb620e commit 9912355

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

doc/upgrading.txt

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ another interface to the tracker, or are using anydbm).
5555
Check compression settings (optional)
5656
-------------------------------------
5757

58-
Read the `administration guide`_ section on 'Configuring Compression'.
58+
Read the `administration guide`_ section on `Configuring Compression`_.
5959

6060
Upgrade tracker's config.ini file. Use::
6161

@@ -93,24 +93,24 @@ out common works (i.e. there is no stoplist). So words like "and",
9393
search applies both filters.
9494

9595
Using SQLite FTS requires a schema change so you should run
96-
`roundup-admin -i tracker_home migrate` as the FTS specific tables
96+
``roundup-admin -i tracker_home migrate`` as the FTS specific tables
9797
need to be created.
9898

99-
Then you must explicitly enable it by changing the `indexer` setting
100-
in `config.ini` to `native-fts`. Native-fts is never chosen by default
99+
Then you must explicitly enable it by changing the ``indexer`` setting
100+
in ``config.ini`` to ``native-fts``. Native-fts is never chosen by default
101101
like xapian or whoosh. This prevents the existing native indexing from
102-
being discarded if `indexer` is not set.
102+
being discarded if ``indexer`` is not set.
103103

104-
Next re-index your data with `roundup-admin -i tracker_home
105-
reindex`. This can take a while depending on the size of the tracker.
104+
Next re-index your data with ``roundup-admin -i tracker_home
105+
reindex``. This can take a while depending on the size of the tracker.
106106

107-
You may want to update your `config.ini` by following the directions
107+
You may want to update your ``config.ini`` by following the directions
108108
above to get the latest documentation.
109109

110110
If you are happy with the fts indexing, you can save some space by
111111
removing the data from the native text indexing tables. This requires
112-
using the `sqlite3` command to delete the rows in the `__textids` and
113-
`__words` tables. You can do this with the following sqlite3
112+
using the ``sqlite3`` command to delete the rows in the ``__textids`` and
113+
``__words`` tables. You can do this with the following sqlite3
114114
commands::
115115

116116
delete from __words;
@@ -124,12 +124,12 @@ error message. The usual chrome supplied by page.html is not shown.
124124
For example query language syntax errors for full text search methods
125125
will display a bare HTML error page.
126126

127-
If you add an `_generic.400.html` template to the html directory, you
128-
can display the error inside of the layout provided by the `page.html`
127+
If you add an ``_generic.400.html`` template to the html directory, you
128+
can display the error inside of the layout provided by the ``page.html``
129129
template. This can make fixing the error and navigation easier. You
130-
can use the `_generic.404.html` template to create a
131-
`_generic.400.html` by modifying the title and body text. You can test
132-
the 400 template by appending `@template=400` to the url for the
130+
can use the ``_generic.404.html`` template to create a
131+
``_generic.400.html`` by modifying the title and body text. You can test
132+
the 400 template by appending ``@template=400`` to the url for the
133133
tracker.
134134

135135
Migrating from 2.0.0 to 2.1.0
@@ -3345,3 +3345,4 @@ copy.
33453345
.. _`administration guide`: admin_guide.html
33463346
.. _`xmlrpc guide`: xmlrpc.html
33473347
.. _FTS5 full-text search engine: https://www.sqlite.org/fts5.html
3348+
.. _Configuring Compression: admin_guide.html#configuring-compression

0 commit comments

Comments
 (0)