Changes between Version 9 and Version 10 of ComponentDependencyPlugin

Timestamp:

Jun 6, 2018, 6:05:29 AM (6 years ago)

Author:

figaro

Comment:

Moved example to description, remove reference to non-existent plugin

ComponentDependencyPlugin

@@ -13 +13 @@
 }}}
 
-The `Component` classes that are returned by the `requires` method will be enabled upon environment upgrade. This allows very simple dependencies. Of course, for installation, the required components are still required to be part of Python (in `install_requires` in `setup.py`) and this plugin will not work if there is trouble loading a plugin that is required.
+The `Component` classes that are returned by the `requires` method will be enabled upon environment upgrade. This allows very simple dependencies. Of course, for installation, the required components are still required to be part of Python, as given in `install_requires` in `setup.py`.
+
+This plugin will not work if required plugins are not present or loaded.
+
+The files in [source:componentdependencyplugin/0.11/componentdependencies/test.py test.py] illustrate how to use the plugin. In your `trac.ini` file, enable the following plugins:
+ * `ComponentDependencyPlugin`: 
+  {{{#!ini
+componentdependencies.componentdependency.componentdependencyplugin = enabled
+}}}
+ * `TestDependencyPlugin`:
+  {{{#!ini
+componentdependencies.test.testdependencyplugin = enabled
+}}}
+
+Trac will then require an upgrade. The `FooBarTest` component will be enabled in the upgrade.
 
 == Bugs/Feature Requests
@@ -37 +51 @@
 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
 
-== Example
-
-The files in [source:componentdependencyplugin/0.11/componentdependencies/test.py test.py] illustrate how to use the plugin. Enable the `ComponentDependencyPlugin` (`componentdependencies.componentdependency.componentdependencyplugin = enabled`) and enable the `TestDependencyPlugin` (`componentdependencies.test.testdependencyplugin = enabled`). Trac will then require an upgrade. The `FooBarTest` component will be enabled in the upgrade.
-
-You can also enable the AutoUpgradePlugin prior to this to allow for automatic upgrades.
-
 == Recent Changes