Mercurial > irccd

annotate MIGRATING.md @ 1100:792730ae5c77

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cmake: improve IDE structure
author David Demelier <markand@malikania.fr>
date Sun, 03 Oct 2021 13:52:07 +0200
parents 509bcfb14670
children
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
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
6 Migrating from 3.x to 4.x
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
7 =========================
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
8
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
9 Irccd
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
10 -----
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
11
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
12 - The `irccd.conf` is now using a custom syntax.
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
13 - There are no longer TCP/IP transports. SSL support for transports has been
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
14 removed too. Only clear UNIX socket are available, use file permissions
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
15 instead of a password.
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
16
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
17 Irccdctl
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
18 --------
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
19
974
342fb90f2512 irccdctl: re-implement many of the plugin-* commands
David Demelier <markand@malikania.fr>
parents: 963
diff changeset
20 - There is no longer configuration file because it now use a plain UNIX socket
342fb90f2512 irccdctl: re-implement many of the plugin-* commands
David Demelier <markand@malikania.fr>
parents: 963
diff changeset
21 to */tmp/irccd.sock* by default (may be changed through the `-s` option).
342fb90f2512 irccdctl: re-implement many of the plugin-* commands
David Demelier <markand@malikania.fr>
parents: 963
diff changeset
22 - Aliases have been removed, please use shell scripts or aliases instead.
342fb90f2512 irccdctl: re-implement many of the plugin-* commands
David Demelier <markand@malikania.fr>
parents: 963
diff changeset
23 - The `watch` command no longer produce JSON output but only the original
342fb90f2512 irccdctl: re-implement many of the plugin-* commands
David Demelier <markand@malikania.fr>
parents: 963
diff changeset
24 "human" format but may be used for scripts as it is honored through the
342fb90f2512 irccdctl: re-implement many of the plugin-* commands
David Demelier <markand@malikania.fr>
parents: 963
diff changeset
25 semantic versioning.
975
5ffc8350e84b irccdctl: add support for rule editing
David Demelier <markand@malikania.fr>
parents: 974
diff changeset
26 - The command `rule-info` has been removed because it is mostly the same as
5ffc8350e84b irccdctl: add support for rule editing
David Demelier <markand@malikania.fr>
parents: 974
diff changeset
27 `rule-list`.
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1004
diff changeset
28 - The command `server-mode` signature has changed because it was mostly unusable
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1004
diff changeset
29 before.
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
30
962
63208f5bb0f6 misc: update markdown files
David Demelier <markand@malikania.fr>
parents: 947
diff changeset
31 Platform support
63208f5bb0f6 misc: update markdown files
David Demelier <markand@malikania.fr>
parents: 947
diff changeset
32 ----------------
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
33
962
63208f5bb0f6 misc: update markdown files
David Demelier <markand@malikania.fr>
parents: 947
diff changeset
34 Windows support is now completely obsolescent because the code make excessive
63208f5bb0f6 misc: update markdown files
David Demelier <markand@malikania.fr>
parents: 947
diff changeset
35 use of POSIX APIs.
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
36
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
37 Network API
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
38 -----------
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
39
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
40 The network protocol no longer uses JSON but a plain text syntax with one line
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
41 per command.
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
42
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
43 Example:
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
44
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
45 SERVER-MESSAGE freenode #staff hello world
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
46 SERVER-LIST
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
47
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
48 Javascript API
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
49 --------------
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
50
1002
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents: 984
diff changeset
51 ### Module Irccd
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents: 984
diff changeset
52
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents: 984
diff changeset
53 - The property `Irccd.version` and their properties have been renamed to
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents: 984
diff changeset
54 `CamelCase` for consistency with other constants from other modules.
ec5461750efd man: add Irccd.Rule and Irccd.Hook manual pages
David Demelier <markand@malikania.fr>
parents: 984
diff changeset
55
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
56 ### Module File
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
57
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
58 - The method `File.readline` is no longer marked as slow.
963
371e1cc2c697 tests: add 80% of the Javascript API
David Demelier <markand@malikania.fr>
parents: 962
diff changeset
59 - Methods `File.lines`, `File.read`, `File.readline` and `File.seek`, now throw
371e1cc2c697 tests: add 80% of the Javascript API
David Demelier <markand@malikania.fr>
parents: 962
diff changeset
60 an exception if the file was closed.
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
61
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
62 ### Module Chrono
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
63
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
64 - The `Chrono.elapsed()` method is now a property named `elapsed`.
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
65 - All methods have been removed except `Chrono.reset`.
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
66
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
67 ### Module Util
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
68
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
69 - The method `Util.ticks` as been removed.
963
371e1cc2c697 tests: add 80% of the Javascript API
David Demelier <markand@malikania.fr>
parents: 962
diff changeset
70 - The method `Util.cut` now throws a `RangeError` exception if the number of
371e1cc2c697 tests: add 80% of the Javascript API
David Demelier <markand@malikania.fr>
parents: 962
diff changeset
71 lines exceed `maxl` argument instead of returning null.
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
72
947
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
73 ### Module Server
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
74
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
75 - The property `channels` in the object returned from `Server.info` is now an
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
76 array of objects which also contain a list of nicknames present in the
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
77 channel.
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
78 - The property `channels` in the object for the `Server` constructor now takes
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
79 an array of objects containing two properties each: `name` and `password`
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
80 which must be string (password is optional).
984
2e4b29ab8e9c irccd: add prefix support in configuration
David Demelier <markand@malikania.fr>
parents: 975
diff changeset
81 - The property `commandChar` which is provided in both the `Server` constructor
2e4b29ab8e9c irccd: add prefix support in configuration
David Demelier <markand@malikania.fr>
parents: 975
diff changeset
82 and the `Server.info` returned object has been renamed to `prefix`.
1004
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
83 - The event `onMode` now takes four arguments: server, channel, mode and list
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
84 of arguments to the mode. The previous signature was mostly unusable.
1030
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1004
diff changeset
85 - The method `Server.mode` has a different signature because it was mostly
509bcfb14670 misc: change signature to change mode
David Demelier <markand@malikania.fr>
parents: 1004
diff changeset
86 unusable.
1004
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
87
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
88 Plugins
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
89 -------
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
90
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
91 **logger**
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
92
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
93 - Due to the `onMode` change the template `mode` no longer takes `limit`,
3ea3361f0fc7 irccd: now track modes
David Demelier <markand@malikania.fr>
parents: 1002
diff changeset
94 `user` and `mask` but a string `args` instead.
947
95201fd9ad88 irccd: servers are now linked lists
David Demelier <markand@malikania.fr>
parents: 943
diff changeset
95
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 Migrating from 2.x to 3.x
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
97 =========================
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
98
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
99 Irccd
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
100 -----
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
101
851
7c5898a79671 misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
102 - 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
103 - 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
104 `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
105 - 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
106 - 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
107 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
108 - 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
109 `[templates]`.
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
110
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
111 Irccdctl
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
112 --------
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
113
851
7c5898a79671 misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
114 - Long options have been removed.
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
115 - 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
116 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
117 - 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
118 - The output style has been unified,
851
7c5898a79671 misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
119 - Options `-S` in server-connect have been removed, also
7c5898a79671 misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 850
diff changeset
120 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
121 - 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
122 name.
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
123
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
124 Plugins
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
125 -------
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
126
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
127 ### Logger
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
128
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
129 - 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
130 - The keyword `origin` has been added,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
131 - 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
132 - 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
133
943
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
134 Network API
aef1568a76bf misc: update CHANGES and MIGRATING
David Demelier <markand@malikania.fr>
parents: 862
diff changeset
135 -----------
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
136
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
137 - 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
138 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
139 - 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
140 - 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
141 `hostname`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
142 - 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
143 - 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
144
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
145 CMake options
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
146 -------------
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
147
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
148 - 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
149 external projects,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
150 - 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
151 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
152
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
153 Directories
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
154 -----------
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
155
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
156 - 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
157 **lib(arch)/irccd**.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
158
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
159 Javascript API
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
160 --------------
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
161
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
162 ### Events
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
163
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
164 - 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
165 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
166 - 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
167 - 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
168 - 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
169 of `host`.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
170
846
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
171 ### Module Chrono
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
172
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
173 - 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
174 - 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
175 ambiguity,
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
176 - 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
177 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
178
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
179 ### Module Directory
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
180
dcef68d82fd3 irccd: rework Irccd.ElapsedTimer -> Irccd.Chrono API, closes #1667
David Demelier <markand@malikania.fr>
parents: 845
diff changeset
181 - 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
182
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
183 ### Module Server
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
184
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
185 - 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
186 `Server.mode` and `Server.notice` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
187 - 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
188 - 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
189 instead of `host`.
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
190 - 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
191 `hostname`,
5a421b20a4f4 misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents: 804
diff changeset
192 - 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
193
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
194 ### Module Plugin
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
195
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
196 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
197
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
198 - **cachePath** renamed to **paths.cache**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
199 - **configPath** renamed to **paths.config**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
200 - **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
201
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
202 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
203 `[paths]` and `[paths.<name>]` sections.
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
204
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
205 ### Module Server
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
206
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
207 - 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
208 `hostname`.
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
209
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
210 ### Module System
700
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
211
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
212 - The function `Irccd.System.name` has now well defined return value.