makl_utils Namespace Reference

Module "makl_utils". More...


Functions

 makl_pkg_name ()
 Set the package name.
 makl_pkg_version ()
 Set the package version.
 makl_os_name ()
 Print the OS name.
 makl_target_name ()
 Print the target OS name.
 makl_err ()
 Write a message and exit.
 makl_info ()
 Print info.
 makl_dbg ()
 Print a debug message.
 makl_warn ()
 Print a warning message.
 makl_dbg_globals ()
 Print global variables.
 makl_check_tools ()
 Tool requirements check.
 makl_upper ()
 Transform lower case letters into upper case letters.
 makl_cleanup_rundir ()
 Cleanup run-time directory.
 makl_die ()
 Clean MaKL exit.
 makl_yesno ()
 Yes/No Question.
 makl_is_mode ()
 Check validity of a mode string.
 _makl_set_dirs ()
 Generate default directories.
 makl_file_sub ()
 Perform file substitution.
 _makl_file_sub ()


Function Documentation

makl_utils::_makl_set_dirs (  ) 

Generate default installation directories starting from "__prefix__". Note: should match etc/map.mk configuration

Definition at line 273 of file makl_utils.dokl.

makl_utils::makl_check_tools (  ) 

Check existence of basic tool requirements.

Parameters:
$1 0 if tools don't use stdin, 1 otherwise
$@ list of tools

Definition at line 169 of file makl_utils.dokl.

makl_utils::makl_cleanup_rundir (  ) 

Cleanup run-time directory ${makl_run_dir}.

Definition at line 205 of file makl_utils.dokl.

Referenced by makl_die(), and makl_err().

makl_utils::makl_dbg (  ) 

Print the supplied debug message to stderr if "makl_debug" variable is set to "true", "yes", "on" or '1'.

Parameters:
$1 debug string

Definition at line 131 of file makl_utils.dokl.

Referenced by makl_dbg_globals().

makl_utils::makl_dbg_globals (  ) 

Print MaKL global variables in use to stderr if 'makl_debug' is set.

Definition at line 153 of file makl_utils.dokl.

References makl_dbg().

makl_utils::makl_die (  ) 

Exit from MaKL cleanly with return code $1

Parameters:
$1 - the return code

Definition at line 218 of file makl_utils.dokl.

References makl_cleanup_rundir().

makl_utils::makl_err (  ) 

Print the supplied error string to stderr and bail out with the given exit code.

Parameters:
$1 exit code
$2 error string

Definition at line 101 of file makl_utils.dokl.

References makl_cleanup_rundir().

Referenced by _makl_file_sub(), makl_pkg_name(), and makl_pkg_version().

makl_utils::makl_file_sub (  ) 

Substitute values in given files with Makfile variables.

Parameters:
$@ the names of the output files for substitution (corresponding .in file should exist)

Definition at line 321 of file makl_utils.dokl.

makl_utils::makl_info (  ) 

Print some basic info on MaKL operations.

Parameters:
$1 info string

Definition at line 118 of file makl_utils.dokl.

Referenced by _makl_file_sub(), makl_pkg_name(), and makl_pkg_version().

makl_utils::makl_is_mode (  ) 

Check whether $1 is a valid mode string (3 octal digits).

Parameters:
$1 - mode string
Returns:
0 if valid, 1 otherwise

Definition at line 260 of file makl_utils.dokl.

makl_utils::makl_os_name (  ) 

Print a brief string representing the operating system type and version.

Definition at line 72 of file makl_utils.dokl.

makl_utils::makl_pkg_name (  ) 

Set the package name to $1.

Parameters:
$1 package name

Definition at line 13 of file makl_utils.dokl.

References makl_err(), and makl_info().

makl_utils::makl_pkg_version (  ) 

Set the package version to $1. [format: "X.Y.Zdesc", where X, Y and Z are digits and desc is alphanumeric] If no argument is supplied, a file named VERSION in the base directory containing the version is expected. The package name must already be defined by makl_pkg_name().

Parameters:
$1 package version (optional)

Definition at line 33 of file makl_utils.dokl.

References makl_err(), and makl_info().

makl_utils::makl_target_name (  ) 

Print a brief string representing the target operating system type and version.

Definition at line 83 of file makl_utils.dokl.

makl_utils::makl_upper (  ) 

Transform lower case letters into upper case letters.

Parameters:
$* list of 0 or more strings to be converted

Definition at line 195 of file makl_utils.dokl.

makl_utils::makl_warn (  ) 

Print the supplied warning message to stderr.

Parameters:
$1 warning string

Definition at line 143 of file makl_utils.dokl.

makl_utils::makl_yesno (  ) 

Write question $1 to the terminal and wait for the user to answer.

Parameters:
$1 - question string
Returns:
0 if [yY] was typed, 1 if [nN].

Definition at line 232 of file makl_utils.dokl.


←Products
© 2005-2008 - KoanLogic S.r.l. - All rights reserved