Mercurial > irccd
annotate MIGRATING.md @ 887:d1cfe59eed06 release-3.0 3.0.1
misc: update before 3.0.1
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 01 Sep 2019 17:08:59 +0200 |
parents | 6b65493d97cf |
children | aef1568a76bf |
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 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
7 ========================= |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
9 Irccd |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
10 ----- |
788
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
11 |
851
7c5898a79671
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
850
diff
changeset
|
12 - Long options have been removed. |
788
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
13 - 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
|
14 `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
|
15 - 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
|
16 - 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
|
17 each server in their `[server]` section. |
847
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
846
diff
changeset
|
18 - The section `[format]` and their respective plugin counterparts are renamed to |
a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
David Demelier <markand@malikania.fr>
parents:
846
diff
changeset
|
19 `[templates]`. |
788
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
20 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
21 Irccdctl |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
22 -------- |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
23 |
851
7c5898a79671
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
850
diff
changeset
|
24 - Long options have been removed. |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
25 - 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
|
26 `server-notice` and `server-mode` instead, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
27 - The option `connect.host` has been renamed to `connect.hostname`, |
807
5a421b20a4f4
misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents:
804
diff
changeset
|
28 - The output style has been unified, |
851
7c5898a79671
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
850
diff
changeset
|
29 - Options `-S` in server-connect have been removed, also |
7c5898a79671
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
850
diff
changeset
|
30 the port option is now specified with `-p` instead of a positional argument. |
850
688f28dd3241
irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
31 - Connection options are now order dependant and must be set before the command |
688f28dd3241
irccd: remove short options, closes #1673
David Demelier <markand@malikania.fr>
parents:
847
diff
changeset
|
32 name. |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
33 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
34 Plugins |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
35 ------- |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
574
diff
changeset
|
36 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
37 ### Logger |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
574
diff
changeset
|
38 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
39 - 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
|
40 - The keyword `origin` has been added, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
41 - Formats `cnotice`, `cmode`, `query` have been removed. |
862
6b65493d97cf
plugin logger: rename path configuration to file, closes #1670
David Demelier <markand@malikania.fr>
parents:
851
diff
changeset
|
42 - The option `path` has been renamed to `file`. |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
574
diff
changeset
|
43 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
44 ## Network API |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
45 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
46 - 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
|
47 `server-notice` and `server-mode` instead, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
48 - 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
|
49 - 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
|
50 `hostname`, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
51 - 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
|
52 - 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
|
53 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
54 CMake options |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
55 ------------- |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
56 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
57 - 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
|
58 external projects, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
59 - 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
|
60 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
|
61 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
62 Directories |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
63 ----------- |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
64 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
65 - The default plugins path has been changed from **share/irccd/plugins** to |
845
00a4720c4874
doc: rewrite documentation in manual pages, closes #1674
David Demelier <markand@malikania.fr>
parents:
844
diff
changeset
|
66 **lib(arch)/irccd**. |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
68 Javascript API |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
69 -------------- |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
70 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
71 ### Events |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
72 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
73 - 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
|
74 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
|
75 - 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
|
76 - 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
|
77 - 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
|
78 of `host`. |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
79 |
846
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
80 ### Module Chrono |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
81 |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
82 - The module `ElapsedTimer` has been renamed to `Chrono`, |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
83 - The method `Chrono.restart` has been renamed to `Chrono.resume` to reduce |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
84 ambiguity, |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
85 - The method `Chrono.reset` has been removed, just use `Chrono.start` instead |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
86 when you want to start accumulate time again. |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
87 |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
88 ### Module Directory |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
89 |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
90 - The property `Directory.count` has been removed. |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
91 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
92 ### Module Server |
489
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
93 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
94 - 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
|
95 `Server.mode` and `Server.notice` instead, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
96 - 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
|
97 - 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
|
98 instead of `host`. |
788
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
99 - The property `host` in constructor `Server` has been renamed to |
807
5a421b20a4f4
misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents:
804
diff
changeset
|
100 `hostname`, |
5a421b20a4f4
misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents:
804
diff
changeset
|
101 - The property `sslVerify` in `Server` constructor has been removed. |
489
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
102 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
103 ### Module Plugin |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
104 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
105 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
|
106 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
107 - **cachePath** renamed to **paths.cache**, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
108 - **configPath** renamed to **paths.config**, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
109 - **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
|
110 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
111 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
|
112 `[paths]` and `[paths.<name>]` sections. |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
113 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
114 ### Module Server |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
115 |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
116 - 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
|
117 `hostname`. |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
118 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
119 ### Module System |
700
91bc29e87399
Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents:
696
diff
changeset
|
120 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
121 - The function `Irccd.System.name` has now well defined return value. |