Merge pull request #38428 from Ekleog/doc-weechat

Add documentation for weechat

2 files changed, 20 insertions, 2 deletions

diff --git a/doc/package-notes.xml b/doc/package-notes.xml
index 2d6c87c3d07a8..1fccfd5d329d2 100644
--- a/doc/package-notes.xml
+++ b/doc/package-notes.xml
@@ -713,7 +713,7 @@ the <literal>inotify.py</literal> script in weechat-scripts requires
 D-Bus or libnotify, and the <literal>fish.py</literal> script requires
 pycrypto. To use these scripts, use the <literal>python</literal>
 plugin's <literal>withPackages</literal> attribute:
-<programlisting>weechat.override {configure = {availablePlugins, ...}: {
+<programlisting>weechat.override { configure = {availablePlugins, ...}: {
     plugins = with availablePlugins; [
             (python.withPackages (ps: with ps; [ pycrypto python-dbus ]))
         ];
@@ -721,5 +721,15 @@ plugin's <literal>withPackages</literal> attribute:
 }
 </programlisting>
 </para>
+<para>
+In order to also keep all default plugins installed, it is possible to use
+the following method:
+<programlisting>weechat.override { configure = { availablePlugins, ... }: {
+  plugins = builtins.attrValues (availablePlugins // {
+    python = availablePlugins.python.withPackages (ps: with ps; [ pycrypto python-dbus ]);
+  });
+}; }
+</programlisting>
+</para>
 </section>
 </chapter>
diff --git a/pkgs/applications/networking/irc/weechat/default.nix b/pkgs/applications/networking/irc/weechat/default.nix
index cfed44c997aea..b2ea28f0cf857 100644
--- a/pkgs/applications/networking/irc/weechat/default.nix
+++ b/pkgs/applications/networking/irc/weechat/default.nix
@@ -72,6 +72,11 @@ let
       meta = {
         homepage = http://www.weechat.org/;
         description = "A fast, light and extensible chat client";
+        longDescription = ''
+          You can find more documentation as to how to customize this package
+          (eg. adding python modules for scripts that would require them, etc.)
+          on https://nixos.org/nixpkgs/manual/#sec-weechat .
+        '';
         license = stdenv.lib.licenses.gpl3;
         maintainers = with stdenv.lib.maintainers; [ lovek323 garbas the-kenny lheckemann ];
         platforms = stdenv.lib.platforms.unix;
@@ -117,4 +122,7 @@ in if configure == null then weechat else
     export WEECHAT_EXTRA_LIBDIR=${pluginsDir}
     ${lib.concatMapStringsSep "\n" (p: lib.optionalString (p ? extraEnv) p.extraEnv) plugins}
     exec ${weechat}/bin/weechat "$@"
-  '') // { unwrapped = weechat; }
+  '') // {
+    unwrapped = weechat;
+    meta = weechat.meta;
+  }