summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2022-01-29 10:12:32 +0100
committerSébastien Helleu <flashcode@flashtux.org>2022-01-29 10:12:32 +0100
commitbf9cf3875fbd70f06b2d166a7b842e45f17f9817 (patch)
treee4606e5781463964caba2f9e2c8754ed7fc6f00d /doc
parentfc2f5649509e10b8712387383357cf4ae18fbe2a (diff)
downloadweechat-bf9cf3875fbd70f06b2d166a7b842e45f17f9817.zip
doc/dev: update format of commit messages for docs
Diffstat (limited to 'doc')
-rw-r--r--doc/en/weechat_dev.en.adoc18
-rw-r--r--doc/fr/weechat_dev.fr.adoc19
-rw-r--r--doc/ja/weechat_dev.ja.adoc17
-rw-r--r--doc/sr/weechat_dev.sr.adoc16
4 files changed, 53 insertions, 17 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
diff --git a/doc/fr/weechat_dev.fr.adoc b/doc/fr/weechat_dev.fr.adoc
index 6f914cddf..6438dfb9d 100644
--- a/doc/fr/weechat_dev.fr.adoc
+++ b/doc/fr/weechat_dev.fr.adoc
@@ -1140,11 +1140,20 @@ component: fix a problem (closes #123)
Où _component_ est :
-* pour le cœur WeeChat : _core_ (les fichiers dans le répertoire racine, _po/_
- et _src/_, sauf _src/plugins/_)
-* fichiers de documentation : _doc_ (fichiers dans le répertoire _doc/_)
-* nom d'une extension : _irc_, _python_, _relay_, ... (fichiers dans le
- répertoire _src/plugins/_)
+* cœur de WeeChat : `core`
+ (les fichiers dans le répertoire racine, _po/_ et _src/_, sauf _src/plugins/_)
+* documentation :
+** `doc` : mise à jour générales sur la documentation, par exemple la construction
+** `doc/man` : pages de manuel
+** `doc/faq` : questions fréquemment posées (FAQ)
+** `doc/quickstart` : guide de démarrage rapide
+** `doc/user` : guide utilisateur
+** `doc/scripting` : guide pour scripts
+** `doc/api` : référence extension API
+** `doc/relay` : protocole relay
+** `doc/dev` : guide du développeur
+* extensions : `irc`, `python`, `relay`, ...
+ (fichiers dans le répertoire _src/plugins/_)
Quelques règles à suivre :
diff --git a/doc/ja/weechat_dev.ja.adoc b/doc/ja/weechat_dev.ja.adoc
index 4a2eca3d1..88bffe35c 100644
--- a/doc/ja/weechat_dev.ja.adoc
+++ b/doc/ja/weechat_dev.ja.adoc
@@ -1172,10 +1172,19 @@ component: fix a problem (closes #123)
_component_ には以下から 1 つ選んで記入してください:
-* WeeChat コア: _core_ (ルートディレクトリ、_po/_ ディレクトリ、_src/_
- ディレクトリに含まれるファイル、ただし _src/plugins/_ 内のファイルを除く)
-* 文書ファイル: _doc_ (_doc/_ ディレクトリに含まれるファイル)
-* プラグインの名前: _irc_、_python_、_relay_、... (_src/plugins/_ ディレクトリに含まれるファイル)
+// TRANSLATION MISSING
+* 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/_)
以下のルールに従ってください:
diff --git a/doc/sr/weechat_dev.sr.adoc b/doc/sr/weechat_dev.sr.adoc
index 965f90790..516bd6bd2 100644
--- a/doc/sr/weechat_dev.sr.adoc
+++ b/doc/sr/weechat_dev.sr.adoc
@@ -1087,9 +1087,19 @@ Git репозиторијум се налази на следећој URL ад
Где је _компонента_ једно од следећег:
-* WeeChat језгро: _core_ (фајлови у кореном директоријуму, _po/_ и _src/_, осим _src/plugins/_)
-* фајлови документације: _doc_ (фајлови у директоријуму _doc/_)
-* име додатка: _irc_, _python_, _relay_, ... (фајлови у директоријуму _src/plugins/_)
+// TRANSLATION MISSING
+* 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/_)
Нека правила која треба да поштујете: