mailarchive of the ptxdist mailing list
 help / color / mirror / Atom feed
From: Enrico Jorns <ejo@pengutronix.de>
To: ptxdist@pengutronix.de
Cc: Enrico Jorns <ejo@pengutronix.de>
Subject: [ptxdist] [PATCH 3/6] rauc: provide and improve help texts on config options
Date: Fri, 11 Jan 2019 09:58:22 +0100	[thread overview]
Message-ID: <20190111085825.29335-4-ejo@pengutronix.de> (raw)
In-Reply-To: <20190111085825.29335-1-ejo@pengutronix.de>

Signed-off-by: Enrico Jorns <ejo@pengutronix.de>
---
 rules/rauc.in | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/rules/rauc.in b/rules/rauc.in
index 20c5564ed..96afc9092 100644
--- a/rules/rauc.in
+++ b/rules/rauc.in
@@ -17,18 +17,30 @@ if RAUC
 
 config RAUC_NETWORK
 	bool
-	prompt "network support"
+	prompt "Enable network support"
+	help
+	  Enables network support that allows RAUC to directly fetch bundles
+	  via http/https/ftp/sftp (using libcurl).
+	  Note that network is primarily designed to be used for RAUC'S casync
+	  capabilities, not for fetching full bundles.
 
 config RAUC_JSON
 	bool
 	prompt "JSON support"
+	help
+	  Enables JSON output format for 'rauc info' and 'rauc status'.
+	  Output format can be selected via '--output-format=<json/json-pretty>'
 
 config RAUC_CONFIGURATION
 	prompt "Install RAUC configuration in /etc/rauc"
 	bool
 	default y
 	help
-	  Install a default RAUC configuration that works for most projects.
+	  Installs a RAUC system configuration file and a keyring into /etc/rauc.
+	  By default, this will install some dummy files containing some
+	  example and help text.
+	  The default files must be overwritten in your projectroot to match
+	  your project's and platform's need.
 
 if RAUC_CONFIGURATION
 
-- 
2.11.0


_______________________________________________
ptxdist mailing list
ptxdist@pengutronix.de

  parent reply	other threads:[~2019-01-11  8:58 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-11  8:58 [ptxdist] [PATCH 0/6] rauc: some recipe polishing and a version bump to 1.0 Enrico Jorns
2019-01-11  8:58 ` [ptxdist] [PATCH 1/6] rauc: needs to depend on host-glib package Enrico Jorns
2019-01-11  8:58 ` [ptxdist] [PATCH 2/6] rauc: align if statements in selects statements Enrico Jorns
2019-01-11  8:58 ` Enrico Jorns [this message]
2019-01-11  8:58 ` [ptxdist] [PATCH 4/6] rauc: allow to optionally disable SERVICE mode Enrico Jorns
2019-01-11  8:58 ` [ptxdist] [PATCH 5/6] rauc: version bump 0.4 -> 1.0 Enrico Jorns
2019-01-11  8:58 ` [ptxdist] [PATCH 6/6] rauc: force busybox tar to have long options enabled Enrico Jorns

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190111085825.29335-4-ejo@pengutronix.de \
    --to=ejo@pengutronix.de \
    --cc=ptxdist@pengutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox