2
0
mirror of https://github.com/boostorg/build.git synced 2026-02-14 00:32:11 +00:00

Add doc comment for lzma initialization.

This commit is contained in:
Steven Watanabe
2018-01-16 11:39:44 -07:00
parent eb06ae1183
commit c4888bee96

View File

@@ -33,6 +33,29 @@ if --debug-configuration in [ modules.peek : ARGV ]
.debug = true ;
}
# Initializes the lzma library.
#
# Options for configuring lzma::
#
# <search>
# The directory containing the lzma binaries.
# <name>
# Overrides the default library name.
# <include>
# The directory containing the lzma headers.
#
# If none of these options is specified, then the environmental
# variables LZMA_LIBRARY_PATH, LZMA_NAME, and LZMA_INCLUDE will
# be used instead.
#
# Examples::
#
# # Find lzma in the default system location
# using lzma ;
# # Find lzma in /usr/local
# using lzma : 1.2.7
# : <include>/usr/local/include <search>/usr/local/lib ;
#
rule init (
version ?
# (currently ignored)