File 5492-otp_build-check-help-text-improvements.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 5492-otp_build-check-help-text-improvements.patch of Package erlang

From 57e6bb309261090a6f6f35c7d9520c2b348e7a05 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Wed, 10 May 2023 11:14:44 +0200
Subject: [PATCH] otp_build check help text improvements

---
 otp_build               |  3 +-
 scripts/otp_build_check | 89 +++++++++++++++++++++++------------------
 2 files changed, 51 insertions(+), 41 deletions(-)

diff --git a/otp_build b/otp_build
index 46e5c75951..c9d118c2a4 100755
--- a/otp_build
+++ b/otp_build
@@ -56,7 +56,8 @@ usage ()
     echo "    release <target_dir> - creates a small release to <target_dir>"
     echo "    release [-a|-s|-t] <target_dir> - creates full release to <target_dir>"
     echo "    tests <dir> - Build testsuites to <dir>"
-    echo "    check [-h|...] - Perform various build checks. See help for more info and options."
+    echo "    check [--help|...] - Perform various build checks. See --help for more info"
+    echo "                         and options."
     echo ""
     echo "-a builds all applications"
     echo "-s builds a small system (default)"
diff --git a/scripts/otp_build_check b/scripts/otp_build_check
index e9981b896f..ee6e656cdf 100755
--- a/scripts/otp_build_check
+++ b/scripts/otp_build_check
@@ -48,50 +48,59 @@ progress() {
 }
 
 print_usage() {
-    echo "Usage:"
-    echo "  otp_build check [--help|-h] [--only-opt|-o] [--no-docs|-d] \\"
-    echo "                  [--no-dialyzer|-y] [--no-tests|-n] [--no-format-check|-f] \\"
-    echo "                  [--tests|-t <App0> ... <AppN>]"
-    echo ""
-    echo ""
-    echo "By default all currently implemented checks will be performed. If any"
-    echo "of the currently used tools are missing, checking will fail. If libraries"
-    echo "needed to support certain features are missing, those features will not"
-    echo "be checked. If any of these checks do not pass, the code is *not* ready"
-    echo "for testing in OTP daily builds. Note that this script does not check"
-    echo "all requirements for testing in OTP daily builds. These checks are the"
-    echo "bare minimum for even considering testing in OTP daily builds."
-    echo "Currently the following will be performed by default:"
-    echo ""
-    echo " * Build all applications in optimized mode. If configure already"
-    echo "   has been run, it wont be run again."
-    echo " * Debug compile C-code in all applications."
-    echo " * Format checking of JIT code."
-    echo " * Run dialyzer on all applications."
-    echo " * Build all documentation."
-    echo " * Run xmllint on all documentation."
-    echo " * Run html link check on all documentation."
-    echo " * Build all tests."
-    echo ""
-    echo "Certain testing can be disabled using the following options:"
-    echo "* [--only-opt|-o] - Only compilebuild optimized system. No debug, etc."
-    echo "* [--no-docs|-d] - No documentation checking."
-    echo "* [--no-dialyzer|-y] - No dialyzer checking."
-    echo "* [--no-tests|-n] - No if building tests."
-    echo "* [--no-format-check|-f] - No JIT format checking."
-    echo "* [--tests|-t <App0> ... <AppN>] - Only build tests for listed applications"
-    echo ""
-    echo "Environment variables used:"
-    echo "* CONFIG_FLAGS - Arguments to pass to configure if it is executed."
-    echo ""
-    echo "Build results will be placed under the \$ERL_TOP/release/<TARGET> directory"
-    echo ""
-    
+    cat <<EOF
+Usage:
+  otp_build check [--help|-h] [--only-opt|-o] [--no-docs|-d] \\
+                  [--no-dialyzer|-y] [--no-tests|-n] [--no-format-check|-f] \\
+                  [--tests|-t <App0> ... <AppN>]
+
+
+By default all currently implemented checks will be performed. If any of the
+currently used tools are missing, checking will fail. If libraries or tools
+needed to support certain conditional features are missing, those features
+will not be checked.
+
+If any of these checks do not pass, the code is *not* ready for testing in OTP
+daily builds. Note that this script does not check all requirements for testing
+in OTP daily builds. These checks are the bare minimum for even considering
+testing in OTP daily builds. Currently the following will be performed by
+default:
+
+ * Build all applications in optimized mode. If configure already has been run,
+   it wont be run again.
+ * Debug compile C-code in all applications.
+ * Format checking of JIT code.
+ * Run dialyzer on all applications.
+ * Build all documentation.
+ * Run xmllint on all documentation.
+ * Run html link check on all documentation.
+ * Build all test suites.
+
+Certain build checking can be disabled using the following options:
+* [--only-opt|-o] - Only build optimized system. No debug, etc.
+* [--no-format-check|-f] - No JIT format checking.
+* [--no-docs|-d] - No documentation checking.
+* [--no-dialyzer|-y] - No dialyzer checking.
+* [--no-tests|-n] - No build checking of test suites.
+* [--tests|-t <App0> ... <AppN>] - Only build checking of test suites for
+  listed applications.
+
+Only disable build checking for parts of the system that you are certain your
+changes wont effect. Note that even though you've made no changes in
+documentation source files, documentation build is effected by type changes
+in code.
+
+Environment variables used:
+* CONFIG_FLAGS - Arguments to pass to configure if it is executed.
+
+Build results will be placed under the \$ERL_TOP/release/<TARGET> directory
+
+EOF
 }
 
 usage () {
     print_error "$1"
-    print_usage
+    print_usage >&2
     exit 1
 }
 
-- 
2.35.3

Places

File 5492-otp_build-check-help-text-improvements.patch of Package erlang

Places