Mercurial > irccd
annotate MIGRATING.md @ 847:a23b7b574ed2
irccd: rename [format] section to [templates], closes #1671
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 10 Jul 2019 20:10:00 +0200 |
parents | dcef68d82fd3 |
children | 688f28dd3241 |
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 |
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
12 - 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
|
13 `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
|
14 - 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
|
15 - 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
|
16 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
|
17 - 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
|
18 `[templates]`. |
788
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
19 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
20 Irccdctl |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
21 -------- |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
22 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
23 - 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
|
24 `server-notice` and `server-mode` instead, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
25 - 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
|
26 - The option `--host` has been renamed to `--hostname`, |
807
5a421b20a4f4
misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents:
804
diff
changeset
|
27 - The output style has been unified, |
5a421b20a4f4
misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents:
804
diff
changeset
|
28 - Options `-S` and `--ssl-verify` in server-connect have been removed. |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
29 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
30 Plugins |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
31 ------- |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
574
diff
changeset
|
32 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
33 ### Logger |
577
3d0dbc0bee7d
Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents:
574
diff
changeset
|
34 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
35 - 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
|
36 - The keyword `origin` has been added, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
37 - 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
|
38 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
39 ## Network API |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
40 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
41 - 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
|
42 `server-notice` and `server-mode` instead, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
43 - 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
|
44 - 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
|
45 `hostname`, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
46 - 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
|
47 - 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
|
48 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
49 CMake options |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
50 ------------- |
486
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 - 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
|
53 external projects, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
54 - 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
|
55 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
|
56 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
57 Directories |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
58 ----------- |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
59 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
60 - 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
|
61 **lib(arch)/irccd**. |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
62 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
63 Javascript API |
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
64 -------------- |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
65 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
66 ### Events |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
67 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
68 - 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
|
69 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
|
70 - 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
|
71 - 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
|
72 - 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
|
73 of `host`. |
486
0b156b82b8c1
Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
74 |
846
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
75 ### Module Chrono |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
76 |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
77 - 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
|
78 - 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
|
79 ambiguity, |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
80 - 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
|
81 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
|
82 |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
83 ### Module Directory |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
84 |
dcef68d82fd3
irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents:
845
diff
changeset
|
85 - 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
|
86 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
87 ### Module Server |
489
349fe29d86d5
Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents:
486
diff
changeset
|
88 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
89 - 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
|
90 `Server.mode` and `Server.notice` instead, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
91 - 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
|
92 - 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
|
93 instead of `host`. |
788
3c090c1ff4f0
irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents:
785
diff
changeset
|
94 - 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
|
95 `hostname`, |
5a421b20a4f4
misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents:
804
diff
changeset
|
96 - 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
|
97 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
98 ### Module Plugin |
574
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
99 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
100 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
|
101 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
102 - **cachePath** renamed to **paths.cache**, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
103 - **configPath** renamed to **paths.config**, |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
104 - **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
|
105 |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
106 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
|
107 `[paths]` and `[paths.<name>]` sections. |
18e80ec38ac7
Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents:
514
diff
changeset
|
108 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
109 ### Module Server |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
110 |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
111 - 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
|
112 `hostname`. |
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
113 |
844
dc6b42d7b97a
misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents:
807
diff
changeset
|
114 ### Module System |
700
91bc29e87399
Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents:
696
diff
changeset
|
115 |
785
7145a3df4cb7
misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents:
780
diff
changeset
|
116 - The function `Irccd.System.name` has now well defined return value. |