[lxc-devel] [lxd/master] Improve help texts

[haarts on Github]

A non-text attachment was scrubbed...
Name: not available
Type: text/x-mailbox
Size: 538 bytes
Desc: not available
URL: <http://lists.linuxcontainers.org/pipermail/lxc-devel/attachments/20161118/8bf12ae8/attachment.bin>
-------------- next part --------------
From 1da14f75258527b57777fc69d3f11765e839cae5 Mon Sep 17 00:00:00 2001
From: Harm Aarts <harmaarts at gmail.com>
Date: Fri, 18 Nov 2016 19:34:14 +0100
Subject: [PATCH 1/3] doc: update 'delete' help text.

It is now a little terser without losing meaning.

Signed-off-by: Harm Aarts <harmaarts at gmail.com>
---
 lxc/delete.go | 2 +-
 po/lxd.pot    | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/lxc/delete.go b/lxc/delete.go
index afa3d7d..660f983 100644
--- a/lxc/delete.go
+++ b/lxc/delete.go
@@ -23,7 +23,7 @@ func (c *deleteCmd) showByDefault() bool {
 
 func (c *deleteCmd) usage() string {
 	return i18n.G(
-		`Delete containers or container snapshots.
+		`Delete containers or snapshots.
 
 lxc delete [remote:]<container>[/<snapshot>] [remote:][<container>[/<snapshot>]...]
 
diff --git a/po/lxd.pot b/po/lxd.pot
index 581dce7..cf91cfb 100644
--- a/po/lxd.pot
+++ b/po/lxd.pot
@@ -7,7 +7,7 @@
 msgid   ""
 msgstr  "Project-Id-Version: lxd\n"
         "Report-Msgid-Bugs-To: lxc-devel at lists.linuxcontainers.org\n"
-        "POT-Creation-Date: 2016-11-16 12:13-0500\n"
+        "POT-Creation-Date: 2016-11-18 19:32+0100\n"
         "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
         "Last-Translator: FULL NAME <EMAIL at ADDRESS>\n"
         "Language-Team: LANGUAGE <LL at li.org>\n"
@@ -299,7 +299,7 @@ msgid   "Define a compression algorithm: for image or none"
 msgstr  ""
 
 #: lxc/delete.go:25
-msgid   "Delete containers or container snapshots.\n"
+msgid   "Delete containers or snapshots.\n"
         "\n"
         "lxc delete [remote:]<container>[/<snapshot>] [remote:][<container>[/<snapshot>]...]\n"
         "\n"

From 39e813f3cc6f23e5e052a880cdb5de2f79763efe Mon Sep 17 00:00:00 2001
From: Harm Aarts <harmaarts at gmail.com>
Date: Fri, 18 Nov 2016 19:36:13 +0100
Subject: [PATCH 2/3] doc: update 'finger' help text.

It is now shorter and more clear.

Signed-off-by: Harm Aarts <harmaarts at gmail.com>
---
 lxc/finger.go |  2 +-
 po/lxd.pot    | 14 +++++++-------
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/lxc/finger.go b/lxc/finger.go
index 2f0749f..d500e18 100644
--- a/lxc/finger.go
+++ b/lxc/finger.go
@@ -13,7 +13,7 @@ func (c *fingerCmd) showByDefault() bool {
 
 func (c *fingerCmd) usage() string {
 	return i18n.G(
-		`Fingers the LXD instance to check if it is up and working.
+		`Check if the LXD instance is up.
 
 lxc finger <remote>`)
 }
diff --git a/po/lxd.pot b/po/lxd.pot
index cf91cfb..b1d0f4a 100644
--- a/po/lxd.pot
+++ b/po/lxd.pot
@@ -7,7 +7,7 @@
 msgid   ""
 msgstr  "Project-Id-Version: lxd\n"
         "Report-Msgid-Bugs-To: lxc-devel at lists.linuxcontainers.org\n"
-        "POT-Creation-Date: 2016-11-18 19:32+0100\n"
+        "POT-Creation-Date: 2016-11-18 19:35+0100\n"
         "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
         "Last-Translator: FULL NAME <EMAIL at ADDRESS>\n"
         "Language-Team: LANGUAGE <LL at li.org>\n"
@@ -202,6 +202,12 @@ msgid   "Changes state of one or more containers to %s.\n"
         "lxc %s <name> [<name>...]%s"
 msgstr  ""
 
+#: lxc/finger.go:15
+msgid   "Check if the LXD instance is up.\n"
+        "\n"
+        "lxc finger <remote>"
+msgstr  ""
+
 #: lxc/remote.go:291
 msgid   "Client certificate stored at server: "
 msgstr  ""
@@ -374,12 +380,6 @@ msgstr  ""
 msgid   "Fingerprint: %s"
 msgstr  ""
 
-#: lxc/finger.go:15
-msgid   "Fingers the LXD instance to check if it is up and working.\n"
-        "\n"
-        "lxc finger <remote>"
-msgstr  ""
-
 #: lxc/action.go:42 lxc/action.go:43
 msgid   "Force the container to shutdown."
 msgstr  ""

From 5c7c97038454c5226ad4c5e150391082ce9f1871 Mon Sep 17 00:00:00 2001
From: Harm Aarts <harmaarts at gmail.com>
Date: Fri, 18 Nov 2016 19:37:16 +0100
Subject: [PATCH 3/3] doc: update 'restore' help text.

Made the subject of the sentence the thing on which the operation works.

Signed-off-by: Harm Aarts <harmaarts at gmail.com>
---
 lxc/restore.go | 2 +-
 po/lxd.pot     | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/lxc/restore.go b/lxc/restore.go
index 440babf..3e4f8d5 100644
--- a/lxc/restore.go
+++ b/lxc/restore.go
@@ -19,7 +19,7 @@ func (c *restoreCmd) showByDefault() bool {
 
 func (c *restoreCmd) usage() string {
 	return i18n.G(
-		`Set the current state of a resource back to a snapshot.
+		`Set the current state of a container back to a snapshot.
 
 lxc restore [remote:]<container> <snapshot name> [--stateful]
 
diff --git a/po/lxd.pot b/po/lxd.pot
index b1d0f4a..05826b6 100644
--- a/po/lxd.pot
+++ b/po/lxd.pot
@@ -7,7 +7,7 @@
 msgid   ""
 msgstr  "Project-Id-Version: lxd\n"
         "Report-Msgid-Bugs-To: lxc-devel at lists.linuxcontainers.org\n"
-        "POT-Creation-Date: 2016-11-18 19:35+0100\n"
+        "POT-Creation-Date: 2016-11-18 19:37+0100\n"
         "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
         "Last-Translator: FULL NAME <EMAIL at ADDRESS>\n"
         "Language-Team: LANGUAGE <LL at li.org>\n"
@@ -1093,7 +1093,7 @@ msgid   "Server protocol (lxd or simplestreams)"
 msgstr  ""
 
 #: lxc/restore.go:21
-msgid   "Set the current state of a resource back to a snapshot.\n"
+msgid   "Set the current state of a container back to a snapshot.\n"
         "\n"
         "lxc restore [remote:]<container> <snapshot name> [--stateful]\n"
         "\n"