Mercurial > irccd

annotate MIGRATING.md @ 804:d55a64c6586b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
irccdctl: unify CLI output, closes #928 @1h
author David Demelier <markand@malikania.fr>
date Wed, 14 Nov 2018 14:07:05 +0100
parents 1a6152af0866
children 5a421b20a4f4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 IRC Client Daemon MIGRATING
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 ===========================
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 This document is a small guide to help you migrating to a next major version.
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 Migrating from 2.x to 3.x
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 -------------------------
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
9 ### Irccd
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
10
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
11 - The option `reconnect-tries` has been removed from `[server]` section, use
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
12 `auto-reconnect` boolean option instead,
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
13 - The option `reconnect-timeout` has been renamed to `auto-reconnect-delay`.
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
14 - The section `[identity]` has been removed, instead move those values inside
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
15 each server in their `[server]` section.
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
16
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
17 ### Irccdctl
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
18
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
19 - The functions `server-cnotice` and `server-cmode` have been removed, use
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
20 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
21 - The option `connect.host` has been renamed to `connect.hostname`,
804
d55a64c6586b irccdctl: unify CLI output, closes #928 @1h
David Demelier <markand@malikania.fr>
parents: 796
diff changeset
22 - The option `--host` has been renamed to `--hostname`,
d55a64c6586b irccdctl: unify CLI output, closes #928 @1h
David Demelier <markand@malikania.fr>
parents: 796
diff changeset
23 - The output style has been unified.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
24
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
25 ### Plugins
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
26
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
27 #### Logger
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
28
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
29 - The keyword `source` has been removed and replaced by `channel`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
30 - The keyword `origin` has been added,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
31 - Formats `cnotice`, `cmode`, `query` have been removed.
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
32
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
33 ### Network API
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
34
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
35 - The requests `server-cnotice` and `server-cmode` have been removed, use
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
36 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
37 - The request `server-mode` command requires a new argument `channel`.
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
38 - The property `host` in request `server-connect` has been renamed to
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
39 `hostname`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
40 - The request `server-info` sends `hostname` property instead of `host`,
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
41 - The event `onWhois` sends `hostname` property instead of `host`,
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
42
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 ### CMake options
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
45 - All options are now starting with `IRCCD_` for better compatibility with
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
46 external projects,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
47 - CMake now use GNUInstallDirs module to specify installation paths, all
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
48 IRCCD\_WITH\_ options have been replaced by CMAKE\_INSTALL\_ equivalents.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 ### Paths
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
52 - The default plugins path has been changed from **share/irccd/plugins** to
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
53 **lib64/irccd**.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
54
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
55 ### Javascript API
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
57 #### Events
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
59 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
60 must use `Server.isSelf(target)` to determine a channel/private message,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
61 - The event `onNotice` takes a new `channel` argument,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
62 - The event `onMode` takes new `channel`, `limit`, `user`, `mask` arguments,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
63 - The object information in `onWhois` event now has `hostname` property instead
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
64 of `host`.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
65
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
66 #### Module Server
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
67
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
68 - The methods `Server.cmode` and `Server.cnotice` have been removed, use
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
69 `Server.mode` and `Server.notice` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
70 - The method `Server.mode` requires a new argument `channel`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
71 - The object returned in the method `Server.info` now has a `hostname` property
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
72 instead of `host`.
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
73 - The property `host` in constructor `Server` has been renamed to
796
1a6152af0866 misc: use ipv4 as option rather than family
David Demelier <markand@malikania.fr>
parents: 788
diff changeset
74 `hostname`.
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
75
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
76 #### Module ElapsedTimer
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
77
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
78 - The method ElapsedTimer.reset has been removed, just use `start` instead
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
79 when you want to accumulate time.
514
16b9ebfd3f08 Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents: 489
diff changeset
80
16b9ebfd3f08 Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents: 489
diff changeset
81 #### Module Directory
16b9ebfd3f08 Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents: 489
diff changeset
82
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
83 - The property `Directory.count` has been removed.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
84
700
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
85 #### Module Plugin
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
86
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
87 The following properties in `Irccd.Plugin` has been renamed:
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
88
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
89 - **cachePath** renamed to **paths.cache**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
90 - **configPath** renamed to **paths.config**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
91 - **dataPath** renamed to **paths.data**.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
92
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
93 Note: these paths are no more automatically detected and set with the new
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
94 `[paths]` and `[paths.<name>]` sections.
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
95
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
96 #### Module Server
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
97
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
98 - The property `host` in the function `Irccd.Server` has been renamed to
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
99 `hostname`.
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
100
700
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
101 #### Module System
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
102
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
103 - The function `Irccd.System.name` has now well defined return value.