igwn-cmake-macros 1.5.0
Functions
PrintingMessages

Functions

 cx_msg_debug (txt)
 Display debugging message. More...
 
 cx_msg_debug_variable (variable)
 Display debugging message. More...
 
 cm_msg_checking (MSG)
 Display checking message. More...
 
 cm_msg_error (txt)
 Display error message. More...
 
 cm_msg_failure (txt)
 Display failure message. More...
 
 cm_msg_result (MSG)
 Display result message. More...
 
 cm_msg_warn (txt)
 Display warning message. More...
 

Detailed Description

Display messages to user

Function Documentation

◆ cm_msg_checking()

cm_msg_checking ( MSG  )

Display checking message.

Display a message informing the user of a feature being checked This command should be immediately followed by cm_msg_result

Parameters
MSGMessage to display
See also
cm_msg_result
Note
The message displayed will not contain a newline.
cm_msg_checking( "for something" )
cm_msg_checking(MSG)
Display checking message.
Author
Edward Maros
Date
2019-2020

◆ cm_msg_error()

cm_msg_error ( txt  )

Display error message.

Display a message describing an issue preventing configuration to complete.

Parameters
txtMessage to display
cm_msg_error( "Something really bad has happened" )
cm_msg_error(txt)
Display error message.
Author
Edward Maros
Date
2019-2020

◆ cm_msg_failure()

cm_msg_failure ( txt  )

Display failure message.

Display a message describing an issue preventing configuration to complete.

Parameters
txtMessage to display
cm_msg_failure( "Something really bad has happened" )
cm_msg_failure(txt)
Display failure message.
Author
Edward Maros
Date
2019-2020

◆ cm_msg_result()

cm_msg_result ( MSG  )

Display result message.

Display a message informing the user of the availability of the feature that was being checked. This command should be immediately preceded by cm_msg_checking

Parameters
MSGMessage to display
See also
cm_msg_checking
cm_msg_result( "yes" )
cm_msg_result(MSG)
Display result message.
Author
Edward Maros
Date
2019-2020

◆ cm_msg_warn()

cm_msg_warn ( txt  )

Display warning message.

Display a message describing a possible probelm

Parameters
txtIf a list, then a collection of items to be displayed If a string, then a text string to be displayed
cm_msg_warn( "This was unexpected" )
cm_msg_warn(txt)
Display warning message.
Author
Edward Maros
Date
2019-2020

◆ cx_msg_debug()

cx_msg_debug ( txt  )

Display debugging message.

This command will display the txt on the screen if the global variable CM_MSG_DEBUG_VERBOSE is True

Parameters
txtIf a list, then a collection of items to be displayed If a string, then a text string to be displayed
Note
These messages will only be displayed if the package was configured with CM_MSG_DEBUG_VEROSE being defined as True
See also
cx_msg_debug_variable
cx_msg_debug( "hello world" )
cx_msg_debug(txt)
Display debugging message.
Author
Edward Maros
Date
2019-2020

◆ cx_msg_debug_variable()

cx_msg_debug_variable ( variable  )

Display debugging message.

This command will display the variable name followed by its value if the global variable CM_MSG_DEBUG_VERBOSE is True

Parameters
txtIf a list, then a collection of items to be displayed If a string, then a text string to be displayed
See also
cx_msg_debug
cx_msg_debug_variable(variable)
Display debugging message.
Author
Edward Maros
Date
2019-2020