Abuild has a built-in help system, introduced in version 1.1, that makes it easier for users to get help for abuild itself and also for available rules, both built-in and user-supplied. All help text that is part of the abuild distribution can also be seen in Appendix E, Online Help Files.
The starting point to abuild's help system is the command abuild --help. Help is available on a variety of general topics including the help system and command invocation. You can also get help on rules. You can see information about what kinds of help is available on rules by running abuild --help rules.
The rules help facility offers three major capabilities. By
running abuild --help rules list, you can see
the list of compiler toolchains and also the list of available
rules that you can assign to RULES
(make) or
abuild.rules
(Groovy). In addition to telling
you what's offered overall, this will tell you what target types
the rules apply to, and whether the rules are available to you
through your dependency chain. That way, if you need to make use
of a rule that is provided by some build item that you don't
depend on, you can know which item you need to add a dependency on
to gain access to the rule. Once you know which toolchain or rule
you want help on, you can use abuild --help rules
toolchain:toolchain-name
or
abuild --help rules
rule:rule-name
to get
available help for that toolchain or rule.
Creating help files is very straightforward. For any toolchain
support file or rule file, in the same directory, create a text
file called
or
toolchain-name
-help.txt
as appropriate. The contents of this help file will be displayed
to the user when help is requested on that toolchain or rule.
Lines within the help text that start with
“rule-name
-help.txt#
” are ignored, which makes it
possible for you to include notes to people who might be
maintaining the help file. Also, abuild normalizes line
terminators, displaying the help with whatever the platform's
native line terminator is.
We present examples of help files in this manual as we present information about adding rules and toolchain support files. You can also run abuild --help helpfiles for a reminder about the help file format. (This text is also available in Section E.2, “abuild --help helpfiles”.) To see an example of rule help, see Section 22.2, “Code Generator Example for Make”. To see an example of toolchain help, see Section 29.5.3, “Platforms and Platform Type Plugins”.