From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id DB2C51581D3 for ; Fri, 17 May 2024 04:03:54 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 93B4AE2A7A; Fri, 17 May 2024 04:03:52 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 56A52E2A77 for ; Fri, 17 May 2024 04:03:52 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 5A4FC343010 for ; Fri, 17 May 2024 04:03:51 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 9FF8F1ADA for ; Fri, 17 May 2024 04:03:48 +0000 (UTC) From: "Sam James" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Sam James" Message-ID: <1715910020.36d3b72507a6142d9453a55dbcc6ca038768f3f5.sam@gentoo> Subject: [gentoo-commits] proj/gentoo-functions:master commit in: / X-VCS-Repository: proj/gentoo-functions X-VCS-Files: functions.sh X-VCS-Directories: / X-VCS-Committer: sam X-VCS-Committer-Name: Sam James X-VCS-Revision: 36d3b72507a6142d9453a55dbcc6ca038768f3f5 X-VCS-Branch: master Date: Fri, 17 May 2024 04:03:48 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 145801d6-4b5c-4de0-9858-efa962051b49 X-Archives-Hash: 873528778b6c8dc5a3ab38238745f29d commit: 36d3b72507a6142d9453a55dbcc6ca038768f3f5 Author: Kerin Millar plushkava net> AuthorDate: Thu May 16 12:22:51 2024 +0000 Commit: Sam James gentoo org> CommitDate: Fri May 17 01:40:20 2024 +0000 URL: https://gitweb.gentoo.org/proj/gentoo-functions.git/commit/?id=36d3b725 More comment improvements Render the descriptions of eerrorn(), esyslog(), _update_columns() and the v-prefixed functions more accurate. Signed-off-by: Kerin Millar plushkava.net> functions.sh | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/functions.sh b/functions.sh index 9424660..e2af8cf 100644 --- a/functions.sh +++ b/functions.sh @@ -74,8 +74,9 @@ for _ in eerror einfo ewarn; do done # -# Prints an error message without appending a newline, while also conveying it -# to the esyslog function. +# Prints an error message without appending a newline, provided that +# EERROR_QUIET is false. If printed, the message shall also be conveyed to the +# esyslog function. # eerrorn() { @@ -122,7 +123,9 @@ eoutdent() } # -# Invokes logger(1) to log the given message, provided that EINFO_LOG is true. +# Invokes the logger(1) utility, provided that EINFO_LOG is true. The first +# parameter shall be taken as a priority level, the second as the message tag, +# and the remaining parameters as the message to be logged. # esyslog() { @@ -273,7 +276,7 @@ is_older_than() # # Declare the vebegin, veerror, veindent, veinfo, veinfon, veoutdent and vewarn # functions. These differ from their non-v-prefixed counterparts in that they -# only print where EINFO_VERBOSE is true. +# only have an effect where EINFO_VERBOSE is true. # for _ in vebegin veerror veindent veinfo veinfon veoutdent vewarn; do eval " @@ -466,7 +469,7 @@ _is_visible() # # Determines whether the terminal on STDIN is able to report its dimensions. -# Upon success, the number of columns shall be stored. +# Upon success, the number of columns shall be stored in genfun_cols. # _update_columns() {