Mercurial > irccd

annotate MIGRATING.md @ 845:00a4720c4874

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: rewrite documentation in manual pages, closes #1674 Get rid of markdown documentation and the custom generator tools, instead use raw manual pages.
author David Demelier <markand@malikania.fr>
date Mon, 08 Jul 2019 16:15:57 +0200
parents dc6b42d7b97a
children dcef68d82fd3
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
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.
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
17
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
18 Irccdctl
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
19 --------
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
20
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
21 - 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
22 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
23 - 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
24 - 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
25 - 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
26 - 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
27
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
28 Plugins
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
29 -------
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
30
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
31 ### Logger
577
3d0dbc0bee7d Irccd: update references to onChannel(Mode|Notice), onMode
David Demelier <markand@malikania.fr>
parents: 574
diff changeset
32
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
33 - 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
34 - The keyword `origin` has been added,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
35 - 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
36
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
37 ## Network API
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
38
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
39 - 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
40 `server-notice` and `server-mode` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
41 - 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
42 - 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
43 `hostname`,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
44 - 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
45 - 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
46
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
47 CMake options
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
48 -------------
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
50 - 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
51 external projects,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
52 - 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
53 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
54
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
55 Directories
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
56 -----------
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
57
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
58 - 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
59 **lib(arch)/irccd**.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
60
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
61 Javascript API
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
62 --------------
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
63
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
64 ### Events
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
65
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
66 - 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
67 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
68 - 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
69 - 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
70 - 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
71 of `host`.
486
0b156b82b8c1 Irccd: rework of paths, closes #611
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
73 ### Module Server
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
74
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
75 - 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
76 `Server.mode` and `Server.notice` instead,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
77 - 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
78 - 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
79 instead of `host`.
788
3c090c1ff4f0 irccd: support IPv4, IPv6 in IRC servers, closes #945 @2h
David Demelier <markand@malikania.fr>
parents: 785
diff changeset
80 - 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
81 `hostname`,
5a421b20a4f4 misc: remove ssl verification for now, closes #953 @30m
David Demelier <markand@malikania.fr>
parents: 804
diff changeset
82 - 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
83
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
84 ### Module ElapsedTimer
489
349fe29d86d5 Tests: switch to Boost, closes #680
David Demelier <markand@malikania.fr>
parents: 486
diff changeset
85
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
86 - 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
87 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
88
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
89 ### Module Directory
514
16b9ebfd3f08 Irccd: get rid of fs.hpp, closes #594
David Demelier <markand@malikania.fr>
parents: 489
diff changeset
90
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
91 - 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
92
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
93 ### Module Plugin
574
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
94
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
95 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
96
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
97 - **cachePath** renamed to **paths.cache**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
98 - **configPath** renamed to **paths.config**,
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
99 - **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
100
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
101 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
102 `[paths]` and `[paths.<name>]` sections.
18e80ec38ac7 Irccd: get rid of user/channel separation, closes #734
David Demelier <markand@malikania.fr>
parents: 514
diff changeset
103
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
104 ### Module Server
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
105
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
106 - 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
107 `hostname`.
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
108
844
dc6b42d7b97a misc: update MIGRATING.md
David Demelier <markand@malikania.fr>
parents: 807
diff changeset
109 ### Module System
700
91bc29e87399 Irccd: use Boost.Predef, closes #805 @1h
David Demelier <markand@malikania.fr>
parents: 696
diff changeset
110
785
7145a3df4cb7 misc: rename host to hostname, closes #941 @2h
David Demelier <markand@malikania.fr>
parents: 780
diff changeset
111 - The function `Irccd.System.name` has now well defined return value.