diff options
Diffstat (limited to 'doc/en/weechat_dev.en.asciidoc')
| -rw-r--r-- | doc/en/weechat_dev.en.asciidoc | 103 |
1 files changed, 59 insertions, 44 deletions
diff --git a/doc/en/weechat_dev.en.asciidoc b/doc/en/weechat_dev.en.asciidoc index 6a2e2260b..2dcaec778 100644 --- a/doc/en/weechat_dev.en.asciidoc +++ b/doc/en/weechat_dev.en.asciidoc @@ -21,23 +21,36 @@ light, designed for many operating systems. This manual documents WeeChat internals: -* repository (sources, doc, ...) +* repositories * coding rules * core internals * plugin internals * how to contribute to WeeChat. -[[repository]] -== Repository +[[repositories]] +== Repositories -WeeChat has two main repositories: +WeeChat repositories are on GitHub organization "weechat": +https://github.com/weechat -* core repository: it contains source code and documentation, - URL is: https://github.com/weechat/weechat -* scripts: the 'official' scripts submitted on weechat.org, - URL is: https://github.com/weechat/scripts +List of repositories: -This manual documents only core repository. +weechat:: + core repository with source code and documentation + +scripts:: + the 'official' scripts submitted on weechat.org + +weechat.org:: + source of WeeChat web site: https://weechat.org/ + +weercd:: + IRC testing server + +qweechat:: + Qt remote GUI for WeeChat. + +This manual documents only 'weechat' repository. [[overview]] === Overview @@ -57,17 +70,17 @@ The main WeeChat directories are: | charset/ | Charset plugin | exec/ | Exec plugin | fifo/ | Fifo plugin (FIFO pipe used to remotely send commands to WeeChat) +| guile/ | Guile (scheme) scripting API | irc/ | IRC (Internet Relay Chat) plugin +| javascript/ | Javascript scripting API | logger/ | Logger plugin (write messages displayed to files) -| relay/ | Relay plugin (irc proxy + relay for remote interfaces) -| script/ | Scripts manager -| python/ | Python scripting API +| lua/ | Lua scripting API | perl/ | Perl scripting API +| python/ | Python scripting API +| relay/ | Relay plugin (irc proxy + relay for remote interfaces) | ruby/ | Ruby scripting API -| lua/ | Lua scripting API +| script/ | Scripts manager | tcl/ | Tcl scripting API -| guile/ | Guile (scheme) scripting API -| javascript/ | Javascript scripting API | trigger/ | Trigger plugin | xfer/ | Xfer plugin (IRC DCC file/chat) | tests/ | Tests @@ -93,7 +106,6 @@ WeeChat "core" is located in following directories: |=== | Path/file | Description | core/ | Core functions: entry point, internal structures -| weechat.c | Main functions: command line options, startup | wee-arraylist.c | Array lists | wee-backtrace.c | Display a backtrace after a crash | wee-command.c | WeeChat core commands @@ -119,6 +131,7 @@ WeeChat "core" is located in following directories: | wee-utf8.c | UTF-8 functions | wee-util.c | Some other functions | wee-version.c | Functions for WeeChat version +| weechat.c | Main functions: command line options, startup | gui/ | Functions for buffers, windows, ... (used by all interfaces) | gui-bar-item.c | Bar items | gui-bar-window.c | Bar windows @@ -296,20 +309,21 @@ WeeChat "core" is located in following directories: [width="100%",cols="1v,5",options="header"] |=== -| Path/file | Description -| tests/ | Root of tests -| tests.cpp | Program used to run tests -| unit/ | Root of unit tests -| core/ | Root of unit tests for core -| test-eval.cpp | Tests: evaluation of expressions -| test-hashtble.cpp | Tests: hashtables -| test-hdata.cpp | Tests: hdata -| test-infolist.cpp | Tests: infolists -| test-list.cpp | Tests: lists -| test-string.cpp | Tests: strings -| test-url.cpp | Tests: URLs -| test-utf8.cpp | Tests: UTF-8 -| test-util.cpp | Tests: utility functions +| Path/file | Description +| tests/ | Root of tests +| tests.cpp | Program used to run tests +| unit/ | Root of unit tests +| core/ | Root of unit tests for core +| test-arraylist.cpp | Tests: arraylists +| test-eval.cpp | Tests: evaluation of expressions +| test-hashtble.cpp | Tests: hashtables +| test-hdata.cpp | Tests: hdata +| test-infolist.cpp | Tests: infolists +| test-list.cpp | Tests: lists +| test-string.cpp | Tests: strings +| test-url.cpp | Tests: URLs +| test-utf8.cpp | Tests: UTF-8 +| test-util.cpp | Tests: utility functions |=== [[documentation_translations]] @@ -325,16 +339,16 @@ Documentation files: | asciidoc.css | Asciidoc style | docgen.py | Python script to build files in 'autogen/' directory (see below) | XX/ | Documentation for language XX (languages: en, fr, de, it, ...) +| cmdline_options.XX.asciidoc | Command-line options (file included in man page and user's guide) | weechat.1.XX.asciidoc | Man page (`man weechat`) -| weechat_quickstart.XX.asciidoc | Quickstart guide -| weechat_user.XX.asciidoc | User's guide +| weechat_dev.XX.asciidoc | Developer's guide (this document) | weechat_faq.XX.asciidoc | FAQ | weechat_plugin_api.XX.asciidoc | Plugin API reference +| weechat_quickstart.XX.asciidoc | Quickstart guide +| weechat_relay_protocol.XX.asciidoc | Relay protocol (for remote interfaces) | weechat_scripting.XX.asciidoc | Scripting guide | weechat_tester.XX.asciidoc | Tester's guide -| weechat_dev.XX.asciidoc | Developer's guide (this document) -| weechat_relay_protocol.XX.asciidoc | Relay protocol (for remote interfaces) -| cmdline_options.XX.asciidoc | Command-line options (file included in man page and user's guide) +| weechat_user.XX.asciidoc | User's guide | autogen/ | Files auto-built with script docgen.py | user/ | Files auto-built for user's guide (do *NEVER* update manually!) | plugin_api/ | Files auto-built for plugin API (do *NEVER* update manually!) @@ -576,12 +590,13 @@ new_hook_fd = malloc (sizeof (*new_hook_fd)); [source,lisp] ---- -(add-hook 'c-mode-common-hook '(lambda () - (c-toggle-hungry-state t) - (c-set-style "k&r") - (setq c-basic-offset 4 - c-tab-always-indent t) - (c-set-offset 'case-label '+))) +(add-hook 'c-mode-common-hook + '(lambda () + (c-toggle-hungry-state t) + (c-set-style "k&r") + (setq c-basic-offset 4) + (c-tab-always-indent t) + (c-set-offset 'case-label '+))) ---- [[coding_python_style]] @@ -950,9 +965,9 @@ server->hook_timer_sasl = weechat_hook_timer (timeout * 1000, Git repository is at this URL: https://github.com/weechat/weechat -Any patch for bug or new feature must be done on master branch, preferred way is -a GitHub pull request. A patch can also be sent by e-mail (made with `git diff` -or `git format-patch`). +Any patch for bug or new feature must be done on master branch, preferred way +is a GitHub pull request. A patch can also be sent by e-mail +(made with `git diff` or `git format-patch`). Format of commit message is the following (to close a GitHub issue): |