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 97D681581D3 for ; Fri, 17 May 2024 04:03:55 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id CC6EEE2A7D; 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 AD5D3E2A7D 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 973D0343011 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 DCBA81ADE 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: <1715912233.57f643e81c8bd8ab5d428aa5770c3a8097a456a2.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: 57f643e81c8bd8ab5d428aa5770c3a8097a456a2 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: ab3ed6db-660c-4cae-9da8-baa290c72e8c X-Archives-Hash: 047d6a049ff79e492c7ae7c28492bfc1 commit: 57f643e81c8bd8ab5d428aa5770c3a8097a456a2 Author: Kerin Millar plushkava net> AuthorDate: Fri May 17 01:21:15 2024 +0000 Commit: Sam James gentoo org> CommitDate: Fri May 17 02:17:13 2024 +0000 URL: https://gitweb.gentoo.org/proj/gentoo-functions.git/commit/?id=57f643e8 Document variables influencing runtime behaviour Signed-off-by: Kerin Millar plushkava.net> functions.sh | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/functions.sh b/functions.sh index b0170f9..dd5bb76 100644 --- a/functions.sh +++ b/functions.sh @@ -3,12 +3,30 @@ # shellcheck shell=sh disable=3043 # This file contains a series of function declarations followed by some -# initialization code. Functions intended for internal use shall be prefixed +# initialisation code. Functions intended for internal use shall be prefixed # with an and shall not be considered as being a part of the public # API. With the exception of those declared by the local builtin, all variables # intended for internal use shall be prefixed with "genfun_" to indicate so, # and to reduce the probability of name space conflicts. +# The following variables affect initialisation and/or function behaviour. + +# BASH : whether bash-specific features may be employed +# BASHPID : potentially used by _update_columns() to detect subshells +# COLUMNS : potentially used by _update_columns() to get the column count +# EERROR_QUIET : whether error printing functions should be silenced +# EINFO_LOG : whether printing functions should call esyslog() +# EINFO_QUIET : whether info message printing functions should be silenced +# EINFO_VERBOSE : whether v-prefixed functions should do anything +# IFS : multiple message operands are joined by its first character +# INSIDE_EMACS : whether to work around an emacs-specific bug in _eend() +# NO_COLOR : whether colored output should be suppressed +# RC_NOCOLOR : like NO_COLOR but deprecated +# TEST_GENFUNCS : used for testing the behaviour of get_bootparam() +# TERM : may influence message formatting and whether color is used + +################################################################################ + # # A safe wrapper for the cd builtin. To run cd "$dir" is problematic because: #