diff MIGRATING.md @ 486:0b156b82b8c1

Irccd: rework of paths, closes #611
author David Demelier <markand@malikania.fr>
date Thu, 20 Jul 2017 15:12:41 +0200
parents
children 349fe29d86d5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/MIGRATING.md	Thu Jul 20 15:12:41 2017 +0200
@@ -0,0 +1,27 @@
+IRC Client Daemon MIGRATING
+===========================
+
+This document is a small guide to help you migrating to a next major version.
+
+Migrating from 2.x to 3.x
+-------------------------
+
+### CMake options
+
+  - WITH_CONFDIR has been renamed to WITH_SYSCONFDIR.
+
+### Paths
+
+  - The default plugins path has been changed from **share/irccd/plugins** to
+    **libexec/irccd/plugins**.
+
+### Plugin configuration
+
+The following properties in `Irccd.Plugin` has been renamed:
+
+  - cachePath renamed to paths.cache,
+  - configPath renamed to paths.config,
+  - dataPath renamed to paths.data.
+
+Note: these paths are no more automatically detected and set with the new
+      `[paths]` and `[paths.<name>]` sections.