From 2ebeffcfd46f4a471cf4e49130ec106cf8a88ff1 Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <edolstra@gmail.com>
Date: Thu, 7 Sep 2017 20:18:29 +0200
Subject: nix log: Add examples

---
 src/nix/log.cc | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

(limited to 'src/nix/log.cc')

diff --git a/src/nix/log.cc b/src/nix/log.cc
index 15ae61d08..966ad8b65 100644
--- a/src/nix/log.cc
+++ b/src/nix/log.cc
@@ -19,7 +19,25 @@ struct CmdLog : InstallableCommand
 
     std::string description() override
     {
-        return "show the build log of the specified packages or paths";
+        return "show the build log of the specified packages or paths, if available";
+    }
+
+    Examples examples() override
+    {
+        return {
+            Example{
+                "To get the build log of GNU Hello:",
+                "nix log nixpkgs.hello"
+            },
+            Example{
+                "To get the build log of a specific path:",
+                "nix log /nix/store/lmngj4wcm9rkv3w4dfhzhcyij3195hiq-thunderbird-52.2.1"
+            },
+            Example{
+                "To get a build log from a specific binary cache:",
+                "nix log --store https://cache.nixos.org nixpkgs.hello"
+            },
+        };
     }
 
     void run(ref<Store> store) override
-- 
cgit v1.2.3