B | |
| both [MakeMake] |
Expands all file roots X in a list into X.mli and X.ml so you needn't specify both files
for each module
|
C | |
| chomp [Util] |
Chomps off the last character of the string - useful for path manglish sometimes
|
| chomp_char [Util] |
Chomps off the last character only if it matches given char
|
| chomp_eol [Util] |
Chomps the last character only if it is a trailing \n - convenience wrapper only
|
| conf_bool [Conf] | |
| conf_string [Conf] | |
| conf_stringlist [Conf] |
This, and the next couple functions, are just wrappers around the
value variant
type, to save you a couple lines of code - keeping the configure.ml small is key
|
| conf_value [Conf] | |
| configure [Conf] |
Takes a
configuration_item list, supplemented with a bool to
say whether to show each item to the user, and returns the
configuration that results from all the tests are command-line
parameters.
|
| custom [Conf] | custom f allows you to have a totally custom configuration function that takes in the
configuration so far, and returns a possibly modified configuration.
|
D | |
| documentation [MakeMake] | documentation name adds targets name ^ ".html", name ^ ".tex" etc for all
output formats of ocamldoc
|
E | |
| escape_slashes [Util] |
Escapes all the slashes in a string so it can be used as a regexp
|
| executable [MakeMake] | |
F | |
| findlib_check [Conf] | findlib_check name checks that a findlib package called name
exists.
|
L | |
| library [MakeMake] | |
O | |
| output [MakeMake] |
Outputs a Makefile, (and in the futere, META file if applicable).
|
| output_config_file [Conf] |
Outputs your completed config into a string, which is valid
ML and can be used by your program
|
P | |
| param [Conf] | param name defaultvalue provides a compile-time parameter that can be overridden
by the user.
|
| path_search [Conf] | path_search name doc paths performs a rudimentary search through the list of
paths.
|
| prefix [MakeMake] |
Prefixes all sources files with a string, presumably something like
"src/"
|
S | |
| script [MakeMake] |
A script that is not built, but should be installed somewhere
|
| shell_capture [Util] |
Executes the given string in a shell, and returns what came through stdout, by
default clips it at 100 chars, because you are probably just filling in a command
path - if you don't need the output of the command, use Unix.system or Sys.command.
|
| split [MakeMake] |
Splits a string on whitespace; this is a very common thing to do in order to specify your sources
in a string rather than a list - save some typing :-)
|
| standard_spec [Conf] |
A fairly standard configuration.
|
| summarize_config [Conf] |
Returns a human readable version of the configuration
|
T | |
| toplevel [MakeMake] |
A toplevel with the given sources pre-loaded
|