Changes between Version 14 and Version 15 of TracUpgrade

Timestamp:

Sep 5, 2005, 8:24:53 PM (19 years ago)

Author:

Christopher Lenz

Comment:

Cleanup

TracUpgrade

@@ -6 +6 @@
  '''Note''': ''Environment upgrades are not necessary for minor version releases unless otherwise noted. For example, there's no need to upgrade a Trac environment created with (or upgraded) 0.8.0 when installing 0.8.4 (or any other 0.8.x release).''
 
-== Upgrade Synopsis ==
+== General Instructions ==
 
-A typical upgrade looks like the following: 
+Typically, there are three steps involved in upgrading to a newer version of Trac:
 
- 1. You upgrade the Trac source code - from an offical release or from a source checkout.
- 2. You run the `trac-admin upgrade` command to bring the database up-to-date with the new Trac code. The table structure changes over time, but it is versioned. The upgrade command find the current version of the DB and the version required by the code, and performs an upgrade if required.
- 3. Optionally, you can run the `wiki upgrade` command to bring the default Wiki pages up-to-date. Your `WikiStart` page will be left intact, of course.
+=== Update the Trac Code ===
+
+Get the new version of Trac, either by downloading an offical release package or by checking it out from the [http://projects.edgewall.com/trac/wiki/SubversionRepository Subversion repository].
+
+If you have a source distribution, you need to run
+{{{
+python setup.py install
+}}}
+
+to install the new version. If you've downloaded the Windows installer, you execute it, and so on.
+
+In any case, if you're doing a major version upgrade (such as from 0.8 to 0.9), it is ''highly'' recommended that you first remove the existing Trac code. To do this, you need to delete the `trac` directory from the Python `lib/site-packages` directory. You may also want to remove the Trac `cgi-bin`, `htdocs` and `templates` directories that are commonly found in a directory called `share/trac` (the exact location depends on your platform).
+
+=== Upgrade the Trac Environment ===
+
+Unless noted otherwise, upgrading between major versions (such as 0.8 and 0.9) involves changes to the database schema, and possibly the layout of the [wiki:TracEnvironment environment directory]. Fortunately, Trac provides automated upgrade scripts to ease the pain. These scripts are run via [wiki:TracAdmin trac-admin]:
+{{{
+trac-admin /path/to/projenv upgrade
+}}}
+
+This command will do nothing if the environment is already up-to-date.
+
+=== Update the Trac Documentation ===
+
+Every [wiki:TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. As you probably want to keep the included documentation in sync with the installed version of Trac, [wiki:TracAdmin trac-admin] provides a command to upgrade the documentation:
+{{{
+trac-admin /path/to/projenv wiki upgrade
+}}}
+
+Note that this procedure will of course leave your `WikiStart` page intact.
+
+
+The following sections discuss any extra actions that may need to be taken to upgrade to specific versions of Trac.
 
 == From 0.8.x to 0.9 ==
-
-The database schema was changed between 0.8.x and 0.9. Existing environments must be upgraded before they can be used with Trac 0.9.
-
-The following command will automatically perform the upgrade:
-{{{
- $ trac-admin /path/to/projectenv upgrade
-}}}
-
-Trac environments are created with a default set of wiki pages. It's recommended to update these pages on existing environments whenever Trac is upgraded to get up-to-date documentation and additional functionality. The following command will perform the update:
-{{{
- $ trac-admin /path/to/projectenv wiki upgrade
-}}}
 
 If you're using [wiki:TracModPython mod_python], you will need to change the name of the mod_python handler in the Apache HTTPD configuration:
@@ -34 +52 @@
 }}}
 
-== From 0.7.x to 0.8 ==
+If you have [http://initd.org/tracker/pysqlite PySQLite] 2.x installed, Trac will now try to open your SQLite database using the SQLite 3.x file format. The database formats used by SQLite 2.8.x and SQLite 3.x are incompatible. If you get an error like ''“file is encrypted or is not a database”'' after upgrading, then you must convert your database file.
 
-The database schema was changed between 0.7.x and 0.8. Existing environments
-must be upgraded before they can be used with Trac 0.8.
-
-The following command will automatically perform the upgrade:
+To do this, you need to have both SQLite 2.8.x and SQLite 3.x installed (they have different filenames so can coexist on the same system). Then use the following commands:
 {{{
- $ trac-admin /path/to/projectenv upgrade
+ $ mv trac.db trac2.db
+ $ sqlite trac2.db .dump | sqlite3 trac.db
 }}}
 
-Trac environments are created with a default set of wiki pages. It's 
-recommended to update these pages on existing environments whenever
-Trac is upgraded to get up-to-date documentation and additional functionality.
-The following command will perform the update:
-{{{
- $ trac-admin /path/to/projectenv wiki upgrade
-}}}
+After testing that the conversion was successful, the `trac2.db` file can be deleted. For more information on the SQLite upgrade see http://www.sqlite.org/version3.html.
+
+== From 0.7.x to 0.8 ==
 
 0.8 adds a new roadmap feature which requires additional permissions. While a
@@ -61 +73 @@
 }}}
 
-== Upgrading SQLite from 2.x to 3.x ==
-
-The database formats used by SQLite 2.x and sqlite 3.x are incompatible. If you upgrade your SQLite version (this can  also happen implicitly if you upgrade from PySQLite 1.0.x to 1.1.x or 2.x), then you must convert your database. 
-
-To do this, install both SQLite 2.8 and SQLite 3.x  (they have different filenames so can coexist in the same directory). Then use the following commands (Windows):
-{{{
- $ mv trac.db trac2.db
- $ sqlite trac2.db .dump | sqlite3 trac.db
-}}}
-
-Then when you're happy with the conversion and tested everything  you can delete the trac2.db file.
-
-For more information see http://www.sqlite.org/version3.html
-
 -----
 See also: TracGuide, TracInstall