From: Michael Orlitzky <michael@orlitzky.com>
Date: Mon, 27 Oct 2014 13:08:46 +0000 (-0400)
Subject: app-laptop/hdapsd: more doc cleanup
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=7fc95d3db57ef6e88d6f875e2c78946e18e473bb;p=mjo-overlay.git

app-laptop/hdapsd: more doc cleanup
---

diff --git a/app-laptop/hdapsd/Manifest b/app-laptop/hdapsd/Manifest
index 941acb9..9aa1d9a 100644
--- a/app-laptop/hdapsd/Manifest
+++ b/app-laptop/hdapsd/Manifest
@@ -1,5 +1,5 @@
 AUX hdapsd.conf-20141024 739 SHA256 dd37f05c2d2e76e9e12f7b5398a1b4a64b765ecf97c48320a7d278411e808e33 SHA512 e03c7f02af2789a784284f10eed10e10edb82e2ad16d3794299cc9622c00a047f30df7f7d553ef572e265815684d1e783932e0f3b219cca44f0e1f74dc045944 WHIRLPOOL fadc681435c884bbd56115989ce9ee461bd81c8f4aa6b77a607464ee48bf11389b6659401bccd509b1ce057cef28ff08a98b87b9b6a2ae70a746c4afc4ef0ec8
 AUX hdapsd.init-20141024 2176 SHA256 7a78680ea4db28bf3aed9d777550d2f08e3b1b6b29e91f44ee549b9d14b11615 SHA512 2b6826f27a5c0308d29dc993c0685feee1d21615ce7222a1fc8dbcc4451ef9ea7913c91068459ac25bbdce2d656ad3f2d51a57e6e9b3eb0db99deee262c21885 WHIRLPOOL 0e0ae497280d903e78d8dcb4df3e53f0ad632aa480bf0263386494cc8a48a007cf1e1d2bbebd1c5b49cc6d44641b0f209c02c773b931f7f67c9a73483888b1e4
 DIST hdapsd-20141024.tar.gz 128580 SHA256 4a9f7c4d6351bd31757f236ad832ceccf10280d32bcaf4c25d15dc4ecc84581f SHA512 2d956ce1e6691f41d0f39a4d29c244b5a7ed7ebed4c979a39131e311a4cea3374150cd4ca1da4033e483c3ea0da4e8ca01f20e599a65278dd0674e29a086c540 WHIRLPOOL ed1c536fde7e212e38af8ba54d8a712d70b550d647ec93aff05c866ee7e2e41a563adb73fd20e3e540c87c90089a41c60fe3ec8c8406785bc59446d7f0b94831
-EBUILD hdapsd-20141024.ebuild 1922 SHA256 82ad9d48f5c10afdea423dadcd6622c70cf31240646e90c856c408d722f857e5 SHA512 5d9338e12ffc240ae178962627a24ecb0343e7921600ba92cfeb07a565337b01ddf4fa5e9e1bf3d8b4332adb86b9d8bddf27c724c53f12f5027c59118a6039f1 WHIRLPOOL dd91fae5343e17aed64a9538355a62d539478a44a50dbfa687349a21cd4d053abac785c02972b1f593656cd4592acc9f49c156736ea9c6b25ede896d1e159de7
+EBUILD hdapsd-20141024.ebuild 2175 SHA256 e3c4dbf6175c17a86fbd2c67de6e6d0d06c5036e1c53fccb40f40dd3c5041263 SHA512 d61a88edacb6f1a631bb3fedb729f65e1b22b3f4ba9222c878c20d915b46d4d7e78393ecb816ad52da6c2dd64d92db905e06fa07de58a9dce73a073c466243dd WHIRLPOOL 5b4e13577669a1450877dd039d87d272a857184b17c8299d0cfd173c0681be93b60e6b08195c0f38601edf8123e6c9222f168e0657eb117d57c59e2f5c7f6b17
 MISC metadata.xml 411 SHA256 7b1b223aca5553979c2d593e5c8611ab4a2c4d3135b35511213fba3fb626c3c0 SHA512 4430613ede7fc6207250a505e246f9e81e68cb7f23bea4ac79a60ef2001a4f62f4e0db09c28b0a71cdbdcf547e5c62c669db210780cede0b5fa3e079866e10dd WHIRLPOOL 1c50cc056fa80da79ecfe890b319121b56cd12ed9ab1775858e3dcb41d3d30d427d8091ed49341508fd45099022df4de7f848cc25fd3531f344ca4c9498bf2a2
diff --git a/app-laptop/hdapsd/hdapsd-20141024.ebuild b/app-laptop/hdapsd/hdapsd-20141024.ebuild
index d3af8e8..bbe969d 100644
--- a/app-laptop/hdapsd/hdapsd-20141024.ebuild
+++ b/app-laptop/hdapsd/hdapsd-20141024.ebuild
@@ -18,13 +18,12 @@ DEPEND="libconfig? ( dev-libs/libconfig )"
 RDEPEND="${DEPEND}"
 
 pkg_setup() {
-	# We require the hdaps module which can either come from kernel sources
-	# or from the tp_smapi package.
+	# We require the hdaps module which can either come from either the
+	# kernel itself (CONFIG_SENSORS_HDAPS) or from the tp_smapi package.
 	if ! has_version app-laptop/tp_smapi[hdaps]; then
 		CONFIG_CHECK="~SENSORS_HDAPS"
-		ERROR_SENSORS_HDAPS="${P} requires app-laptop/tp_smapi (with hdaps "
-		ERROR_SENSORS_HDAPS+="USE enabled) or kernel support for "
-		ERROR_SENSORS_HDAPS+="CONFIG_SENSORS_HDAPS enabled"
+		ERROR_SENSORS_HDAPS="${P} requires app-laptop/tp_smapi[hdaps] or "
+		ERROR_SENSORS_HDAPS+="kernel support for CONFIG_SENSORS_HDAPS enabled"
 		linux-info_pkg_setup
 	fi
 }
@@ -48,23 +47,27 @@ pkg_postinst(){
 	[[ -z $(ls "${EROOT}"sys/block/*/device/unload_heads 2>/dev/null) ]] && \
 		ewarn "Your kernel does NOT support shock protection."
 
-	if ! has_version app-laptop/tp_smapi[hdaps]; then
-		ewarn "Using the hdaps module provided by app-laptop/tp_smapi instead"
-		ewarn "of the in-kernel driver is strongly recommended!"
-	fi
-
 	readme.gentoo_print_elog
 }
 
 DISABLE_AUTOFORMATTING=1
-DOC_CONTENTS='
-You can change the default frequency by modifing,
+DOC_CONTENTS="
+${PN} requires a kernel module to function properly. The recommended
+approach is to install app-laptop/tp_smapi[hdaps], but the in-tree
+module provided by CONFIG_SENSORS_HDAPS may work as well.
+
+Common daemon parameters can be set in ${EROOT}etc/conf.d/${PN}. If the
+package was installed with USE=libconfig, then the parameters can also
+be set in ${EROOT}etc/${PN}.conf, although the former will take
+precedence over the latter if both are used.
+
+You can change the default sampling rate by modifing
 
 	/sys/devices/platform/hdaps/sampling_rate
 
-You might need to enable shock protection manually by running:
+and you may need to enable shock protection manually by running
 
-	# echo -1 > /sys/block/DEVICE/device/unload_heads
+	# echo -1 > /sys/block/<disk>/device/unload_heads
 
 as root.
-'
+"