From 20f21c4bbc0fcaea135adb510582096e12181bae Mon Sep 17 00:00:00 2001
From: Jimmy Monin <jimmy@monin.net>
Date: Sat, 19 May 2018 09:14:06 +0200
Subject: [PATCH] Update README and helpers

---
 README.md          |  4 +++-
 scripts/_common.sh | 43 +++++++++++++++++++++++--------------------
 2 files changed, 26 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 4ba6788..5027a0a 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,9 @@ Moreover, you should have in mind Discourse [hardware requirements](https://gith
 - 64 bit Linux compatible with Docker
 - 10 GB disk space minimum
 
-Finally, if installing on a low-end ARM device (e.g. Raspberry Pi), first access right after installation could take a couple of minutes.
+Finally, if installing on a low-end ARM device (e.g. Raspberry Pi):
+- installation can last up to 3 hours,
+- first access right after installation could take a couple of minutes.
 ## Overview
 [Discourse](http://www.discourse.org) is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:
 
diff --git a/scripts/_common.sh b/scripts/_common.sh
index ab3aec9..0acc180 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -157,7 +157,6 @@ ynh_psql_execute_file_as_root() {
 # | arg: pwd - Password of the database. If not given, a password will be generated
 ynh_psql_setup_db () {
 	db_user="$1"
-	app="$1"
 	db_name="$2"
 	new_db_pwd=$(ynh_string_random)	# Generate a random password
 	# If $3 is not given, use new_db_pwd instead for db_pwd.
@@ -513,10 +512,10 @@ ynh_remove_ruby () {
 # Returns true if upstream version is up to date
 #
 # This helper should be used to avoid an upgrade of the upstream version
-# when it's not needed (but yet allowing to upgrade other part of the
+# when it's not needed (but yet allowing to upgrade other parts of the
 # YunoHost application (e.g. nginx conf)
 #
-# usage: ynh_is_upstream_up_to_date
+# usage: ynh_is_upstream_up_to_date (returns a boolean)
 ynh_is_upstream_up_to_date () {
 	local version=$(ynh_read_manifest "/etc/yunohost/apps/$YNH_APP_INSTANCE_NAME/manifest.json" "version" || echo 1.0)
   version="${version/~ynh*/}"
@@ -572,34 +571,28 @@ ynh_app_package_version () {
 #
 # usage: ynh_check_starting "Line to match" [Log file] [Timeout] [Service name]
 #
-# | arg: Log file - The log file to watch, specify "systemd" to read systemd journal for specified service
 # | arg: Line to match - The line to find in the log to attest the service have finished to boot.
-# | arg: Service name
-# /var/log/$app/$app.log will be used if no other log is defined.
+# | arg: Log file - The log file to watch; specify "systemd" to read systemd journal for specified service
+#    /var/log/$app/$app.log will be used if no other log is defined.
 # | arg: Timeout - The maximum time to wait before ending the watching. Defaut 300 seconds.
+# | arg: Service name
 ynh_check_starting () {
 	local line_to_match="$1"
 	local service_name="${4:-$app}"
 	local app_log="${2:-/var/log/$service_name/$service_name.log}"
 	local timeout=${3:-300}
 
-	ynh_clean_check_starting () {
-		# Stop the execution of tail.
-		kill -s 15 $pid_tail 2>&1
-		ynh_secure_remove "$templog" 2>&1
-	}
-
 	echo "Starting of $service_name" >&2
 	systemctl stop $service_name
 	local templog="$(mktemp)"
 	# Following the starting of the app in its log
-  if [ "$app_log" == "systemd" ] ; then
-    # Read the systemd journal
-    journalctl -u $service_name -f --since=-45 > "$templog" &
-  else
-    # Read the specified log file
-	  tail -F -n0 "$app_log" > "$templog" &
-  fi
+	if [ "$app_log" == "systemd" ] ; then
+		# Read the systemd journal
+		journalctl -u $service_name -f --since=-45 > "$templog" &
+	else
+		# Read the specified log file
+		tail -F -n0 "$app_log" > "$templog" &
+	fi
 	# Get the PID of the last command
 	local pid_tail=$!
 	systemctl start $service_name
@@ -607,7 +600,7 @@ ynh_check_starting () {
 	local i=0
 	for i in `seq 1 $timeout`
 	do
-		# Read the log until the sentence is found, that means the app finished to start. Or run until the timeout
+		# Read the log until the sentence is found, which means the app finished starting. Or run until the timeout.
 		if grep --quiet "$line_to_match" "$templog"
 		then
 			echo "The service $service_name has correctly started." >&2
@@ -624,3 +617,13 @@ ynh_check_starting () {
 	echo ""
 	ynh_clean_check_starting
 }
+# Clean temporary process and file used by ynh_check_starting
+# (usually used in ynh_clean_setup scripts)
+#
+# usage: ynh_clean_check_starting
+
+ynh_clean_check_starting () {
+	# Stop the execution of tail.
+	kill -s 15 $pid_tail 2>&1
+	ynh_secure_remove "$templog" 2>&1
+}