Mercurial > irccd

comparison MIGRATING.md @ 844:dc6b42d7b97a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: update MIGRATING.md
author David Demelier <markand@malikania.fr>
date Tue, 09 Jul 2019 15:04:04 +0200
parents 5a421b20a4f4
children 00a4720c4874
comparison
equal deleted inserted replaced
843:497eca78800c 844:dc6b42d7b97a
2 =========================== 2 ===========================
3 3
4 This document is a small guide to help you migrating to a next major version. 4 This document is a small guide to help you migrating to a next major version.
5 5
6 Migrating from 2.x to 3.x 6 Migrating from 2.x to 3.x
7 ------------------------- 7 =========================
8 8
9 ### Irccd 9 Irccd
10 -----
10 11
11 - The option `reconnect-tries` has been removed from `[server]` section, use 12 - The option `reconnect-tries` has been removed from `[server]` section, use
12 `auto-reconnect` boolean option instead, 13 `auto-reconnect` boolean option instead,
13 - The option `reconnect-timeout` has been renamed to `auto-reconnect-delay`. 14 - The option `reconnect-timeout` has been renamed to `auto-reconnect-delay`.
14 - The section `[identity]` has been removed, instead move those values inside 15 - The section `[identity]` has been removed, instead move those values inside
15 each server in their `[server]` section. 16 each server in their `[server]` section.
16 17
17 ### Irccdctl 18 Irccdctl
19 --------
18 20
19 - The functions `server-cnotice` and `server-cmode` have been removed, use 21 - The functions `server-cnotice` and `server-cmode` have been removed, use
20 `server-notice` and `server-mode` instead, 22 `server-notice` and `server-mode` instead,
21 - The option `connect.host` has been renamed to `connect.hostname`, 23 - The option `connect.host` has been renamed to `connect.hostname`,
22 - The option `--host` has been renamed to `--hostname`, 24 - The option `--host` has been renamed to `--hostname`,
23 - The output style has been unified, 25 - The output style has been unified,
24 - Options `-S` and `--ssl-verify` in server-connect have been removed. 26 - Options `-S` and `--ssl-verify` in server-connect have been removed.
25 27
26 ### Plugins 28 Plugins
29 -------
27 30
28 #### Logger 31 ### Logger
29 32
30 - The keyword `source` has been removed and replaced by `channel`, 33 - The keyword `source` has been removed and replaced by `channel`,
31 - The keyword `origin` has been added, 34 - The keyword `origin` has been added,
32 - Formats `cnotice`, `cmode`, `query` have been removed. 35 - Formats `cnotice`, `cmode`, `query` have been removed.
33 36
34 ### Network API 37 ## Network API
35 38
36 - The requests `server-cnotice` and `server-cmode` have been removed, use 39 - The requests `server-cnotice` and `server-cmode` have been removed, use
37 `server-notice` and `server-mode` instead, 40 `server-notice` and `server-mode` instead,
38 - The request `server-mode` command requires a new argument `channel`. 41 - The request `server-mode` command requires a new argument `channel`.
39 - The property `host` in request `server-connect` has been renamed to 42 - The property `host` in request `server-connect` has been renamed to
40 `hostname`, 43 `hostname`,
41 - The request `server-info` sends `hostname` property instead of `host`, 44 - The request `server-info` sends `hostname` property instead of `host`,
42 - The event `onWhois` sends `hostname` property instead of `host`, 45 - The event `onWhois` sends `hostname` property instead of `host`,
43 46
44 ### CMake options 47 CMake options
48 -------------
45 49
46 - All options are now starting with `IRCCD_` for better compatibility with 50 - All options are now starting with `IRCCD_` for better compatibility with
47 external projects, 51 external projects,
48 - CMake now use GNUInstallDirs module to specify installation paths, all 52 - CMake now use GNUInstallDirs module to specify installation paths, all
49 IRCCD\_WITH\_ options have been replaced by CMAKE\_INSTALL\_ equivalents. 53 IRCCD\_WITH\_ options have been replaced by CMAKE\_INSTALL\_ equivalents.
50 54
51 ### Paths 55 Directories
56 -----------
52 57
53 - The default plugins path has been changed from **share/irccd/plugins** to 58 - The default plugins path has been changed from **share/irccd/plugins** to
54 **lib64/irccd**. 59 **lib64/irccd**.
55 60
56 ### Javascript API 61 Javascript API
62 --------------
57 63
58 #### Events 64 ### Events
59 65
60 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins 66 - The events `onChannelMode` and `onChannelNotice` have been removed, plugins
61 must use `Server.isSelf(target)` to determine a channel/private message, 67 must use `Server.isSelf(target)` to determine a channel/private message,
62 - The event `onNotice` takes a new `channel` argument, 68 - The event `onNotice` takes a new `channel` argument,
63 - The event `onMode` takes new `channel`, `limit`, `user`, `mask` arguments, 69 - The event `onMode` takes new `channel`, `limit`, `user`, `mask` arguments,
64 - The object information in `onWhois` event now has `hostname` property instead 70 - The object information in `onWhois` event now has `hostname` property instead
65 of `host`. 71 of `host`.
66 72
67 #### Module Server 73 ### Module Server
68 74
69 - The methods `Server.cmode` and `Server.cnotice` have been removed, use 75 - The methods `Server.cmode` and `Server.cnotice` have been removed, use
70 `Server.mode` and `Server.notice` instead, 76 `Server.mode` and `Server.notice` instead,
71 - The method `Server.mode` requires a new argument `channel`, 77 - The method `Server.mode` requires a new argument `channel`,
72 - The object returned in the method `Server.info` now has a `hostname` property 78 - The object returned in the method `Server.info` now has a `hostname` property
73 instead of `host`. 79 instead of `host`.
74 - The property `host` in constructor `Server` has been renamed to 80 - The property `host` in constructor `Server` has been renamed to
75 `hostname`, 81 `hostname`,
76 - The property `sslVerify` in `Server` constructor has been removed. 82 - The property `sslVerify` in `Server` constructor has been removed.
77 83
78 #### Module ElapsedTimer 84 ### Module ElapsedTimer
79 85
80 - The method ElapsedTimer.reset has been removed, just use `start` instead 86 - The method ElapsedTimer.reset has been removed, just use `start` instead
81 when you want to accumulate time. 87 when you want to accumulate time.
82 88
83 #### Module Directory 89 ### Module Directory
84 90
85 - The property `Directory.count` has been removed. 91 - The property `Directory.count` has been removed.
86 92
87 #### Module Plugin 93 ### Module Plugin
88 94
89 The following properties in `Irccd.Plugin` has been renamed: 95 The following properties in `Irccd.Plugin` has been renamed:
90 96
91 - **cachePath** renamed to **paths.cache**, 97 - **cachePath** renamed to **paths.cache**,
92 - **configPath** renamed to **paths.config**, 98 - **configPath** renamed to **paths.config**,
93 - **dataPath** renamed to **paths.data**. 99 - **dataPath** renamed to **paths.data**.
94 100
95 Note: these paths are no more automatically detected and set with the new 101 Note: these paths are no more automatically detected and set with the new
96 `[paths]` and `[paths.<name>]` sections. 102 `[paths]` and `[paths.<name>]` sections.
97 103
98 #### Module Server 104 ### Module Server
99 105
100 - The property `host` in the function `Irccd.Server` has been renamed to 106 - The property `host` in the function `Irccd.Server` has been renamed to
101 `hostname`. 107 `hostname`.
102 108
103 #### Module System 109 ### Module System
104 110
105 - The function `Irccd.System.name` has now well defined return value. 111 - The function `Irccd.System.name` has now well defined return value.