Mercurial > irccd

comparison MIGRATING.md @ 943:aef1568a76bf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: update CHANGES and MIGRATING
author David Demelier <markand@malikania.fr>
date Thu, 14 Jan 2021 18:56:00 +0100
parents 6b65493d97cf
children 95201fd9ad88
comparison
equal deleted inserted replaced
942:d6febe682db7 943:aef1568a76bf
1 IRC Client Daemon MIGRATING 1 IRC Client Daemon MIGRATING
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
6 Migrating from 3.x to 4.x
7 =========================
8
9 Irccd
10 -----
11
12 - The `irccd.conf` is now using a custom syntax.
13 - There are no longer TCP/IP transports. SSL support for transports has been
14 removed too. Only clear UNIX socket are available, use file permissions
15 instead of a password.
16
17 Irccdctl
18 --------
19
20 The `irccdctl.conf` is now using a custom syntax.
21
22 Build system and platform support
23 ---------------------------------
24
25 The build system has been switched from CMake to GNU make. Windows support is
26 now completely obsolescent because the code make excessive use of POSIX
27 specification.
28
29 Network API
30 -----------
31
32 The network protocol no longer uses JSON but a plain text syntax with one line
33 per command.
34
35 Example:
36
37 SERVER-MESSAGE freenode #staff hello world
38 SERVER-LIST
39
40 Javascript API
41 --------------
42
43 ### Module File
44
45 - The method `File.readline` is no longer marked as slow.
46
47 ### Module Chrono
48
49 - The `Chrono.elapsed()` method is now a property named `elapsed`.
50 - All methods have been removed except `Chrono.reset`.
51
52 ### Module Util
53
54 - The method `Util.ticks` as been removed.
5 55
6 Migrating from 2.x to 3.x 56 Migrating from 2.x to 3.x
7 ========================= 57 =========================
8 58
9 Irccd 59 Irccd
39 - The keyword `source` has been removed and replaced by `channel`, 89 - The keyword `source` has been removed and replaced by `channel`,
40 - The keyword `origin` has been added, 90 - The keyword `origin` has been added,
41 - Formats `cnotice`, `cmode`, `query` have been removed. 91 - Formats `cnotice`, `cmode`, `query` have been removed.
42 - The option `path` has been renamed to `file`. 92 - The option `path` has been renamed to `file`.
43 93
44 ## Network API 94 Network API
95 -----------
45 96
46 - The requests `server-cnotice` and `server-cmode` have been removed, use 97 - The requests `server-cnotice` and `server-cmode` have been removed, use
47 `server-notice` and `server-mode` instead, 98 `server-notice` and `server-mode` instead,
48 - The request `server-mode` command requires a new argument `channel`. 99 - The request `server-mode` command requires a new argument `channel`.
49 - The property `host` in request `server-connect` has been renamed to 100 - The property `host` in request `server-connect` has been renamed to