diff options
| author | Sébastien Helleu <flashcode@flashtux.org> | 2022-01-29 10:12:32 +0100 |
|---|---|---|
| committer | Sébastien Helleu <flashcode@flashtux.org> | 2022-01-29 10:12:32 +0100 |
| commit | bf9cf3875fbd70f06b2d166a7b842e45f17f9817 (patch) | |
| tree | e4606e5781463964caba2f9e2c8754ed7fc6f00d /doc/en | |
| parent | fc2f5649509e10b8712387383357cf4ae18fbe2a (diff) | |
| download | weechat-bf9cf3875fbd70f06b2d166a7b842e45f17f9817.zip | |
doc/dev: update format of commit messages for docs
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/weechat_dev.en.adoc | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc index 873d9867f..afe69cd95 100644 --- a/doc/en/weechat_dev.en.adoc +++ b/doc/en/weechat_dev.en.adoc @@ -1120,11 +1120,18 @@ component: fix a problem (closes #123) Where _component_ is one of following: -* WeeChat core: _core_ (files in root directory, _po/_ and _src/_, - except _src/plugins/_) -* documentation files: _doc_ (files in directory _doc/_) -* name of a plugin: _irc_, _python_, _relay_, ... (files in directory - _src/plugins/_) +* WeeChat core: `core` (files in root directory, _po/_ and _src/_, except _src/plugins/_) +* documentation: +** `doc`: general doc updates, for example build +** `doc/man`: man pages +** `doc/faq`: frequently asked questions (FAQ) +** `doc/quickstart`: quickstart guide +** `doc/user`: user's guide +** `doc/scripting`: scripting guide +** `doc/api`: plugin API reference +** `doc/relay`: relay protocol +** `doc/dev`: developer's guide +* plugins: `irc`, `python`, `relay`, ... (files in directory _src/plugins/_) Some rules to follow: @@ -1138,6 +1145,7 @@ Examples of commit messages: ---- core: add callback "nickcmp" for nick comparison in buffers core: update Japanese translations +doc/user: add chapter on typing extension irc: add command /unquiet (closes #36) python: fix crash when unloading a script without pointer to interpreter ruby: add detection of ruby version 1.9.3 in CMake |