huge longrun improvements

profile.d/prompt.sh

@@ -35,17 +35,26 @@
 
 # ------------------------------------------------------------------------------
 # timer_* functions : internal timing function for prompt
-# ------------------------------------------------------------------------------
+# Usage: timer_now
+# This function returns the current time in nanoseconds since the epoch. It
+# first tries to use the %N format specifier for nanoseconds, but if that is
+# not supported (e.g., on older systems), it falls back to seconds.
 function timer_now
 {
     date +%s%N 2>/dev/null || date +%s
 }
 
+# Usage: timer_start
+# This function initializes the timer_start variable with the current time in
+# nanoseconds. It is used to measure the elapsed time for the prompt.
 function timer_start
 {
     timer_start=${timer_start:-$(timer_now)}
 }
 
+# Usage: timer_stop
+# This function calculates the elapsed time since timer_start and formats it
+# into a human-readable string with appropriate units (us, ms, s, m, h
 function timer_stop
 {
     local delta_us=$((($(timer_now) - $timer_start) / 1000))
@@ -74,8 +83,11 @@ function timer_stop
 }
 
 # ------------------------------------------------------------------------------
-# Function triguered internaly by bash : defining prompt
-# ------------------------------------------------------------------------------
+# Function triggered internally by bash : defining prompt
+# Usage: set_prompt
+# This function is called by bash before displaying the prompt. It sets the
+# PS1 variable to a custom prompt that includes the exit status of the last
+# command, the elapsed time of the last command, and the current user and host.
 set_prompt()
 {
     local Last_Command=$? # Must come first!
@@ -123,6 +135,7 @@ set_prompt()
     # the text color to the default.
     PS1+="$ICyan\\w \\\$$Default "
 }
-
 # ------------------------------------------------------------------------------
+
+
 # EOF