irc: return git version in CTCP VERSION and FINGER by default, add "$git" and "$versiongit" in format of CTCP replies

7 files changed, 186 insertions, 87 deletions

diff --git a/ChangeLog b/ChangeLog
index 15859229c..f0ff865aa 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -50,6 +50,8 @@ Version 0.4.0 (under dev!)
   aspell.check.suggestions (task #12061)
 * aspell: fix creation of spellers when number of dictionaries is different
   between two buffers
+* irc: return git version in CTCP VERSION and FINGER by default, add "$git"
+  and "$versiongit" in format of CTCP replies
 * irc: read local variable "autorejoin" in buffer to override server option
   "autorejoin" (task #12256)
 * irc: add option "-auto" for command /connect (task #9340)
diff --git a/doc/de/weechat_user.de.txt b/doc/de/weechat_user.de.txt
index ddf8711b1..0e19c238a 100644
--- a/doc/de/weechat_user.de.txt
+++ b/doc/de/weechat_user.de.txt
@@ -1993,31 +1993,40 @@ dann müssen Sie lediglich die Option löschen:
 Folgende Platzhalter können in den CTCP-Antworten genutzt werden. Diese werden dann
 mit dem entsprechenden Wert ersetzt:
 
+// TRANSLATION MISSING ($versiongit + $git + $username (name))
 [width="100%",cols="^2l,4,8l",options="header"]
 |========================================
-| Platzhalter  | Beschreibung              | Wert/Beispiel
-| $clientinfo  | Liste der CTCP Antworten  | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| $version     | WeeChat Version           | 0.3.0
-| $compilation | Datum der Kompilierung    | Sep 13 2009
-| $osinfo      | Info über das genutzte OS | Linux 2.6.31 / i686
-| $site        | WeeChat Seite             | http://www.weechat.org
-| $download    | WeeChat, download Seite   | http://www.weechat.org/download
-| $time        | aktuelle Uhrzeit/Datum    | Sun, 13 Sep 2009 15:48:31 +0200
-| $username    | Username beim IRC Server  | Nick
-| $realname    | Realname beim IRC Server  | mein Name
+| Platzhalter  | Beschreibung                  | Wert/Beispiel
+| $clientinfo  | Liste der CTCP Antworten      | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| $version     | WeeChat Version               | 0.4.0-dev
+| $versiongit  | WeeChat version + git version | 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| $git         | git version                   | v0.3.9-104-g7eb5cc4
+| $compilation | Datum der Kompilierung        | Dec 16 2012
+| $osinfo      | Info über das genutzte OS     | Linux 2.6.32-5-amd64 / x86_64
+| $site        | WeeChat Seite                 | http://www.weechat.org/
+| $download    | WeeChat, download Seite       | http://www.weechat.org/download
+| $time        | aktuelle Uhrzeit/Datum        | Sun, 16 Dec 2012 10:40:48 +0100
+| $username    | Username beim IRC Server      | name
+| $realname    | Realname beim IRC Server      | John Doe
 |========================================
 
+// TRANSLATION MISSING
+[NOTE]
+The git version is the output of command `git describe`. It is known only if
+WeeChat has been compiled inside the git repository and if git was installed.
+
 Falls CTCP Optionen nicht festgelegt sind, lauten die CTCP Antworten:
 
+// TRANSLATION MISSING ($username (name))
 [width="100%",cols="^2,4l,8l",options="header"]
 |========================================
-| CTCP       | Antwortformat                   | Beispiel
-| CLIENTINFO | $clientinfo                     | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| FINGER     | WeeChat $version                | WeeChat 0.3.0
-| SOURCE     | $download                       | http://www.weechat.org/download
-| TIME       | $time                           | Sun Sep 13 15:48:31 2009
-| USERINFO   | $username ($realname)           | Nick (mein Name)
-| VERSION    | WeeChat $version ($compilation) | WeeChat 0.3.0 (Sep 13 2009)
+| CTCP       | Antwortformat                      | Beispiel
+| CLIENTINFO | $clientinfo                        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| FINGER     | WeeChat $versiongit                | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| SOURCE     | $download                          | http://www.weechat.org/download
+| TIME       | $time                              | Sun, 16 Dec 2012 10:40:48 +0100
+| USERINFO   | $username ($realname)              | name (John Doe)
+| VERSION    | WeeChat $versiongit ($compilation) | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4) (Dec 16 2012)
 |========================================
 
 [[irc_target_buffer]]
diff --git a/doc/en/weechat_user.en.txt b/doc/en/weechat_user.en.txt
index 58358b849..9a5e73a0a 100644
--- a/doc/en/weechat_user.en.txt
+++ b/doc/en/weechat_user.en.txt
@@ -1957,29 +1957,35 @@ when replying to CTCP:
 
 [width="100%",cols="^2l,4,8l",options="header"]
 |========================================
-| Code         | Description                 | Value/example
-| $clientinfo  | list of supported CTCP      | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| $version     | WeeChat version             | 0.3.0
-| $compilation | WeeChat compilation date    | Sep 13 2009
-| $osinfo      | info about OS               | Linux 2.6.31 / i686
-| $site        | WeeChat site                | http://www.weechat.org
-| $download    | WeeChat site, download page | http://www.weechat.org/download
-| $time        | current date/time           | Sun, 13 Sep 2009 15:48:31 +0200
-| $username    | user name on IRC server     | nick
-| $realname    | real name on IRC server     | My name
+| Code         | Description                   | Value/example
+| $clientinfo  | list of supported CTCP        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| $version     | WeeChat version               | 0.4.0-dev
+| $versiongit  | WeeChat version + git version | 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| $git         | git version                   | v0.3.9-104-g7eb5cc4
+| $compilation | WeeChat compilation date      | Dec 16 2012
+| $osinfo      | info about OS                 | Linux 2.6.32-5-amd64 / x86_64
+| $site        | WeeChat site                  | http://www.weechat.org/
+| $download    | WeeChat site, download page   | http://www.weechat.org/download
+| $time        | current date/time             | Sun, 16 Dec 2012 10:40:48 +0100
+| $username    | user name on IRC server       | name
+| $realname    | real name on IRC server       | John Doe
 |========================================
 
+[NOTE]
+The git version is the output of command `git describe`. It is known only if
+WeeChat has been compiled inside the git repository and if git was installed.
+
 If CTCP options are not defined (by default), CTCP replies are:
 
 [width="100%",cols="^2,4l,8l",options="header"]
 |========================================
-| CTCP       | Reply format                    | Example
-| CLIENTINFO | $clientinfo                     | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| FINGER     | WeeChat $version                | WeeChat 0.3.0
-| SOURCE     | $download                       | http://www.weechat.org/download
-| TIME       | $time                           | Sun Sep 13 15:48:31 2009
-| USERINFO   | $username ($realname)           | nick (My name)
-| VERSION    | WeeChat $version ($compilation) | WeeChat 0.3.0 (Sep 13 2009)
+| CTCP       | Reply format                       | Example
+| CLIENTINFO | $clientinfo                        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| FINGER     | WeeChat $versiongit                | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| SOURCE     | $download                          | http://www.weechat.org/download
+| TIME       | $time                              | Sun, 16 Dec 2012 10:40:48 +0100
+| USERINFO   | $username ($realname)              | name (John Doe)
+| VERSION    | WeeChat $versiongit ($compilation) | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4) (Dec 16 2012)
 |========================================
 
 [[irc_target_buffer]]
diff --git a/doc/fr/weechat_user.fr.txt b/doc/fr/weechat_user.fr.txt
index d9f315bae..328decbfc 100644
--- a/doc/fr/weechat_user.fr.txt
+++ b/doc/fr/weechat_user.fr.txt
@@ -2025,27 +2025,34 @@ automatiquement remplacées par WeeChat lors de la réponse au CTCP :
 |========================================
 | Code         | Description                       | Valeur / exemple
 | $clientinfo  | liste des CTCP supportés          | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| $version     | version de WeeChat                | 0.3.0
-| $compilation | date de compilation WeeChat       | Sep 13 2009
-| $osinfo      | information sur l'OS              | Linux 2.6.31 / i686
-| $site        | site WeeChat                      | http://www.weechat.org
+| $version     | version de WeeChat                | 0.4.0-dev
+| $versiongit  | version de WeeChat + version git  | 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| $git         | version git                       | v0.3.9-104-g7eb5cc4
+| $compilation | date de compilation WeeChat       | Dec 16 2012
+| $osinfo      | information sur l'OS              | Linux 2.6.32-5-amd64 / x86_64
+| $site        | site WeeChat                      | http://www.weechat.org/
 | $download    | site WeeChat, page téléchargement | http://www.weechat.org/download
-| $time        | date/heure courante               | Sun, 13 Sep 2009 15:48:31 +0200
-| $username    | nom d'utilisateur sur le serveur  | pseudo
-| $realname    | nom réel sur le serveur           | Mon nom
+| $time        | date/heure courante               | Sun, 16 Dec 2012 10:40:48 +0100
+| $username    | nom d'utilisateur sur le serveur  | nom
+| $realname    | nom réel sur le serveur           | John Doe
 |========================================
 
+[NOTE]
+La version git est la sortie de la commande `git describe`. Elle est connue
+seulement si WeeChat a été compilé dans le repository git et si git était
+installé.
+
 Si les options CTCP ne sont pas définies (par défaut), les réponses CTCP sont :
 
 [width="100%",cols="^2,4l,8l",options="header"]
 |========================================
-| CTCP       | Format de réponse               | Exemple
-| CLIENTINFO | $clientinfo                     | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| FINGER     | WeeChat $version                | WeeChat 0.3.0
-| SOURCE     | $download                       | http://www.weechat.org/download
-| TIME       | $time                           | Sun Sep 13 15:48:31 2009
-| USERINFO   | $username ($realname)           | pseudo (Mon nom)
-| VERSION    | WeeChat $version ($compilation) | WeeChat 0.3.0 (Sep 13 2009)
+| CTCP       | Format de réponse                  | Exemple
+| CLIENTINFO | $clientinfo                        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| FINGER     | WeeChat $versiongit                | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| SOURCE     | $download                          | http://www.weechat.org/download
+| TIME       | $time                              | Sun, 16 Dec 2012 10:40:48 +0100
+| USERINFO   | $username ($realname)              | nom (John Doe)
+| VERSION    | WeeChat $versiongit ($compilation) | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4) (Dec 16 2012)
 |========================================
 
 [[irc_target_buffer]]
diff --git a/doc/it/weechat_user.it.txt b/doc/it/weechat_user.it.txt
index 15c99745f..9bfbe3fb2 100644
--- a/doc/it/weechat_user.it.txt
+++ b/doc/it/weechat_user.it.txt
@@ -2004,32 +2004,41 @@ l'opzione:
 I codici seguenti possono essere utilizzati nelle stringhe e vengono estese
 automaticamente da WeeChat quando si risponde alle CTCP
 
+// TRANSLATION MISSING ($versiongit + $git + $username (name))
 [width="100%",cols="^2l,4,8l",options="header"]
 |=======================================
 | Codice       | Descrizione                         | Valore/esempio
 | $clientinfo  | elenco di CTCP supportate           | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| $version     | versione di WeeChat                 | 0.3.0
-| $compilation | data di compilazione di WeeChat     | Sep 13 2009
-| $osinfo      | informazioni sull'OS                | Linux 2.6.31 / i686
-| $site        | sito di WeeChat                     | http://www.weechat.org
+| $version     | versione di WeeChat                 | 0.4.0-dev
+| $versiongit  | versione di WeeChat + git version   | 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| $git         | git version                         | v0.3.9-104-g7eb5cc4
+| $compilation | data di compilazione di WeeChat     | Dec 16 2012
+| $osinfo      | informazioni sull'OS                | Linux 2.6.32-5-amd64 / x86_64
+| $site        | sito di WeeChat                     | http://www.weechat.org/
 | $download    | sito di WeeChat, pagina di download | http://www.weechat.org/download
-| $time        | data/ora correnti                   | Sun, 13 Sep 2009 15:48:31 +0200
-| $username    | nome utente sul server IRC          | nick
-| $realname    | nome reale sul server IRC           | Mio nome
+| $time        | data/ora correnti                   | Sun, 16 Dec 2012 10:40:48 +0100
+| $username    | nome utente sul server IRC          | name
+| $realname    | nome reale sul server IRC           | John Doe
 |=======================================
 
+// TRANSLATION MISSING
+[NOTE]
+The git version is the output of command `git describe`. It is known only if
+WeeChat has been compiled inside the git repository and if git was installed.
+
 Se le opzioni CTCP non sono definite (comportamento predefinito),
 le risposte CTCP sono:
 
+// TRANSLATION MISSING ($username (name))
 [width="100%",cols="^2,4l,8l",options="header"]
 |=======================================
-| CTCP       | Formato risposta                | Esempio
-| CLIENTINFO | $clientinfo                     | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| FINGER     | WeeChat $version                | WeeChat 0.3.0
-| SOURCE     | $download                       | http://www.weechat.org/download
-| TIME       | $time                           | Sun Sep 13 15:48:31 2009
-| USERINFO   | $username ($realname)           | nick (Mio nome)
-| VERSION    | WeeChat $version ($compilation) | WeeChat 0.3.0 (Sep 13 2009)
+| CTCP       | Formato risposta                   | Esempio
+| CLIENTINFO | $clientinfo                        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| FINGER     | WeeChat $versiongit                | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| SOURCE     | $download                          | http://www.weechat.org/download
+| TIME       | $time                              | Sun, 16 Dec 2012 10:40:48 +0100
+| USERINFO   | $username ($realname)              | name (John Doe)
+| VERSION    | WeeChat $versiongit ($compilation) | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4) (Dec 16 2012)
 |=======================================
 
 [[irc_target_buffer]]
diff --git a/doc/ja/weechat_user.ja.txt b/doc/ja/weechat_user.ja.txt
index 491c7aaee..de68adcba 100644
--- a/doc/ja/weechat_user.ja.txt
+++ b/doc/ja/weechat_user.ja.txt
@@ -1894,31 +1894,40 @@ CTCP "BLABLA" 要求に対する応答を以下のように設定できます:
 以下のコードを設定値に含めることが可能です。これらのコードは
 CTCP 応答時に自動的に WeeChat によって展開されます:
 
+// TRANSLATION MISSING ($versiongit + $git + $username (name))
 [width="100%",cols="^2l,4,8l",options="header"]
 |========================================
 | コード       | 説明                                     | 値/例
 | $clientinfo  | サポートしている CTCP オプションのリスト | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| $version     | WeeChat バージョン                       | 0.3.0
-| $compilation | WeeChat コンパイル日時                   | Sep 13 2009
-| $osinfo      | info about OS に関する情報               | Linux 2.6.31 / i686
-| $site        | WeeChat ウェブサイト                     | http://www.weechat.org
+| $version     | WeeChat バージョン                       | 0.4.0-dev
+| $versiongit  | WeeChat version + git version            | 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| $git         | git version                              | v0.3.9-104-g7eb5cc4
+| $compilation | WeeChat コンパイル日時                   | Dec 16 2012
+| $osinfo      | info about OS に関する情報               | Linux 2.6.32-5-amd64 / x86_64
+| $site        | WeeChat ウェブサイト                     | http://www.weechat.org/
 | $download    | WeeChat ウェブサイトのダウンロードページ | http://www.weechat.org/download
-| $time        | 現在の日時                               | Sun Sep 13 15:48:31 2009
-| $username    | IRC サーバのユーザネーム                 | nick
-| $realname    | IRC サーバのリアルネーム                 | My name
+| $time        | 現在の日時                               | Sun, 16 Dec 2012 10:40:48 +0100
+| $username    | IRC サーバのユーザネーム                 | name
+| $realname    | IRC サーバのリアルネーム                 | John Doe
 |========================================
 
+// TRANSLATION MISSING
+[NOTE]
+The git version is the output of command `git describe`. It is known only if
+WeeChat has been compiled inside the git repository and if git was installed.
+
 CTCP オプションが設定されていない (デフォルトの) 場合、CTCP 応答は以下のようになります:
 
+// TRANSLATION MISSING ($username (name))
 [width="100%",cols="^2,4l,8l",options="header"]
 |========================================
-| CTCP       | 応答フォーマット                | 例
-| CLIENTINFO | $clientinfo                     | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
-| FINGER     | WeeChat $version                | WeeChat 0.3.0
-| SOURCE     | $download                       | http://www.weechat.org/download
-| TIME       | $time                           | Sun Sep 13 15:48:31 2009
-| USERINFO   | $username ($realname)           | nick (My name)
-| VERSION    | WeeChat $version ($compilation) | WeeChat 0.3.0 (Sep 13 2009)
+| CTCP       | 応答フォーマット                   | 例
+| CLIENTINFO | $clientinfo                        | ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+| FINGER     | WeeChat $versiongit                | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+| SOURCE     | $download                          | http://www.weechat.org/download
+| TIME       | $time                              | Sun, 16 Dec 2012 10:40:48 +0100
+| USERINFO   | $username ($realname)              | name (My name)
+| VERSION    | WeeChat $versiongit ($compilation) | WeeChat 0.4.0-dev (git: v0.3.9-104-g7eb5cc4) (Dec 16 2012)
 |========================================
 
 [[irc_target_buffer]]
diff --git a/src/plugins/irc/irc-ctcp.c b/src/plugins/irc/irc-ctcp.c
index c73f7da87..c59d2764f 100644
--- a/src/plugins/irc/irc-ctcp.c
+++ b/src/plugins/irc/irc-ctcp.c
@@ -41,11 +41,11 @@
 
 struct t_irc_ctcp_reply irc_ctcp_default_reply[] =
 { { "clientinfo", "$clientinfo" },
-  { "finger",     "WeeChat $version" },
+  { "finger",     "WeeChat $versiongit" },
   { "source",     "$download" },
   { "time",       "$time" },
   { "userinfo",   "$username ($realname)" },
-  { "version",    "WeeChat $version ($compilation)" },
+  { "version",    "WeeChat $versiongit ($compilation)" },
   { NULL,         NULL },
 };
 
@@ -339,7 +339,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
     char buf[1024];
     struct utsname *buf_uname;
 
-    /* clientinfo */
+    /*
+     * $clientinfo: supported CTCP, example:
+     *   ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION
+     */
     temp = weechat_string_replace (format, "$clientinfo",
                                    "ACTION DCC CLIENTINFO FINGER PING SOURCE "
                                    "TIME USERINFO VERSION");
@@ -347,7 +350,41 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* version */
+    /*
+     * $git: git version (output of "git describe" for a development version
+     * only, empty string if unknown), example:
+     *   v0.3.9-104-g7eb5cc4
+     */
+    info = weechat_info_get ("version_git", "");
+    temp = weechat_string_replace (res, "$git", info);
+    free (res);
+    if (!temp)
+        return NULL;
+    res = temp;
+
+    /*
+     * $versiongit: WeeChat version + git version (if known), examples:
+     *   0.3.9
+     *   0.4.0-dev
+     *   0.4.0-dev (git: v0.3.9-104-g7eb5cc4)
+     */
+    info = weechat_info_get ("version_git", "");
+    snprintf (buf, sizeof (buf), "%s%s%s%s",
+              weechat_info_get ("version", ""),
+              (info && info[0]) ? " (git: " : "",
+              (info && info[0]) ? info : "",
+              (info && info[0]) ? ")" : "");
+    temp = weechat_string_replace (res, "$versiongit", buf);
+    free (res);
+    if (!temp)
+        return NULL;
+    res = temp;
+
+    /*
+     * $version: WeeChat version, examples:
+     *   0.3.9
+     *   0.4.0-dev
+     */
     info = weechat_info_get ("version", "");
     temp = weechat_string_replace (res, "$version", info);
     free (res);
@@ -355,7 +392,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* compilation date */
+    /*
+     * $compilation: compilation date, example:
+     *   Dec 16 2012
+     */
     info = weechat_info_get ("date", "");
     temp = weechat_string_replace (res, "$compilation", info);
     free (res);
@@ -363,7 +403,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* info about OS */
+    /*
+     * $osinfo: info about OS, example:
+     *   Linux 2.6.32-5-amd64 / x86_64
+     */
     buf_uname = (struct utsname *)malloc (sizeof (struct utsname));
     if (buf_uname && (uname (buf_uname) >= 0))
     {
@@ -378,7 +421,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         res = temp;
     }
 
-    /* site */
+    /*
+     * $site: WeeChat web site, example:
+     *   http://www.weechat.org/
+     */
     info = weechat_info_get ("weechat_site", "");
     temp = weechat_string_replace (res, "$site", info);
     free (res);
@@ -386,7 +432,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* site (download page) */
+    /*
+     * $download: WeeChat download page, example:
+     *   http://www.weechat.org/download
+     */
     info = weechat_info_get ("weechat_site_download", "");
     temp = weechat_string_replace (res, "$download", info);
     free (res);
@@ -394,7 +443,9 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* time */
+    /* $time: local date/time of user, example:
+     *   Sun, 16 Dec 2012 10:40:48 +0100
+     */
     now = time (NULL);
     local_time = localtime (&now);
     setlocale (LC_ALL, "C");
@@ -408,7 +459,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* username */
+    /*
+     * $username: user name, example:
+     *   name
+     */
     temp = weechat_string_replace (res, "$username",
                                    IRC_SERVER_OPTION_STRING(server, IRC_SERVER_OPTION_USERNAME));
     free (res);
@@ -416,7 +470,10 @@ irc_ctcp_replace_variables (struct t_irc_server *server, const char *format)
         return NULL;
     res = temp;
 
-    /* realname */
+    /*
+     * $realname: real name, example:
+     *   John doe
+     */
     temp = weechat_string_replace (res, "$realname",
                                    IRC_SERVER_OPTION_STRING(server, IRC_SERVER_OPTION_REALNAME));
     free (res);