diff options
Diffstat (limited to 'kBuild/doc')
| -rw-r--r-- | kBuild/doc/COPYING-FDL-1.3 | 451 | ||||
| -rw-r--r-- | kBuild/doc/Makefile.kmk | 63 | ||||
| -rw-r--r-- | kBuild/doc/QuickReference-kBuild.txt | 276 | ||||
| -rw-r--r-- | kBuild/doc/QuickReference-kmk.html | 1512 | ||||
| -rw-r--r-- | kBuild/doc/QuickReference-kmk.txt | 1054 | ||||
| -rw-r--r-- | kBuild/doc/example1/Config.kmk | 25 | ||||
| -rw-r--r-- | kBuild/doc/example1/Makefile.kmk | 43 | ||||
| -rw-r--r-- | kBuild/doc/example1/hello.c | 21 | ||||
| -rw-r--r-- | kBuild/doc/example1/hellolib.c | 20 | ||||
| -rw-r--r-- | kBuild/doc/example1/libhello/Makefile.kmk | 30 | ||||
| -rw-r--r-- | kBuild/doc/example1/libhello/libhello.c | 24 |
11 files changed, 3519 insertions, 0 deletions
diff --git a/kBuild/doc/COPYING-FDL-1.3 b/kBuild/doc/COPYING-FDL-1.3 new file mode 100644 index 0000000..2f7e03c --- /dev/null +++ b/kBuild/doc/COPYING-FDL-1.3 @@ -0,0 +1,451 @@ + + GNU Free Documentation License + Version 1.3, 3 November 2008 + + + Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. + <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +functional and useful document "free" in the sense of freedom: to +assure everyone the effective freedom to copy and redistribute it, +with or without modifying it, either commercially or noncommercially. +Secondarily, this License preserves for the author and publisher a way +to get credit for their work, while not being considered responsible +for modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work, in any medium, that +contains a notice placed by the copyright holder saying it can be +distributed under the terms of this License. Such a notice grants a +world-wide, royalty-free license, unlimited in duration, to use that +work under the conditions stated herein. The "Document", below, +refers to any such manual or work. Any member of the public is a +licensee, and is addressed as "you". You accept the license if you +copy, modify or distribute the work in a way requiring permission +under copyright law. + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall +subject (or to related matters) and contains nothing that could fall +directly within that overall subject. (Thus, if the Document is in +part a textbook of mathematics, a Secondary Section may not explain +any mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. If a +section does not fit the above definition of Secondary then it is not +allowed to be designated as Invariant. The Document may contain zero +Invariant Sections. If the Document does not identify any Invariant +Sections then there are none. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. A Front-Cover Text may +be at most 5 words, and a Back-Cover Text may be at most 25 words. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, that is suitable for revising the document +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup, or absence of markup, has been arranged to thwart +or discourage subsequent modification by readers is not Transparent. +An image format is not Transparent if used for any substantial amount +of text. A copy that is not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML, PostScript or PDF designed for human modification. Examples of +transparent image formats include PNG, XCF and JPG. Opaque formats +include proprietary formats that can be read and edited only by +proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML, PostScript or PDF produced by some word +processors for output purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + +The "publisher" means any person or entity that distributes copies of +the Document to the public. + +A section "Entitled XYZ" means a named subunit of the Document whose +title either is precisely XYZ or contains XYZ in parentheses following +text that translates XYZ in another language. (Here XYZ stands for a +specific section name mentioned below, such as "Acknowledgements", +"Dedications", "Endorsements", or "History".) To "Preserve the Title" +of such a section when you modify the Document means that it remains a +section "Entitled XYZ" according to this definition. + +The Document may include Warranty Disclaimers next to the notice which +states that this License applies to the Document. These Warranty +Disclaimers are considered to be included by reference in this +License, but only as regards disclaiming warranties: any other +implication that these Warranty Disclaimers may have is void and has +no effect on the meaning of this License. + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no +other conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies (or copies in media that commonly have +printed covers) of the Document, numbering more than 100, and the +Document's license notice requires Cover Texts, you must enclose the +copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a computer-network location from which the general network-using +public has access to download using public-standard network protocols +a complete Transparent copy of the Document, free of added material. +If you use the latter option, you must take reasonably prudent steps, +when you begin distribution of Opaque copies in quantity, to ensure +that this Transparent copy will remain thus accessible at the stated +location until at least one year after the last time you distribute an +Opaque copy (directly or through your agents or retailers) of that +edition to the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to +give them a chance to provide you with an updated version of the +Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has fewer than five), + unless they release you from this requirement. +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section Entitled "History", Preserve its Title, and add + to it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section Entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. For any section Entitled "Acknowledgements" or "Dedications", + Preserve the Title of the section, and preserve in the section all + the substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section Entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section to be Entitled "Endorsements" + or to conflict in title with any Invariant Section. +O. Preserve any Warranty Disclaimers. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section Entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice, and that you preserve all their Warranty Disclaimers. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections Entitled "History" +in the various original documents, forming one section Entitled +"History"; likewise combine any sections Entitled "Acknowledgements", +and any sections Entitled "Dedications". You must delete all sections +Entitled "Endorsements". + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other +documents released under this License, and replace the individual +copies of this License in the various documents with a single copy +that is included in the collection, provided that you follow the rules +of this License for verbatim copying of each of the documents in all +other respects. + +You may extract a single document from such a collection, and +distribute it individually under this License, provided you insert a +copy of this License into the extracted document, and follow this +License in all other respects regarding verbatim copying of that +document. + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, is called an "aggregate" if the copyright +resulting from the compilation is not used to limit the legal rights +of the compilation's users beyond what the individual works permit. +When the Document is included in an aggregate, this License does not +apply to the other works in the aggregate which are not themselves +derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one half of +the entire aggregate, the Document's Cover Texts may be placed on +covers that bracket the Document within the aggregate, or the +electronic equivalent of covers if the Document is in electronic form. +Otherwise they must appear on printed covers that bracket the whole +aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License, and all the license notices in the +Document, and any Warranty Disclaimers, provided that you also include +the original English version of this License and the original versions +of those notices and disclaimers. In case of a disagreement between +the translation and the original version of this License or a notice +or disclaimer, the original version will prevail. + +If a section in the Document is Entitled "Acknowledgements", +"Dedications", or "History", the requirement (section 4) to Preserve +its Title (section 1) will typically require changing the actual +title. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense, or distribute it is void, and +will automatically terminate your rights under this License. + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, receipt of a copy of some or all of the same material does +not give you any rights to use it. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions of the +GNU Free Documentation License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. See +http://www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. If the Document +specifies that a proxy can decide which future versions of this +License can be used, that proxy's public statement of acceptance of a +version permanently authorizes you to choose that version for the +Document. + +11. RELICENSING + +"Massive Multiauthor Collaboration Site" (or "MMC Site") means any +World Wide Web server that publishes copyrightable works and also +provides prominent facilities for anybody to edit those works. A +public wiki that anybody can edit is an example of such a server. A +"Massive Multiauthor Collaboration" (or "MMC") contained in the site +means any set of copyrightable works thus published on the MMC site. + +"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 +license published by Creative Commons Corporation, a not-for-profit +corporation with a principal place of business in San Francisco, +California, as well as future copyleft versions of that license +published by that same organization. + +"Incorporate" means to publish or republish a Document, in whole or in +part, as part of another Document. + +An MMC is "eligible for relicensing" if it is licensed under this +License, and if all works that were first published under this License +somewhere other than this MMC, and subsequently incorporated in whole or +in part into the MMC, (1) had no cover texts or invariant sections, and +(2) were thus incorporated prior to November 1, 2008. + +The operator of an MMC Site may republish an MMC contained in the site +under CC-BY-SA on the same site at any time before August 1, 2009, +provided the MMC is eligible for relicensing. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.3 + or any later version published by the Free Software Foundation; + with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, +replace the "with...Texts." line with this: + + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + +If you have Invariant Sections without Cover Texts, or some other +combination of the three, merge those two alternatives to suit the +situation. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. diff --git a/kBuild/doc/Makefile.kmk b/kBuild/doc/Makefile.kmk new file mode 100644 index 0000000..17730b1 --- /dev/null +++ b/kBuild/doc/Makefile.kmk @@ -0,0 +1,63 @@ +DEPTH = ../.. +include ../header.kmk + +TXTFILES = \ + QuickReference-kmk.txt \ + QuickReference-kBuild.txt + +define genrule +all: $(name).html +clean:: + kmk_rm -f $(name).html +$(name).html: $(name).txt + LC_ALL=C rst2html.py --no-generator $$< $$@ +$(name).o: $(name).html +.PHONY: $(name).o +endef + +$(foreach name, $(basename $(TXTFILES)), $(eval $(genrule))) + + +# +# For generating the basis for the target properties table. +# +my_tp.1 = BLDPROGS PROGRAMS +my_tp.2 = LIBRARIES +my_tp.3 = IMPORT_LIBS DLLS +my_tp.4 = DLLS +my_tp.5 = PROGRAMS +my_tp.6 = SYSMODS +my_tp.7 = MISCBINS +my_tp.8 = INSTALLS +my_tp.9 = FETCHES +my_tp.a = OTHERS +my_tp = 1 2 3 4 5 6 7 8 9 a +tpc := $(translate $(my_tp),$(SP)) + +define def_target_prop_rule +target-properties:: + @$$(PRINTF) '|%-2s| %-18s| %-6s|%$(expr 79-33)s|\n' "$(kind)" "``$(prop)``" "$(my_tmp_which)" "" + @$$(ECHO) '+--+-------------------+-------+----------------------------------------------+' +endef +define def_target_prop_doit +my_tmp_which := $(foreach x,$(my_tp),$(if $(intersects \ + $(prop),\ + $(foreach nm,$(my_tp.$(x)),$(foreach suff,SINGLE DEFERRED ACCUMULATE_R ACCUMULATE_L,$(PROPS_$(nm)_$(suff)))))\ + ,$(x),)) +my_tmp_which := $(translate $(my_tmp_which),$(SP)) +$(for local i = 1, $i < 10, local i := $(expr $i + 1),$(for local l = $(expr 10 - $i + 1), $l > 3, local l := $(expr $l - 1), \ + $(eval my_tmp_which:=$(subst $(substr $(tpc), $i, $l),$i-$(substr $(tpc),$(expr $i + $l - 1),1),$(my_tmp_which)))\ +) ) +$(eval $(def_target_prop_rule)) +endef +kind := S +$(foreach prop,$(sort $(PROPS_SINGLE)),$(evalcall def_target_prop_doit)) +kind := D +$(foreach prop,$(sort $(PROPS_DEFERRED)),$(evalcall def_target_prop_doit)) +kind := Ar +$(foreach prop,$(sort $(PROPS_ACCUMULATE_R)),$(evalcall def_target_prop_doit)) +kind := Al +$(foreach prop,$(sort $(PROPS_ACCUMULATE_L)),$(evalcall def_target_prop_doit)) +#kind := To +#$(foreach prop,$(sort $(PROPS_TOOLS_ONLY)),$(evalcall def_target_prop_doit)) + diff --git a/kBuild/doc/QuickReference-kBuild.txt b/kBuild/doc/QuickReference-kBuild.txt new file mode 100644 index 0000000..70079c1 --- /dev/null +++ b/kBuild/doc/QuickReference-kBuild.txt @@ -0,0 +1,276 @@ + +kBuild Quick Reference +====================== + +This is an attempt at summarizing the magic of kBuild makefiles. + + +The anatomy of a kBuild Makefile +-------------------------------- + +A typical makefile:: + + # $Id: QuickReference-kBuild.txt 2345 2009-04-19 23:47:42Z bird $ + ## @file + # Makefile description. + # + + # + # Copyright (c) year name + # License, disclaimer and other legal text. + # + + SUB_DEPTH = ../.. + include $(KBUILD_PATH)/subheader.kmk + + # + # Include sub-makefiles. + # + include $(PATH_CURRENT)/subdir1/Makefile.kmk + include $(PATH_CURRENT)/subdir2/Makefile.kmk + + # + # Global variables. + # + MYPREFIX_SOMETHING = or another + + # + # Target lists. + # + DLLS += mydll + PROGRAMS += myprogs + + # + # mydll - description. + # + mydll_TEMPLATE = MYDLL + mydll_SOURCES = mydll.c + mydll_SOURCES.win = $(mydll_0_OUTDIR)/mydll.def + + # + # myprog - description. + # + myprog_TEMPLATE = MYPROG + myprog_SOURCES = myprog.c + + # + # Custom rules (optional of course). + # + $$(mydll_0_OUTDIR)/mydll.def: + $(APPEND) -t $@ LIBRARY mydll.dll + $(APPEND) $@ EXPORTS + $(APPEND) $@ ' myfunction' + + include $(FILE_KBUILD_SUB_FOOTER) + + +Target lists +------------ + ++-+-------------------+-------------------------------------------------------+ +|#| Name | Description | ++=+===================+=======================================================+ +|1| ``BLDPROGS`` | Build programs, targets the host platform. | ++-+-------------------+-------------------------------------------------------+ +|2| ``LIBRARIES`` | Libraries (not shared). | ++-+-------------------+-------------------------------------------------------+ +|3| ``IMPORT_LIBS`` | Import libraries or stub shared libraries. | ++-+-------------------+-------------------------------------------------------+ +|4| ``DLLS`` | DLLs, Shared Libraries, DYLIBs, etc. | ++-+-------------------+-------------------------------------------------------+ +|5| ``PROGRAMS`` | Executable programs. | ++-+-------------------+-------------------------------------------------------+ +|6| ``SYSMODS`` | System modules (kexts, kernel modules, drivers, etc). | ++-+-------------------+-------------------------------------------------------+ +|7| ``MISCBINS`` | Miscellanceous binaries like BIOS images and such. | ++-+-------------------+-------------------------------------------------------+ +|8| ``INSTALLS`` | Things to install. [1]_ | ++-+-------------------+-------------------------------------------------------+ +|9| ``FETCHES`` | Things to fetch. [1]_ | ++-+-------------------+-------------------------------------------------------+ +|a| ``OTHERS`` | List of targets made during the others pass. | ++-+-------------------+-------------------------------------------------------+ + + +Target properties +----------------- + +The first column indicates the kind of property, S=Single, D=Deferred, +Ar=Accumlate-Right and Al=Accumulate-Left. + +The third column should be cross referenced with the first column in the +target list table above. + ++--+-------------------+-------+----------------------------------------------+ +|K | Name | Which | Description | ++==+===================+=======+==============================================+ +|S | ``ARLIBSUFF`` | 2 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``ARTOOL`` | 2 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``ASOBJSUFF`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``ASTOOL`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``BINSUFF`` | 7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``BLD_TRG`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``BLD_TRG_ARCH`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``BLD_TRG_CPU`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``BLD_TYPE`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``COBJSUFF`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``CTOOL`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``CXXOBJSUFF`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``CXXTOOL`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``DLLSUFF`` | 34 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``EXESUFF`` | 15 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``FETCHDIR`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``FETCHTOOL`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``GID`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``INST`` | 1-9 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``LDTOOL`` | 13-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``LIBSUFF`` | 234 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``MODE`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``NOINST`` | 1-8 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``OBJCOBJSUFF`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``OBJCTOOL`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``OBJSUFF`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``PATCHTOOL`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``RCOBJSUFF`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``RCTOOL`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``SYSSUFF`` | 6 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``TEMPLATE`` | 1-9 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``TOOL`` | 1-9 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``UID`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|S | ``UNPACKTOOL`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|D | ``INSTALLER`` | 1-8 | | ++--+-------------------+-------+----------------------------------------------+ +|D | ``INSTFUN`` | 1-8 | | ++--+-------------------+-------+----------------------------------------------+ +|D | ``NAME`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|D | ``POST_CMDS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|D | ``PRE_CMDS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|D | ``SONAME`` | 13-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``ARFLAGS`` | 2 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``ASDEFS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``ASFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``CDEFS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``CFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``CXXDEFS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``CXXFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``DEFS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``DEPS`` | 1-8 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``FETCHFLAGS`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``IDFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``IFDLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``ISFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``LDFLAGS`` | 13-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``LNK_DEPS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``LNK_ORDERDEPS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``OBJCDEFS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``OBJCFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``ORDERDEPS`` | 1-8 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``PATCHFLAGS`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``RCDEFS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``RCFLAGS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Ar| ``UNPACKFLAGS`` | 9 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``ASINCS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``BLDDIRS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``CINCS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``CLEAN`` | 1-9 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``CXXINCS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``DIRS`` | 8 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``INCS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``INTERMEDIATES`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``LIBPATH`` | 13-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``LIBS`` | 13-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``OBJCINCS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``RCINCS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``SDKS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``SOURCES`` | 1-9 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``SRC_HANDLERS`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ +|Al| ``USES`` | 1-7 | | ++--+-------------------+-------+----------------------------------------------+ + + +----- + +.. [1] Normally not one of the default passes. + +----- + +:Status: $Id: QuickReference-kBuild.txt 2345 2009-04-19 23:47:42Z bird $ +:Copyright: Copyright (c) 2009 knut st. osmundsen + + diff --git a/kBuild/doc/QuickReference-kmk.html b/kBuild/doc/QuickReference-kmk.html new file mode 100644 index 0000000..e7529a6 --- /dev/null +++ b/kBuild/doc/QuickReference-kmk.html @@ -0,0 +1,1512 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" /> +<title>kmk Quick Reference</title> +<style type="text/css"> + +/* +:Author: David Goodger +:Contact: goodger@users.sourceforge.net +:Date: $Date: 2009-04-18 14:05:47 +0200 (sab, 18 apr 2009) $ +:Revision: $Revision: 2340 $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin-left: 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left { + clear: left } + +img.align-right { + clear: right } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font-family: serif ; + font-size: 100% } + +pre.literal-block, pre.doctest-block { + margin-left: 2em ; + margin-right: 2em ; + background-color: #eeeeee } + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +tt.docutils { + background-color: #eeeeee } + +ul.auto-toc { + list-style-type: none } + +</style> +</head> +<body> +<div class="document" id="kmk-quick-reference"> +<h1 class="title">kmk Quick Reference</h1> +<p>This is an attempt at summarizing all directives, functions, special variables, +special targets, built-in commands, external commands, and <tt class="docutils literal"><span class="pre">kmk</span></tt>-expressions. +Since <em>all</em> the features are included, the quickness of this reference can be +disputed. ;-)</p> +<div class="section"> +<h1><a id="directives" name="directives">Directives</a></h1> +<p>Here is a summary of the directives <tt class="docutils literal"><span class="pre">kmk</span></tt> recognizes:</p> +<blockquote> +<p>Define a multi-line, recursively-expanded variable:</p> +<pre class="literal-block"> +define variable +endef +</pre> +<p>Conditionally evaluate part of the makefile:</p> +<pre class="literal-block"> +ifdef variable +ifndef variable +ifeq (a,b) +ifeq "a" "b" +ifeq 'a' 'b' +ifneq (a,b) +ifneq "a" "b" +ifneq 'a' 'b' +if1of (set-a,set-b) [1] +ifn1of (set-a,set-b) [1] +if expression [1] +else +endif +</pre> +<p>Include another makefile:</p> +<pre class="literal-block"> +include file +-include file +sinclude file +</pre> +<p>Include another dependency file <a class="footnote-reference" href="#id84" id="id1" name="id1">[1]</a>:</p> +<pre class="literal-block"> +includedep file +</pre> +<p>Define a variable, overriding any previous definition, even one from the +command line:</p> +<pre class="literal-block"> +override variable = value +override variable := value +override variable += value +override variable <= value [1] +override variable ?= value +override define variable +endef +</pre> +<p>Tell <tt class="docutils literal"><span class="pre">kmk</span></tt> to export all variables to child processes by default:</p> +<pre class="literal-block"> +export +</pre> +<p>Tell <tt class="docutils literal"><span class="pre">kmk</span></tt> whether or not to export a particular variable to child +processes:</p> +<pre class="literal-block"> +export variable +export variable = value +export variable := value +export variable += value +export variable <= value [1] +export variable ?= value +unexport variable +</pre> +<p>Define a variable in the local context instead of the global one <a class="footnote-reference" href="#id84" id="id2" name="id2">[1]</a>:</p> +<pre class="literal-block"> +local variable = value +local variable := value +local variable += value +local variable <= value +local variable ?= value +local define variable +endef +</pre> +<p>Specify a search path for files matching a <tt class="docutils literal"><span class="pre">%</span></tt> pattern:</p> +<pre class="literal-block"> +vpath pattern path +</pre> +<p>Remove all search paths previously specified for pattern:</p> +<pre class="literal-block"> +vpath pattern +</pre> +<p>Remove all search paths previously specified in any vpath directive:</p> +<pre class="literal-block"> +vpath +</pre> +</blockquote> +</div> +<div class="section"> +<h1><a id="automatic-variables" name="automatic-variables">Automatic variables</a></h1> +<p>Here is a summary of the automatic variables.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="14%" /> +<col width="86%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Variable</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">$@</span></tt></td> +<td>The file name of the target.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$<</span></tt></td> +<td>The name of the first prerequisite.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$?</span></tt></td> +<td>The names of all the prerequisites that are newer than the +target, with spaces between them.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$^</span></tt></td> +<td>The names of all the prerequisites, duplicates omitted.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$+</span></tt></td> +<td>The names of all the prerequisites, duplicates and order +preserved</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$*</span></tt></td> +<td>The stem with which an implicit rule matches.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$|</span></tt></td> +<td>The name of all the order only prerequisites.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(@D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">$@</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(<D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">$<</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(?D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">$?</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(^D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">%^</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(+D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">$+</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(*D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">$*</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(|D)</span></tt></td> +<td>The directory part of <tt class="docutils literal"><span class="pre">$|</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(@F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$@</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(<F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$<</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(?F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$?</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(^F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$^</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(+F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$+</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(*F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$*</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">$(|F)</span></tt></td> +<td>The file-within-directory part of <tt class="docutils literal"><span class="pre">$|</span></tt>.</td> +</tr> +</tbody> +</table> +</div> +<div class="section"> +<h1><a id="special-variables" name="special-variables">Special variables</a></h1> +<p>All variables starting with a <tt class="docutils literal"><span class="pre">.</span></tt> is reserved by <tt class="docutils literal"><span class="pre">kmk</span></tt>. The following +variables are specially used or/and defined by <tt class="docutils literal"><span class="pre">kmk</span></tt>:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="34%" /> +<col width="66%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Variable</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">.DEFAULT_GOAL</span></tt></td> +<td>The makefile default goal. You can set this in +the makefile, if you don't it will default to +the first target that is encountered.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.FEATURES</span></tt></td> +<td>List of GNU <tt class="docutils literal"><span class="pre">make</span></tt> features. Do not set this.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.INCLUDE_DIRS</span></tt></td> +<td>List of include directories, <tt class="docutils literal"><span class="pre">-I</span></tt> arguments +and defaults. Do not set this.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.RECIPEPREFIX</span></tt></td> +<td>Recipe prefix, defaults to tab.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.VARIABLES</span></tt></td> +<td>Special variable which exands to the list of +variable. Do not set this.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">CURDIR</span></tt></td> +<td>Set to the pathname of the current working +directory (after all <tt class="docutils literal"><span class="pre">-C</span></tt> options are +processed, if any). Do not set this.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KBUILD_VERSION</span></tt>, +<tt class="docutils literal"><span class="pre">KBUILD_VERSION_MAJOR</span></tt>, +<tt class="docutils literal"><span class="pre">KBUILD_VERSION_MINOR</span></tt>, +<tt class="docutils literal"><span class="pre">KBUILD_VERSION_PATCH</span></tt>, +<tt class="docutils literal"><span class="pre">KBUILD_KMK_REVISION</span></tt></td> +<td>The kBuild version string and the break down +into individual components. <a class="footnote-reference" href="#id84" id="id3" name="id3">[1]</a></td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST</span></tt> <a class="footnote-reference" href="#id84" id="id4" name="id4">[1]</a></td> +<td>The host operating system.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST_ARCH</span></tt> <a class="footnote-reference" href="#id84" id="id5" name="id5">[1]</a></td> +<td>The host architecture.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KBUILD_HOST_CPU</span></tt> <a class="footnote-reference" href="#id84" id="id6" name="id6">[1]</a></td> +<td>The host CPU <tt class="docutils literal"><span class="pre">kmk</span></tt> is built for, set to +<tt class="docutils literal"><span class="pre">blend</span></tt> if not any particular CPU.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KBUILD_PATH</span></tt> <a class="footnote-reference" href="#id84" id="id7" name="id7">[1]</a></td> +<td>Where the kBuild scripts are.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KBUILD_BIN_PATH</span></tt> <a class="footnote-reference" href="#id84" id="id8" name="id8">[1]</a></td> +<td>Where the host specific kBuild binaries are.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK</span></tt> <a class="footnote-reference" href="#id84" id="id9" name="id9">[1]</a>, +<tt class="docutils literal"><span class="pre">MAKE</span></tt></td> +<td>The name with which <tt class="docutils literal"><span class="pre">kmk</span></tt> was invoked. Using +this variable in recipes has special meaning.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_BUILTIN</span></tt> <a class="footnote-reference" href="#id84" id="id10" name="id10">[1]</a></td> +<td>List of built-in commands.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_FEATURES</span></tt> <a class="footnote-reference" href="#id84" id="id11" name="id11">[1]</a></td> +<td>List of <tt class="docutils literal"><span class="pre">kmk</span></tt> specific features.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_FLAGS</span></tt> <a class="footnote-reference" href="#id84" id="id12" name="id12">[1]</a></td> +<td><p class="first">The flags given to <tt class="docutils literal"><span class="pre">kmk</span></tt>. You can set this in +the environment or a makefile to set flags.</p> +<p class="last">It is never appropriate to use <tt class="docutils literal"><span class="pre">KMK_FLAGS</span></tt> +directly in a recipe line: its contents may not +be quoted correctly for use in the shell. Always +allow recursive <tt class="docutils literal"><span class="pre">kmk</span></tt>'s to obtain these values +through the environment from its parent.</p> +</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_LEVEL</span></tt> <a class="footnote-reference" href="#id84" id="id13" name="id13">[1]</a></td> +<td>The number of levels of recursion (sub-makes).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_VERSION</span></tt> <a class="footnote-reference" href="#id84" id="id14" name="id14">[1]</a></td> +<td>The GNU <tt class="docutils literal"><span class="pre">make</span></tt> version number.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">MAKECMDGOALS</span></tt></td> +<td>The targets given to <tt class="docutils literal"><span class="pre">kmk</span></tt> on the command line. +Do not set this.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">MAKEFILES</span></tt></td> +<td>Makefiles to be read on every invocation of +<tt class="docutils literal"><span class="pre">kmk</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">MAKEFILE_LIST</span></tt></td> +<td>List of the makefiles that <tt class="docutils literal"><span class="pre">kmk</span></tt> has opened.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">MAKESHELL</span></tt></td> +<td>OS/2 and MS-DOS only, the name of the command +interpreter that is to be used by <tt class="docutils literal"><span class="pre">kmk</span></tt>. This +value takes precedence over the value of SHELL.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">SHELL</span></tt></td> +<td>The name of the default command interpreter, +kmk_ash. You can set SHELL in the makefile to +change the shell used to run recipes. The SHELL +variable is handled specially when importing +from and exporting to the environment.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">SUFFIXES</span></tt></td> +<td>The default list of suffixes before <tt class="docutils literal"><span class="pre">kmk</span></tt> +reads any makefiles (always empty).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">VPATH</span></tt></td> +<td>Directory search path for files not found in the +current directory.</td> +</tr> +</tbody> +</table> +<p>The following variables reflects <tt class="docutils literal"><span class="pre">kmk</span></tt> options. Do not set these. <a class="footnote-reference" href="#id84" id="id15" name="id15">[1]</a></p> +<table border="1" class="docutils"> +<colgroup> +<col width="49%" /> +<col width="51%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Variable</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_JOBS</span></tt></td> +<td>-j slots, <tt class="docutils literal"><span class="pre">0</span></tt> if not given.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_KEEP_GOING</span></tt></td> +<td>-k indictor (<tt class="docutils literal"><span class="pre">0</span></tt>/<tt class="docutils literal"><span class="pre">1</span></tt>).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_JUST_PRINT</span></tt></td> +<td>-n indicator (<tt class="docutils literal"><span class="pre">0</span></tt>/<tt class="docutils literal"><span class="pre">1</span></tt>).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_PRORITY</span></tt></td> +<td>--priority level, <tt class="docutils literal"><span class="pre">0</span></tt> if not given.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_AFFINITY</span></tt></td> +<td>--affinity mask, <tt class="docutils literal"><span class="pre">0</span></tt> if not given.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_STATISTICS</span></tt></td> +<td>--statistics indicator (<tt class="docutils literal"><span class="pre">0</span></tt>/<tt class="docutils literal"><span class="pre">1</span></tt>).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_PRINT_TIME</span></tt></td> +<td>The --print-time value.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">KMK_OPTS_PRETTY_COMMAND_PRINTING</span></tt></td> +<td>--pretty-command-printing indicator.</td> +</tr> +</tbody> +</table> +</div> +<div class="section"> +<h1><a id="special-targets" name="special-targets">Special Targets</a></h1> +<p>Certain names have special meanings if they appear as targets.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="41%" /> +<col width="59%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Target</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">.DEFAULT</span></tt></td> +<td>The recipe is used for any target for which +no rules are found.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.DELETE_ON_ERROR</span></tt></td> +<td>If mentioned, <tt class="docutils literal"><span class="pre">kmk</span></tt> will delete the +targets of a rule if it has changed and its +recipe fails or is interrupted.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.EXPORT_ALL_VARIABLES</span></tt></td> +<td>If mentioned, all variables will by default +be exported to child processes.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.IGNORE</span></tt></td> +<td>Ignore errors in the execution of the recipe +for the targets <tt class="docutils literal"><span class="pre">.IGNORE</span></tt> depends on, if +no prequisites all targets are affected.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.INTERMEDIATE</span></tt></td> +<td>The prerequisites are treated as +intermediate files (implicite rules).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.LOW_RESOLUTION_TIME</span></tt></td> +<td><tt class="docutils literal"><span class="pre">kmk</span></tt> will assume prerequisite files are +created with low resolution time stamps.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.NOTPARALLEL</span></tt></td> +<td>If mentioned without any prerequisites, +<tt class="docutils literal"><span class="pre">kmk</span></tt> will run serially as if -j1 was +given. If it has prerequisites <tt class="docutils literal"><span class="pre">kmk</span></tt> <a class="footnote-reference" href="#id84" id="id16" name="id16">[1]</a> +will only do this for the targets among +them.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.PHONY</span></tt></td> +<td>The prerequisites are considered phony and +will be rebuilt unconditionally.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.PRECIOUS</span></tt></td> +<td>The targets which <tt class="docutils literal"><span class="pre">.PRECIOUS</span></tt> depends +will to be deleted if <tt class="docutils literal"><span class="pre">kmk</span></tt> is killed or +interrupted while their building.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.SECONDARY</span></tt></td> +<td>The prerequisites are treated as +intermediate files, except that they are +never automatically deleted. If used with +no prerequisites all targets gets this +treatement.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.SECONDEXPANSION</span></tt></td> +<td>If mentioned, all prerequisite lists after +it will be expanded a second time after all +makefiles have been read.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.SECONDTARGETEXPANSION</span></tt> +<a class="footnote-reference" href="#id84" id="id17" name="id17">[1]</a></td> +<td>If mentioned, all targets after it will be +expanded a second time after all makefiles +have been read.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.SILENT</span></tt></td> +<td><tt class="docutils literal"><span class="pre">kmk</span></tt> will not print the recipe for +targets listed as prerequisites, if none +then it applies to all targets.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">.SUFFIXES</span></tt></td> +<td>The prerequisites are the list of suffixes +used in checking for suffix rules. If it +appears without prerequisites it the suffix +will be cleared.</td> +</tr> +</tbody> +</table> +</div> +<div class="section"> +<h1><a id="commands" name="commands">Commands</a></h1> +<p>Builtin commands <a class="footnote-reference" href="#id84" id="id18" name="id18">[1]</a> all start with <tt class="docutils literal"><span class="pre">kmk_builtin_</span></tt>, so in order to save +space this prefix has been omitted in the table below. All commands comes in an +external edition that can be used by/in the shell, these are prefixed <tt class="docutils literal"><span class="pre">kmk_</span></tt>.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Command</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">append</span></tt></td> +<td>Append text to a file. The builtin version can output the +value of a variable or the commands of a target.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">cat</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">cat</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">chmod</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">chmod</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">cmp</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">cmp</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">cp</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">cp</span></tt> command with some twaking.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">echo</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">echo</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">expr</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">expr</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">install</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">install</span></tt> command with some tweaking.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">kDepIDB</span></tt></td> +<td>Extract dependencies from a Visual C++ .IDB file.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">ln</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">ln</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">md5sum</span></tt></td> +<td>Typical MD5 sum program, custom kBuild version.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">mkdir</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">mkdir</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">mv</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">mv</span></tt> command with some tweaking.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">printf</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">printf</span></tt> command.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">rm</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">rm</span></tt> command with some tweaking.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">rmdir</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">rmdir</span></tt> command with some tweaking.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">sleep</span></tt></td> +<td>Typical <tt class="docutils literal"><span class="pre">sleep</span></tt> program, custom kBuild version.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">test</span></tt></td> +<td>The BSD <tt class="docutils literal"><span class="pre">test</span></tt> program with some tweaking.</td> +</tr> +</tbody> +</table> +<p>Some additional external commands are available in the <tt class="docutils literal"><span class="pre">kmk</span></tt> / <tt class="docutils literal"><span class="pre">kBuild</span></tt> +environment (<tt class="docutils literal"><span class="pre">kSomething</span></tt> command are not prefixed with <tt class="docutils literal"><span class="pre">kmk_</span></tt>):</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="80%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Command</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">kDepPre</span></tt></td> +<td>Extract dependencies from the C/C++ preprocessor output.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">kObjCache</span></tt></td> +<td>Simple object file cache program.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">ash</span></tt></td> +<td>Almquist's shell (NetBSD variant).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">gmake</span></tt></td> +<td>Vanilla GNU <tt class="docutils literal"><span class="pre">make</span></tt> from same sources as <tt class="docutils literal"><span class="pre">kmk</span></tt>.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">redirect</span></tt></td> +<td>Shell avoidance tool. Sets up file descriptors, environment +variables and current directory before kicking of program.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">sed</span></tt></td> +<td>GNU <tt class="docutils literal"><span class="pre">sed</span></tt> with some tweaks to avoid involving the shell.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">time</span></tt></td> +<td>Stopwatch utility for measuring program execution time(s).</td> +</tr> +</tbody> +</table> +</div> +<div class="section"> +<h1><a id="kmk-expression" name="kmk-expression">kmk-expression</a></h1> +<p><tt class="docutils literal"><span class="pre">kmk</span></tt>-expressions <a class="footnote-reference" href="#id84" id="id19" name="id19">[1]</a> are related to the C/C++ preprocessor in some ways as +well as <tt class="docutils literal"><span class="pre">nmake</span></tt> and BSD <tt class="docutils literal"><span class="pre">make</span></tt>. There are however some peculiarities +because of the way GNU <tt class="docutils literal"><span class="pre">make</span></tt> choose to represent booleans in its function +library, so, strings can be turned into boolean by taking any non-empty string +as true.</p> +<p>Quoting using single quotes results in hard strings, while double quotes and +unquoted string results in soft strings that can be converted to number or +boolean to fit the situation.</p> +<p>Here's the operator table in decending precedence order:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="20%" /> +<col width="11%" /> +<col width="70%" /> +</colgroup> +<thead valign="bottom"> +<tr><th class="head">Operator</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr><td><tt class="docutils literal"><span class="pre">defined</span></tt></td> +<td rowspan="6">Unary</td> +<td>Checks if the following variable exists.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">exists</span></tt></td> +<td>Checks if the following file exists.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">target</span></tt></td> +<td>Checks if the following target exists.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">bool</span></tt></td> +<td>Casts the following value to boolean.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">num</span></tt></td> +<td>Casts the following value to a number.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">str</span></tt></td> +<td>Casts the following value to a string.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">!</span></tt></td> +<td rowspan="4">Unary</td> +<td>Logical NOT.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">+</span></tt></td> +<td>Pluss prefix.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">-</span></tt></td> +<td>Minus prefix.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">~</span></tt></td> +<td>Bitwise one's complement.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">*</span></tt></td> +<td rowspan="3">Binary</td> +<td>Multiplication (product).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">/</span></tt></td> +<td>Division (quotient).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">%</span></tt></td> +<td>Modulus (remainder).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">+</span></tt></td> +<td rowspan="2">Binary</td> +<td>Addition (sum).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">-</span></tt></td> +<td>Subtraction (difference).</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre"><<</span></tt></td> +<td rowspan="2">Binary</td> +<td>Bitwise left shift.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">>></span></tt></td> +<td>Bitwise right shift.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre"><=</span></tt></td> +<td rowspan="4">Binary</td> +<td>Less or equal than.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre"><</span></tt></td> +<td>Less than.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">>=</span></tt></td> +<td>Greater or equal than.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">></span></tt></td> +<td>Greater than.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">==</span></tt></td> +<td rowspan="2">Binary</td> +<td>Equal to.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">!=</span></tt></td> +<td>Not equal to.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">&</span></tt></td> +<td>Binary</td> +<td>Bitwise AND.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">^</span></tt></td> +<td>Binary</td> +<td>Bitwise XOR.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">|</span></tt></td> +<td>Binary</td> +<td>Bitwise OR.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">&&</span></tt></td> +<td>Binary</td> +<td>Logical AND.</td> +</tr> +<tr><td><tt class="docutils literal"><span class="pre">||</span></tt></td> +<td>Binary</td> +<td>Logical OR.</td> +</tr> +</tbody> +</table> +</div> +<div class="section"> +<h1><a id="built-in-functions" name="built-in-functions">Built-in functions</a></h1> +<p>String Manipulation Functions:</p> +<blockquote> +<p>Replace <tt class="docutils literal"><span class="pre">from</span></tt> with <tt class="docutils literal"><span class="pre">to</span></tt> in <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(subst from,to,text) +</pre> +<p>Replace words matching <tt class="docutils literal"><span class="pre">pattern</span></tt> with <tt class="docutils literal"><span class="pre">replacement</span></tt> in <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(patsubst pattern,replacement,text) +</pre> +<p>Remove excess whitespace characters from <tt class="docutils literal"><span class="pre">string</span></tt>:</p> +<pre class="literal-block"> +$(strip string) +</pre> +<p>Locate <tt class="docutils literal"><span class="pre">find</span></tt> in <tt class="docutils literal"><span class="pre">text</span></tt>, returning <tt class="docutils literal"><span class="pre">find</span></tt> if found:</p> +<pre class="literal-block"> +$(findstring find,text) +</pre> +<p>Select words in <tt class="docutils literal"><span class="pre">text</span></tt> that match one of the <tt class="docutils literal"><span class="pre">pattern</span></tt> words:</p> +<pre class="literal-block"> +$(filter pattern...,text) +</pre> +<p>Select words in <tt class="docutils literal"><span class="pre">text</span></tt> that do not match any of the <tt class="docutils literal"><span class="pre">pattern</span></tt> words:</p> +<pre class="literal-block"> +$(filter-out pattern...,text) +</pre> +<p>Sort the words in <tt class="docutils literal"><span class="pre">list</span></tt> lexicographically, removing duplicates:</p> +<pre class="literal-block"> +$(sort list) +</pre> +<p>Sort the words in <tt class="docutils literal"><span class="pre">list</span></tt> lexicographically in reserve order, removing +duplicates <a class="footnote-reference" href="#id84" id="id20" name="id20">[1]</a>:</p> +<pre class="literal-block"> +$(rsort list) +</pre> +<p>Count the number of words in <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(words text) +</pre> +<p>Extract the <tt class="docutils literal"><span class="pre">n</span></tt>th word (one-origin) of <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(word n,text) +</pre> +<p>Returns the list of words in <tt class="docutils literal"><span class="pre">text</span></tt> from <tt class="docutils literal"><span class="pre">s</span></tt> to <tt class="docutils literal"><span class="pre">e</span></tt> (one-origin):</p> +<pre class="literal-block"> +$(wordlist s,e,text) +</pre> +<p>Extract the first word of <tt class="docutils literal"><span class="pre">names</span></tt>:</p> +<pre class="literal-block"> +$(firstword names...) +</pre> +<p>Extract the last word of <tt class="docutils literal"><span class="pre">names</span></tt>:</p> +<pre class="literal-block"> +$(lastword names...) +</pre> +<p>Join two parallel lists of words:</p> +<pre class="literal-block"> +$(join list1,list2) +</pre> +<p>Fold <tt class="docutils literal"><span class="pre">text</span></tt> to upper case <a class="footnote-reference" href="#id84" id="id21" name="id21">[1]</a>:</p> +<pre class="literal-block"> +$(toupper text) +</pre> +<p>Fold <tt class="docutils literal"><span class="pre">text</span></tt> to lower case <a class="footnote-reference" href="#id84" id="id22" name="id22">[1]</a>:</p> +<pre class="literal-block"> +$(tolower text) +</pre> +<p>String formatting a la the unix <tt class="docutils literal"><span class="pre">printf</span></tt> command <a class="footnote-reference" href="#id84" id="id23" name="id23">[1]</a>:</p> +<pre class="literal-block"> +$(printf fmt, arg...) +</pre> +<p>Return the length of a string or a (unexpanded) variable <a class="footnote-reference" href="#id84" id="id24" name="id24">[1]</a>:</p> +<pre class="literal-block"> +$(length string) +$(length-var var) +</pre> +<p>Find the position of <tt class="docutils literal"><span class="pre">needle</span></tt> in <tt class="docutils literal"><span class="pre">haystack</span></tt>, returns 0 if not found. +Negative <tt class="docutils literal"><span class="pre">start</span></tt> indices are relative to the end of <tt class="docutils literal"><span class="pre">haystack</span></tt>, while +positive ones are one based <a class="footnote-reference" href="#id84" id="id25" name="id25">[1]</a>:</p> +<pre class="literal-block"> +$(pos needle, haystack[, start]) +$(lastpos needle, haystack[, start]) +</pre> +<p>Returns the specified substring. The <tt class="docutils literal"><span class="pre">start</span></tt> works like with <tt class="docutils literal"><span class="pre">$(pos</span> <span class="pre">)</span></tt>. +If the substring is partially outside the <tt class="docutils literal"><span class="pre">string</span></tt> the result will be +padded with <tt class="docutils literal"><span class="pre">pad</span></tt> if present <a class="footnote-reference" href="#id84" id="id26" name="id26">[1]</a>:</p> +<pre class="literal-block"> +$(substr string, start[, length[, pad]]) +</pre> +<p>Insert <tt class="docutils literal"><span class="pre">in</span></tt> into <tt class="docutils literal"><span class="pre">str</span></tt> at the specified position. <tt class="docutils literal"><span class="pre">n</span></tt> works like with +<tt class="docutils literal"><span class="pre">$(pos</span> <span class="pre">)</span></tt>, except that <tt class="docutils literal"><span class="pre">0</span></tt> is the end of the string <a class="footnote-reference" href="#id84" id="id27" name="id27">[1]</a>:</p> +<pre class="literal-block"> +$(insert in, str[, n[, length[, pad]]]) +</pre> +<p>Translate <tt class="docutils literal"><span class="pre">string</span></tt> exchanging characters in <tt class="docutils literal"><span class="pre">from-set</span></tt> with <tt class="docutils literal"><span class="pre">to-set</span></tt>, +optionally completing <tt class="docutils literal"><span class="pre">to-set</span></tt> with <tt class="docutils literal"><span class="pre">pad-char</span></tt> if specified. If no +<tt class="docutils literal"><span class="pre">pad-char</span></tt> characters absent in <tt class="docutils literal"><span class="pre">to-set</span></tt> will be deleted <a class="footnote-reference" href="#id84" id="id28" name="id28">[1]</a>:</p> +<pre class="literal-block"> +$(translate string, from-set[, to-set[, pad-char]]) +</pre> +</blockquote> +<p>Functions for file names:</p> +<blockquote> +<p>Extract the directory part of each file <tt class="docutils literal"><span class="pre">name</span></tt>:</p> +<pre class="literal-block"> +$(dir names...) +</pre> +<p>Extract the non-directory part of each file <tt class="docutils literal"><span class="pre">name</span></tt>:</p> +<pre class="literal-block"> +$(notdir names...) +</pre> +<p>Extract the suffix (the last <tt class="docutils literal"><span class="pre">.</span></tt> and following characters) of each file +<tt class="docutils literal"><span class="pre">name</span></tt>:</p> +<pre class="literal-block"> +$(suffix names...) +</pre> +<p>Extract the base name (name without suffix) of each file name:</p> +<pre class="literal-block"> +$(basename names...) +</pre> +<p>Extract the root specification of each file name (a bit complicated on +Windows & OS/2) <a class="footnote-reference" href="#id84" id="id29" name="id29">[1]</a>:</p> +<pre class="literal-block"> +$(root names...) +</pre> +<p>Append <tt class="docutils literal"><span class="pre">suffix</span></tt> to each word in <tt class="docutils literal"><span class="pre">names</span></tt>:</p> +<pre class="literal-block"> +$(addsuffix suffix,names...) +</pre> +<p>Prepend <tt class="docutils literal"><span class="pre">prefix</span></tt> to each word in <tt class="docutils literal"><span class="pre">names</span></tt>:</p> +<pre class="literal-block"> +$(addprefix prefix,names...) +</pre> +<p>Find file names matching a shell file name <tt class="docutils literal"><span class="pre">pattern</span></tt> (not a <tt class="docutils literal"><span class="pre">%</span></tt> +pattern):</p> +<pre class="literal-block"> +$(wildcard pattern...) +</pre> +<p>For each file name in <tt class="docutils literal"><span class="pre">names</span></tt>, expand to an absolute name that does not +contain any <tt class="docutils literal"><span class="pre">.</span></tt>, <tt class="docutils literal"><span class="pre">..</span></tt>, nor symlinks:</p> +<pre class="literal-block"> +$(realpath names...) +</pre> +<p>For each file name in <tt class="docutils literal"><span class="pre">names</span></tt>, expand to an absolute name that does not +contain any <tt class="docutils literal"><span class="pre">.</span></tt> or <tt class="docutils literal"><span class="pre">..</span></tt> components, but preserves symlinks:</p> +<pre class="literal-block"> +$(abspath names...) +</pre> +<p>Same as <tt class="docutils literal"><span class="pre">$(abspath</span> <span class="pre">)</span></tt> except that the current directory can be +specified as <tt class="docutils literal"><span class="pre">curdir</span></tt> <a class="footnote-reference" href="#id84" id="id30" name="id30">[1]</a>:</p> +<pre class="literal-block"> +$(abspathex names...[, curdir]) +</pre> +</blockquote> +<p>Arithmetic Functions:</p> +<blockquote> +<p>Returns the sum of the arguments <a class="footnote-reference" href="#id84" id="id31" name="id31">[1]</a>:</p> +<pre class="literal-block"> +$(int-add addend1, addend2[, addendN]) +</pre> +<p>Returns the difference between the first argument and the sum of the +rest <a class="footnote-reference" href="#id84" id="id32" name="id32">[1]</a>:</p> +<pre class="literal-block"> +$(int-sub minuend, subtrahend[, subtrahendN]) +</pre> +<p>Returns the product of the arguments <a class="footnote-reference" href="#id84" id="id33" name="id33">[1]</a>:</p> +<pre class="literal-block"> +$(int-mul factor1, factor2[, factorN]) +</pre> +<p>Returns the quotient of first argument and the rest <a class="footnote-reference" href="#id84" id="id34" name="id34">[1]</a>:</p> +<pre class="literal-block"> +$(int-div dividend, divisor[, divisorN]) +</pre> +<p>Returns the modulus of the two arguments <a class="footnote-reference" href="#id84" id="id35" name="id35">[1]</a>:</p> +<pre class="literal-block"> +$(int-mod dividend, divisor) +</pre> +<p>Returns the bitwise two-complement of argument <a class="footnote-reference" href="#id84" id="id36" name="id36">[1]</a>:</p> +<pre class="literal-block"> +$(int-not val) +</pre> +<p>Returns the result of a bitwise AND of the arguments <a class="footnote-reference" href="#id84" id="id37" name="id37">[1]</a>:</p> +<pre class="literal-block"> +$(int-and val1, val2[, valN]) +</pre> +<p>Returns the result of a bitwise OR of the arguments <a class="footnote-reference" href="#id84" id="id38" name="id38">[1]</a>:</p> +<pre class="literal-block"> +$(int-or val1, val2[, valN]) +</pre> +<p>Returns the result of a bitwise XOR of the arguments <a class="footnote-reference" href="#id84" id="id39" name="id39">[1]</a>:</p> +<pre class="literal-block"> +$(int-xor val1, val2[, valN]) +</pre> +<p>Returns the <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean (true = non-empty, false = empty) result +of <tt class="docutils literal"><span class="pre">val1</span> <span class="pre">==</span> <span class="pre">val2</span></tt> <a class="footnote-reference" href="#id84" id="id40" name="id40">[1]</a>:</p> +<pre class="literal-block"> +$(int-eq val1, val2) +</pre> +<p>Returns the <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean result of <tt class="docutils literal"><span class="pre">val1</span> <span class="pre">!=</span> <span class="pre">val2</span></tt> <a class="footnote-reference" href="#id84" id="id41" name="id41">[1]</a>:</p> +<pre class="literal-block"> +$(int-ne val1, val2) +</pre> +<p>Returns the <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean result of <tt class="docutils literal"><span class="pre">val1</span> <span class="pre">></span> <span class="pre">val2</span></tt> <a class="footnote-reference" href="#id84" id="id42" name="id42">[1]</a>:</p> +<pre class="literal-block"> +$(int-gt val1, val2) +</pre> +<p>Returns the <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean result of <tt class="docutils literal"><span class="pre">val1</span> <span class="pre">>=</span> <span class="pre">val2</span></tt> <a class="footnote-reference" href="#id84" id="id43" name="id43">[1]</a>:</p> +<pre class="literal-block"> +$(int-ge val1, val2) +</pre> +<p>Returns the <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean result of <tt class="docutils literal"><span class="pre">val1</span> <span class="pre"><</span> <span class="pre">val2</span></tt> <a class="footnote-reference" href="#id84" id="id44" name="id44">[1]</a>:</p> +<pre class="literal-block"> +$(int-lt val1, val2) +</pre> +<p>Returns the <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean result of <tt class="docutils literal"><span class="pre">val1</span> <span class="pre"><=</span> <span class="pre">val2</span></tt> <a class="footnote-reference" href="#id84" id="id45" name="id45">[1]</a>:</p> +<pre class="literal-block"> +$(int-le val1, val2) +</pre> +</blockquote> +<p>Boolean and Conditional Functions:</p> +<blockquote> +<p>Condition is false if the <tt class="docutils literal"><span class="pre">condition</span></tt> evaluates to an empty string +(stripped). Evaluate the <tt class="docutils literal"><span class="pre">true-part</span></tt> if the condition is true, otherwise +the <tt class="docutils literal"><span class="pre">false-part</span></tt>:</p> +<pre class="literal-block"> +$(if condition,true-part[,false-part]) +</pre> +<p>Test if any of the conditions evalues to non-empty string, returning the +first one:</p> +<pre class="literal-block"> +$(or condition1[,condition2[,condition3[...]]]) +</pre> +<p>Test if all of the conditions evaluates to non-empty strings, returning the +last one:</p> +<pre class="literal-block"> +$(and condition1[,condition2[,condition3[...]]]) +</pre> +<p>Test if the two strings are identical, returning <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean (true = +non-empty, false = empty) <a class="footnote-reference" href="#id85" id="id46" name="id46">[2]</a>:</p> +<pre class="literal-block"> +$(eq str1, str2) +</pre> +<p>Invert a <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean value <a class="footnote-reference" href="#id85" id="id47" name="id47">[2]</a>:</p> +<pre class="literal-block"> +$(not val) +</pre> +<p>Test if <tt class="docutils literal"><span class="pre">variable</span></tt> is defined, returning a <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean value <a class="footnote-reference" href="#id84" id="id48" name="id48">[1]</a>:</p> +<pre class="literal-block"> +$(defined variable) +</pre> +<p>Test if <tt class="docutils literal"><span class="pre">set-a</span></tt> and <tt class="docutils literal"><span class="pre">set-b</span></tt> intersects, returning a <tt class="docutils literal"><span class="pre">kmk</span></tt> boolean +value <a class="footnote-reference" href="#id84" id="id49" name="id49">[1]</a>:</p> +<pre class="literal-block"> +$(intersects set-a, set-b) +</pre> +<p>Same as <tt class="docutils literal"><span class="pre">$(if</span> <span class="pre">)</span></tt> execpt that the condition is a <tt class="docutils literal"><span class="pre">kmk</span></tt>-expression <a class="footnote-reference" href="#id84" id="id50" name="id50">[1]</a>:</p> +<pre class="literal-block"> +$(if-expr kmk-expression,true-part[,false-part]) +</pre> +<p>Select the first true condition (<tt class="docutils literal"><span class="pre">kmk</span></tt>-expression) and expand the +following body. Special condition strings <tt class="docutils literal"><span class="pre">default</span></tt> and +<tt class="docutils literal"><span class="pre">otherwise</span></tt> <a class="footnote-reference" href="#id84" id="id51" name="id51">[1]</a>:</p> +<pre class="literal-block"> +$(select when1-cond, when1-body[, whenN-cond, whenN-body]) +</pre> +<p>Evalutate the <tt class="docutils literal"><span class="pre">kmk-expression</span></tt> returning what it evalues as. This is +the preferred way of doing arithmentic now <a class="footnote-reference" href="#id84" id="id52" name="id52">[1]</a>:</p> +<pre class="literal-block"> +$(expr kmk-expression) +</pre> +</blockquote> +<p>Stack Fuctions:</p> +<blockquote> +<p>Push <tt class="docutils literal"><span class="pre">item</span></tt> onto the <tt class="docutils literal"><span class="pre">stack-var</span></tt>, returning the empty string <a class="footnote-reference" href="#id84" id="id53" name="id53">[1]</a>:</p> +<pre class="literal-block"> +$(stack-push stack-var, item) +</pre> +<p>Pop the top item off the <tt class="docutils literal"><span class="pre">stack-var</span></tt> <a class="footnote-reference" href="#id84" id="id54" name="id54">[1]</a>:</p> +<pre class="literal-block"> +$(stack-pop stack-var) +</pre> +<p>Pop the top item off the <tt class="docutils literal"><span class="pre">stack-var</span></tt>, returning the empty string <a class="footnote-reference" href="#id84" id="id55" name="id55">[1]</a>:</p> +<pre class="literal-block"> +$(stack-popv stack-var) +</pre> +<p>Get the top item of the <tt class="docutils literal"><span class="pre">stack-var</span></tt>, returning the empty string <a class="footnote-reference" href="#id84" id="id56" name="id56">[1]</a>:</p> +<pre class="literal-block"> +$(stack-top stack-var) +</pre> +</blockquote> +<p>Advanced Functions:</p> +<blockquote> +<p>Evaluates to the contents of the variable <tt class="docutils literal"><span class="pre">var</span></tt>, with no expansion +performed on it:</p> +<pre class="literal-block"> +$(value var) +</pre> +<p>Evaluate <tt class="docutils literal"><span class="pre">body</span></tt> with <tt class="docutils literal"><span class="pre">var</span></tt> bound to each word in <tt class="docutils literal"><span class="pre">words</span></tt>, and +concatenate the results (spaced):</p> +<pre class="literal-block"> +$(foreach var,words,body) +</pre> +<p>C-style for-loop. Start by evaluating <tt class="docutils literal"><span class="pre">init</span></tt>. Each iteration will +first check whether the <tt class="docutils literal"><span class="pre">condition</span></tt> (<tt class="docutils literal"><span class="pre">kmk</span></tt>-expression) is true, +then expand <tt class="docutils literal"><span class="pre">body</span></tt> concatenating the result to the previous iterations +(spaced), and finally evaluate <tt class="docutils literal"><span class="pre">next</span></tt> <a class="footnote-reference" href="#id84" id="id57" name="id57">[1]</a>:</p> +<pre class="literal-block"> +$(for init,conditions,next,body) +</pre> +<p>C-style while-loop. Each iteration will check whether the <tt class="docutils literal"><span class="pre">condition</span></tt> +(<tt class="docutils literal"><span class="pre">kmk</span></tt>-expression) is true, then expand <tt class="docutils literal"><span class="pre">body</span></tt> concatenating the +result to the previous iterations <a class="footnote-reference" href="#id84" id="id58" name="id58">[1]</a>:</p> +<pre class="literal-block"> +$(while conditions,body) +</pre> +<p>Evaluate the variable <tt class="docutils literal"><span class="pre">var</span></tt> replacing any references to <tt class="docutils literal"><span class="pre">$(1)</span></tt>, +<tt class="docutils literal"><span class="pre">$(2)</span></tt> with the first, second, etc. <tt class="docutils literal"><span class="pre">param</span></tt> values:</p> +<pre class="literal-block"> +$(call var,param,...) +</pre> +<p>Evaluate <tt class="docutils literal"><span class="pre">text</span></tt> then read the results as makefile commands. Expands +to the empty string:</p> +<pre class="literal-block"> +$(eval text) +</pre> +<p>Same as <tt class="docutils literal"><span class="pre">$(eval</span> <span class="pre">text)</span></tt> except that the <tt class="docutils literal"><span class="pre">text</span></tt> is expanded in its +own variable context <a class="footnote-reference" href="#id84" id="id59" name="id59">[1]</a>:</p> +<pre class="literal-block"> +$(evalctx text) +</pre> +<p>Same as <tt class="docutils literal"><span class="pre">$(eval</span> <span class="pre">$(value</span> <span class="pre">var))</span></tt> <a class="footnote-reference" href="#id84" id="id60" name="id60">[1]</a>:</p> +<pre class="literal-block"> +$(evalval var) +</pre> +<p>Same as <tt class="docutils literal"><span class="pre">$(evalctx</span> <span class="pre">$(value</span> <span class="pre">var))</span></tt> <a class="footnote-reference" href="#id84" id="id61" name="id61">[1]</a>:</p> +<pre class="literal-block"> +$(evalvalctx var) +</pre> +<p>A combination of <tt class="docutils literal"><span class="pre">$(eval</span> <span class="pre">)</span></tt>, <tt class="docutils literal"><span class="pre">$(call</span> <span class="pre">)</span></tt> and <tt class="docutils literal"><span class="pre">$(value</span> <span class="pre">)</span></tt> <a class="footnote-reference" href="#id84" id="id62" name="id62">[1]</a>:</p> +<pre class="literal-block"> +$(evalcall var) +</pre> +<p>A combination of <tt class="docutils literal"><span class="pre">$(eval</span> <span class="pre">)</span></tt> and <tt class="docutils literal"><span class="pre">$(call</span> <span class="pre">)</span></tt> <a class="footnote-reference" href="#id84" id="id63" name="id63">[1]</a>:</p> +<pre class="literal-block"> +$(evalcall var) +</pre> +<p>Remove comments and blank lines from the variable <tt class="docutils literal"><span class="pre">var</span></tt>. Expands to +the empty string <a class="footnote-reference" href="#id84" id="id64" name="id64">[1]</a>:</p> +<pre class="literal-block"> +$(eval-opt-var var) +</pre> +<p>Returns accessing <tt class="docutils literal"><span class="pre">$<</span></tt> of <tt class="docutils literal"><span class="pre">target</span></tt>, either retriving the whole thing +or the file at <tt class="docutils literal"><span class="pre">pos</span></tt> (one-origin) <a class="footnote-reference" href="#id84" id="id65" name="id65">[1]</a>:</p> +<pre class="literal-block"> +$(deps target[, pos]) +</pre> +<p>Returns accessing <tt class="docutils literal"><span class="pre">$+</span></tt> (order + duplicates) of <tt class="docutils literal"><span class="pre">target</span></tt>, either +retriving the whole thing or the file at <tt class="docutils literal"><span class="pre">pos</span></tt> (one-origin) <a class="footnote-reference" href="#id84" id="id66" name="id66">[1]</a>:</p> +<pre class="literal-block"> +$(deps-all target[, pos]) +</pre> +<p>Returns accessing <tt class="docutils literal"><span class="pre">$?</span></tt> of <tt class="docutils literal"><span class="pre">target</span></tt>, either retriving the whole +thing or the file at <tt class="docutils literal"><span class="pre">pos</span></tt> (one-origin) <a class="footnote-reference" href="#id84" id="id67" name="id67">[1]</a>:</p> +<pre class="literal-block"> +$(deps-newer target[, pos]) +</pre> +<p>Returns accessing <tt class="docutils literal"><span class="pre">$|</span></tt> (order only) of <tt class="docutils literal"><span class="pre">target</span></tt>, either retriving the +whole thing or the file at <tt class="docutils literal"><span class="pre">pos</span></tt> (one-origin) <a class="footnote-reference" href="#id84" id="id68" name="id68">[1]</a>:</p> +<pre class="literal-block"> +$(deps-oo target[, pos]) +</pre> +</blockquote> +<p>Command Functions:</p> +<blockquote> +<p>Create one or more command lines avoiding the max argument +length restriction of the host OS <a class="footnote-reference" href="#id84" id="id69" name="id69">[1]</a>:</p> +<pre class="literal-block"> +$(xargs ar cas mylib.a,$(objects)) +$(xargs ar cas mylib.a,ar as mylib.a,$(objects)) +</pre> +<p>Returns the commands for the specified target separated by new-line, space, +or a user defined string. Note that this might not produce the 100% correct +result if any of the prerequisite automatic variables are used <a class="footnote-reference" href="#id84" id="id70" name="id70">[1]</a>:</p> +<pre class="literal-block"> +$(commands target) +$(commands-sc target) +$(commands-usr target,sep) +</pre> +<p>Compares two commands returning the empty string if equal and the 3rd +argument if not. This differs from <tt class="docutils literal"><span class="pre">$(comp-vars</span> <span class="pre">v1,v2,ne)</span></tt> in that +line by line is stripped of leading spaces, command prefixes and +trailing spaces before comparing <a class="footnote-reference" href="#id84" id="id71" name="id71">[1]</a>:</p> +<pre class="literal-block"> +$(comp-cmds cmds-var1, cmds-var2, ne) +$(comp-cmds-ex cmds1, cmd2, ne) +</pre> +<p>Compares the values of the two variables returning the empty string if +equal and the 3rd argument if not. Leading and trailing spaces is +ignored <a class="footnote-reference" href="#id84" id="id72" name="id72">[1]</a>:</p> +<pre class="literal-block"> +$(comp-var var1, var2, ne) +</pre> +</blockquote> +<p>Utility functions:</p> +<blockquote> +<p>When this function is evaluated, <tt class="docutils literal"><span class="pre">kmk</span></tt> generates a fatal error with the +message <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(error text...) +</pre> +<p>When this function is evaluated, <tt class="docutils literal"><span class="pre">kmk</span></tt> generates a warning with the +message <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(warning text...) +</pre> +<p>When this function is evaluated, <tt class="docutils literal"><span class="pre">kmk</span></tt> generates a info with the +message <tt class="docutils literal"><span class="pre">text</span></tt>:</p> +<pre class="literal-block"> +$(info text...) +</pre> +<p>Execute a shell <tt class="docutils literal"><span class="pre">command</span></tt> and return its output:</p> +<pre class="literal-block"> +$(shell command) +</pre> +<p>Return a string describing how the <tt class="docutils literal"><span class="pre">kmk</span></tt> variable <tt class="docutils literal"><span class="pre">variable</span></tt> was defined:</p> +<pre class="literal-block"> +$(origin variable) +</pre> +<p>Return a string describing the flavor of the <tt class="docutils literal"><span class="pre">kmk</span></tt> variable <tt class="docutils literal"><span class="pre">variable</span></tt>:</p> +<pre class="literal-block"> +$(flavor variable) +</pre> +<p>Returns the current local time and date formatted in the <tt class="docutils literal"><span class="pre">strftime</span></tt> +style specifier <tt class="docutils literal"><span class="pre">fmt</span></tt>. <tt class="docutils literal"><span class="pre">fmt</span></tt> defaults to <tt class="docutils literal"><span class="pre">%Y-%m-%dT%H:%M:%S</span></tt> when +not specified <a class="footnote-reference" href="#id84" id="id73" name="id73">[1]</a>:</p> +<pre class="literal-block"> +$(date fmt) +</pre> +<p>Returns the current UTC time and date formatted in the <tt class="docutils literal"><span class="pre">strftime</span></tt> +style specifier <tt class="docutils literal"><span class="pre">fmt</span></tt>. <tt class="docutils literal"><span class="pre">fmt</span></tt> defaults to <tt class="docutils literal"><span class="pre">%Y-%m-%dT%H:%M:%SZ</span></tt> when +not specified <a class="footnote-reference" href="#id84" id="id74" name="id74">[1]</a>:</p> +<pre class="literal-block"> +$(date-utc fmt) +</pre> +<p>Reformats the <tt class="docutils literal"><span class="pre">in</span></tt> time and date using <tt class="docutils literal"><span class="pre">fmt</span></tt>. The <tt class="docutils literal"><span class="pre">in-fmt</span></tt> defaults +to <tt class="docutils literal"><span class="pre">fmt</span></tt> if not specified. While <tt class="docutils literal"><span class="pre">fmt</span></tt> defaults to +<tt class="docutils literal"><span class="pre">%Y-%m-%dT%H:%M:%SZ</span></tt> if not specified <a class="footnote-reference" href="#id84" id="id75" name="id75">[1]</a>:</p> +<pre class="literal-block"> +$(date-utc fmt,time,in-fmt) +</pre> +<p>Returns the current nanosecond timestamp (monotonic when possible) <a class="footnote-reference" href="#id84" id="id76" name="id76">[1]</a>:</p> +<pre class="literal-block"> +$(nanots ) +</pre> +<p>Returns the size of the specified file, or -1 if the size could not +be obtained. This can be used to check if a file exist or not <a class="footnote-reference" href="#id84" id="id77" name="id77">[1]</a>:</p> +<pre class="literal-block"> +$(file-size file) +</pre> +<p>Searches the <tt class="docutils literal"><span class="pre">PATH</span></tt> <tt class="docutils literal"><span class="pre">kmk</span></tt> variable for the specified <tt class="docutils literal"><span class="pre">files</span></tt> <a class="footnote-reference" href="#id84" id="id78" name="id78">[1]</a>:</p> +<pre class="literal-block"> +$(which files...) +</pre> +<p>OS/2: Returns the specified LIBPATH variable value <a class="footnote-reference" href="#id84" id="id79" name="id79">[1]</a>:</p> +<pre class="literal-block"> +$(libpath var) +</pre> +<p>OS/2: Sets the specified LIBPATH variable value, returning the empty +string <a class="footnote-reference" href="#id84" id="id80" name="id80">[1]</a>:</p> +<pre class="literal-block"> +$(libpath var,value) +</pre> +</blockquote> +<p>Debugging Functions:</p> +<blockquote> +<p>Returns various make statistics, if no item is specified a default +selection is returned <a class="footnote-reference" href="#id84" id="id81" name="id81">[1]</a>:</p> +<pre class="literal-block"> +$(make-stats item[,itemN]) +</pre> +<p>Raise a debug breakpoint. Used for debugging <tt class="docutils literal"><span class="pre">kmk</span></tt> makefile +parsing <a class="footnote-reference" href="#id84" id="id82" name="id82">[1]</a>:</p> +<pre class="literal-block"> +$(breakpoint ) +</pre> +</blockquote> +</div> +<div class="section"> +<h1><a id="recipes" name="recipes">Recipes</a></h1> +<blockquote> +<p>A typical recipe takes one of the two following forms:</p> +<pre class="literal-block"> +targets : normal-prerequisites | order-only-prerequisites + command + ... + +targets : normal-prerequisites | order-only-prerequisites ; command + command + ... +</pre> +<p>Specifying more than one file in the <tt class="docutils literal"><span class="pre">targets</span></tt> lists is the same as +repeating the recipe for each of the files.</p> +<p>Use <tt class="docutils literal"><span class="pre">+</span></tt> and <tt class="docutils literal"><span class="pre">+|</span></tt> in the list of <tt class="docutils literal"><span class="pre">targets</span></tt> to tell <tt class="docutils literal"><span class="pre">kmk</span></tt> that the +recipe has more than one output. <a class="footnote-reference" href="#id84" id="id83" name="id83">[1]</a> The files after a <tt class="docutils literal"><span class="pre">+</span></tt> will +always be remade, while the files after a <tt class="docutils literal"><span class="pre">+|</span></tt> don't have to be remade. +The latter is frequently employed to update files which prerequisites +change wihtout the output files necessarily changing. See also +<tt class="docutils literal"><span class="pre">kmk_cp</span> <span class="pre">--changed</span></tt>.</p> +</blockquote> +<p>Double colon recipes</p> +<blockquote> +Double colon recipes are written with <tt class="docutils literal"><span class="pre">::</span></tt> instead of <tt class="docutils literal"><span class="pre">:</span></tt> and are +handled differently from ordinary recipes if the target appears in more +than one recipe. First, all the recipes must be of the double colon type. +Second, the recipes are executed individually and may be omitted depending +on the state of their prerequisites. Double colon recipes without any +prerequisites will always be executed.</blockquote> +<p>Pattern rules</p> +<blockquote> +<p>A couple of examples:</p> +<pre class="literal-block"> +%.o : %.c + gcc -o $@ $< +%.tab.c %.tab.h : %.y + bison -d $< +</pre> +<p>The latter has two outputs.</p> +</blockquote> +<hr class="docutils" /> +<table class="docutils footnote" frame="void" id="id84" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label"><a name="id84">[1]</a></td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>, <a class="fn-backref" href="#id4">4</a>, <a class="fn-backref" href="#id5">5</a>, <a class="fn-backref" href="#id6">6</a>, <a class="fn-backref" href="#id7">7</a>, <a class="fn-backref" href="#id8">8</a>, <a class="fn-backref" href="#id9">9</a>, <a class="fn-backref" href="#id10">10</a>, <a class="fn-backref" href="#id11">11</a>, <a class="fn-backref" href="#id12">12</a>, <a class="fn-backref" href="#id13">13</a>, <a class="fn-backref" href="#id14">14</a>, <a class="fn-backref" href="#id15">15</a>, <a class="fn-backref" href="#id16">16</a>, <a class="fn-backref" href="#id17">17</a>, <a class="fn-backref" href="#id18">18</a>, <a class="fn-backref" href="#id19">19</a>, <a class="fn-backref" href="#id20">20</a>, <a class="fn-backref" href="#id21">21</a>, <a class="fn-backref" href="#id22">22</a>, <a class="fn-backref" href="#id23">23</a>, <a class="fn-backref" href="#id24">24</a>, <a class="fn-backref" href="#id25">25</a>, <a class="fn-backref" href="#id26">26</a>, <a class="fn-backref" href="#id27">27</a>, <a class="fn-backref" href="#id28">28</a>, <a class="fn-backref" href="#id29">29</a>, <a class="fn-backref" href="#id30">30</a>, <a class="fn-backref" href="#id31">31</a>, <a class="fn-backref" href="#id32">32</a>, <a class="fn-backref" href="#id33">33</a>, <a class="fn-backref" href="#id34">34</a>, <a class="fn-backref" href="#id35">35</a>, <a class="fn-backref" href="#id36">36</a>, <a class="fn-backref" href="#id37">37</a>, <a class="fn-backref" href="#id38">38</a>, <a class="fn-backref" href="#id39">39</a>, <a class="fn-backref" href="#id40">40</a>, <a class="fn-backref" href="#id41">41</a>, <a class="fn-backref" href="#id42">42</a>, <a class="fn-backref" href="#id43">43</a>, <a class="fn-backref" href="#id44">44</a>, <a class="fn-backref" href="#id45">45</a>, <a class="fn-backref" href="#id48">46</a>, <a class="fn-backref" href="#id49">47</a>, <a class="fn-backref" href="#id50">48</a>, <a class="fn-backref" href="#id51">49</a>, <a class="fn-backref" href="#id52">50</a>, <a class="fn-backref" href="#id53">51</a>, <a class="fn-backref" href="#id54">52</a>, <a class="fn-backref" href="#id55">53</a>, <a class="fn-backref" href="#id56">54</a>, <a class="fn-backref" href="#id57">55</a>, <a class="fn-backref" href="#id58">56</a>, <a class="fn-backref" href="#id59">57</a>, <a class="fn-backref" href="#id60">58</a>, <a class="fn-backref" href="#id61">59</a>, <a class="fn-backref" href="#id62">60</a>, <a class="fn-backref" href="#id63">61</a>, <a class="fn-backref" href="#id64">62</a>, <a class="fn-backref" href="#id65">63</a>, <a class="fn-backref" href="#id66">64</a>, <a class="fn-backref" href="#id67">65</a>, <a class="fn-backref" href="#id68">66</a>, <a class="fn-backref" href="#id69">67</a>, <a class="fn-backref" href="#id70">68</a>, <a class="fn-backref" href="#id71">69</a>, <a class="fn-backref" href="#id72">70</a>, <a class="fn-backref" href="#id73">71</a>, <a class="fn-backref" href="#id74">72</a>, <a class="fn-backref" href="#id75">73</a>, <a class="fn-backref" href="#id76">74</a>, <a class="fn-backref" href="#id77">75</a>, <a class="fn-backref" href="#id78">76</a>, <a class="fn-backref" href="#id79">77</a>, <a class="fn-backref" href="#id80">78</a>, <a class="fn-backref" href="#id81">79</a>, <a class="fn-backref" href="#id82">80</a>, <a class="fn-backref" href="#id83">81</a>)</em> <tt class="docutils literal"><span class="pre">kmk</span></tt> only feature.</td></tr> +</tbody> +</table> +<table class="docutils footnote" frame="void" id="id85" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label"><a name="id85">[2]</a></td><td><em>(<a class="fn-backref" href="#id46">1</a>, <a class="fn-backref" href="#id47">2</a>)</em> Experimental GNU <tt class="docutils literal"><span class="pre">make</span></tt> feature that is not enabled by default.</td></tr> +</tbody> +</table> +<hr class="docutils" /> +<table class="docutils field-list" frame="void" rules="none"> +<col class="field-name" /> +<col class="field-body" /> +<tbody valign="top"> +<tr class="field"><th class="field-name">Status:</th><td class="field-body"><p class="first">$Id: QuickReference-kmk.html 2340 2009-04-18 12:05:47Z bird $</p> +</td> +</tr> +<tr class="field"><th class="field-name">Copyright:</th><td class="field-body"><p class="first">Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, +1996, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2006, +2007 Free Software Foundation, Inc.</p> +<p class="last">Copyright (c) 2008-2009 knut st. osmundsen</p> +</td> +</tr> +</tbody> +</table> +</div> +</div> +</body> +</html> diff --git a/kBuild/doc/QuickReference-kmk.txt b/kBuild/doc/QuickReference-kmk.txt new file mode 100644 index 0000000..cab3a58 --- /dev/null +++ b/kBuild/doc/QuickReference-kmk.txt @@ -0,0 +1,1054 @@ + +kmk Quick Reference +=================== + +This is an attempt at summarizing all directives, functions, special variables, +special targets, built-in commands, external commands, and ``kmk``-expressions. +Since *all* the features are included, the quickness of this reference can be +disputed. ;-) + + + +Directives +---------- + +Here is a summary of the directives ``kmk`` recognizes: + + Define a multi-line, recursively-expanded variable:: + + define variable + endef + + Conditionally evaluate part of the makefile:: + + ifdef variable + ifndef variable + ifeq (a,b) + ifeq "a" "b" + ifeq 'a' 'b' + ifneq (a,b) + ifneq "a" "b" + ifneq 'a' 'b' + if1of (set-a,set-b) [1] + ifn1of (set-a,set-b) [1] + if expression [1] + else + endif + + Include another makefile:: + + include file + -include file + sinclude file + + Include another dependency file [1]_:: + + includedep file + + Define a variable, overriding any previous definition, even one from the + command line:: + + override variable = value + override variable := value + override variable += value + override variable <= value [1] + override variable ?= value + override define variable + endef + + Tell ``kmk`` to export all variables to child processes by default:: + + export + + Tell ``kmk`` whether or not to export a particular variable to child + processes:: + + export variable + export variable = value + export variable := value + export variable += value + export variable <= value [1] + export variable ?= value + unexport variable + + Define a variable in the local context instead of the global one [1]_:: + + local variable = value + local variable := value + local variable += value + local variable <= value + local variable ?= value + local define variable + endef + + Specify a search path for files matching a ``%`` pattern:: + + vpath pattern path + + Remove all search paths previously specified for pattern:: + + vpath pattern + + Remove all search paths previously specified in any vpath directive:: + + vpath + + + +Automatic variables +------------------- + +Here is a summary of the automatic variables. + ++-----------+-----------------------------------------------------------------+ +| Variable | Description | ++===========+=================================================================+ +| ``$@`` | The file name of the target. | ++-----------+-----------------------------------------------------------------+ +| ``$<`` | The name of the first prerequisite. | ++-----------+-----------------------------------------------------------------+ +| ``$?`` | The names of all the prerequisites that are newer than the | +| | target, with spaces between them. | ++-----------+-----------------------------------------------------------------+ +| ``$^`` | The names of all the prerequisites, duplicates omitted. | ++-----------+-----------------------------------------------------------------+ +| ``$+`` | The names of all the prerequisites, duplicates and order | +| | preserved | ++-----------+-----------------------------------------------------------------+ +| ``$*`` | The stem with which an implicit rule matches. | ++-----------+-----------------------------------------------------------------+ +| ``$|`` | The name of all the order only prerequisites. | ++-----------+-----------------------------------------------------------------+ +| ``$(@D)`` | The directory part of ``$@``. | ++-----------+-----------------------------------------------------------------+ +| ``$(<D)`` | The directory part of ``$<``. | ++-----------+-----------------------------------------------------------------+ +| ``$(?D)`` | The directory part of ``$?``. | ++-----------+-----------------------------------------------------------------+ +| ``$(^D)`` | The directory part of ``%^``. | ++-----------+-----------------------------------------------------------------+ +| ``$(+D)`` | The directory part of ``$+``. | ++-----------+-----------------------------------------------------------------+ +| ``$(*D)`` | The directory part of ``$*``. | ++-----------+-----------------------------------------------------------------+ +| ``$(|D)`` | The directory part of ``$|``. | ++-----------+-----------------------------------------------------------------+ +| ``$(@F)`` | The file-within-directory part of ``$@``. | ++-----------+-----------------------------------------------------------------+ +| ``$(<F)`` | The file-within-directory part of ``$<``. | ++-----------+-----------------------------------------------------------------+ +| ``$(?F)`` | The file-within-directory part of ``$?``. | ++-----------+-----------------------------------------------------------------+ +| ``$(^F)`` | The file-within-directory part of ``$^``. | ++-----------+-----------------------------------------------------------------+ +| ``$(+F)`` | The file-within-directory part of ``$+``. | ++-----------+-----------------------------------------------------------------+ +| ``$(*F)`` | The file-within-directory part of ``$*``. | ++-----------+-----------------------------------------------------------------+ +| ``$(|F)`` | The file-within-directory part of ``$|``. | ++-----------+-----------------------------------------------------------------+ + + + +Special variables +----------------- + +All variables starting with a ``.`` is reserved by ``kmk``. The following +variables are specially used or/and defined by ``kmk``: + ++--------------------------+--------------------------------------------------+ +| Variable | Description | ++==========================+==================================================+ +| ``.DEFAULT_GOAL`` | The makefile default goal. You can set this in | +| | the makefile, if you don't it will default to | +| | the first target that is encountered. | ++--------------------------+--------------------------------------------------+ +| ``.FEATURES`` | List of GNU ``make`` features. Do not set this. | ++--------------------------+--------------------------------------------------+ +| ``.INCLUDE_DIRS`` | List of include directories, ``-I`` arguments | +| | and defaults. Do not set this. | ++--------------------------+--------------------------------------------------+ +| ``.RECIPEPREFIX`` | Recipe prefix, defaults to tab. | ++--------------------------+--------------------------------------------------+ +| ``.VARIABLES`` | Special variable which exands to the list of | +| | variable. Do not set this. | ++--------------------------+--------------------------------------------------+ +| ``CURDIR`` | Set to the pathname of the current working | +| | directory (after all ``-C`` options are | +| | processed, if any). Do not set this. | ++--------------------------+--------------------------------------------------+ +| ``KBUILD_VERSION``, | The kBuild version string and the break down | +| ``KBUILD_VERSION_MAJOR``,| into individual components. [1]_ | +| ``KBUILD_VERSION_MINOR``,| | +| ``KBUILD_VERSION_PATCH``,| | +| ``KBUILD_KMK_REVISION`` | | ++--------------------------+--------------------------------------------------+ +| ``KBUILD_HOST`` [1]_ | The host operating system. | ++--------------------------+--------------------------------------------------+ +| ``KBUILD_HOST_ARCH`` [1]_| The host architecture. | ++--------------------------+--------------------------------------------------+ +| ``KBUILD_HOST_CPU`` [1]_ | The host CPU ``kmk`` is built for, set to | +| | ``blend`` if not any particular CPU. | ++--------------------------+--------------------------------------------------+ +| ``KBUILD_PATH`` [1]_ | Where the kBuild scripts are. | ++--------------------------+--------------------------------------------------+ +| ``KBUILD_BIN_PATH`` [1]_ | Where the host specific kBuild binaries are. | ++--------------------------+--------------------------------------------------+ +| ``KMK`` [1]_, | The name with which ``kmk`` was invoked. Using | +| ``MAKE`` | this variable in recipes has special meaning. | ++--------------------------+--------------------------------------------------+ +| ``KMK_BUILTIN`` [1]_ | List of built-in commands. | ++--------------------------+--------------------------------------------------+ +| ``KMK_FEATURES`` [1]_ | List of ``kmk`` specific features. | ++--------------------------+--------------------------------------------------+ +| ``KMK_FLAGS`` [1]_ | The flags given to ``kmk``. You can set this in | +| | the environment or a makefile to set flags. | +| | | +| | It is never appropriate to use ``KMK_FLAGS`` | +| | directly in a recipe line: its contents may not | +| | be quoted correctly for use in the shell. Always | +| | allow recursive ``kmk``'s to obtain these values | +| | through the environment from its parent. | ++--------------------------+--------------------------------------------------+ +| ``KMK_LEVEL`` [1]_ | The number of levels of recursion (sub-makes). | ++--------------------------+--------------------------------------------------+ +| ``KMK_VERSION`` [1]_ | The GNU ``make`` version number. | ++--------------------------+--------------------------------------------------+ +| ``MAKECMDGOALS`` | The targets given to ``kmk`` on the command line.| +| | Do not set this. | ++--------------------------+--------------------------------------------------+ +| ``MAKEFILES`` | Makefiles to be read on every invocation of | +| | ``kmk``. | ++--------------------------+--------------------------------------------------+ +| ``MAKEFILE_LIST`` | List of the makefiles that ``kmk`` has opened. | ++--------------------------+--------------------------------------------------+ +| ``MAKESHELL`` | OS/2 and MS-DOS only, the name of the command | +| | interpreter that is to be used by ``kmk``. This | +| | value takes precedence over the value of SHELL. | ++--------------------------+--------------------------------------------------+ +| ``SHELL`` | The name of the default command interpreter, | +| | kmk_ash. You can set SHELL in the makefile to | +| | change the shell used to run recipes. The SHELL | +| | variable is handled specially when importing | +| | from and exporting to the environment. | ++--------------------------+--------------------------------------------------+ +| ``SUFFIXES`` | The default list of suffixes before ``kmk`` | +| | reads any makefiles (always empty). | ++--------------------------+--------------------------------------------------+ +| ``VPATH`` | Directory search path for files not found in the | +| | current directory. | ++--------------------------+--------------------------------------------------+ + + +The following variables reflects ``kmk`` options. Do not set these. [1]_ + ++-------------------------------------+---------------------------------------+ +| Variable | Description | ++=====================================+=======================================+ +| ``KMK_OPTS_JOBS`` | -j slots, ``0`` if not given. | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_KEEP_GOING`` | -k indictor (``0``/``1``). | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_JUST_PRINT`` | -n indicator (``0``/``1``). | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_PRORITY`` | --priority level, ``0`` if not given. | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_AFFINITY`` | --affinity mask, ``0`` if not given. | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_STATISTICS`` | --statistics indicator (``0``/``1``). | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_PRINT_TIME`` | The --print-time value. | ++-------------------------------------+---------------------------------------+ +| ``KMK_OPTS_PRETTY_COMMAND_PRINTING``| --pretty-command-printing indicator. | ++-------------------------------------+---------------------------------------+ + + + +Special Targets +--------------- + +Certain names have special meanings if they appear as targets. + ++-------------------------------+---------------------------------------------+ +| Target | Description | ++===============================+=============================================+ +| ``.DEFAULT`` | The recipe is used for any target for which | +| | no rules are found. | ++-------------------------------+---------------------------------------------+ +| ``.DELETE_ON_ERROR`` | If mentioned, ``kmk`` will delete the | +| | targets of a rule if it has changed and its | +| | recipe fails or is interrupted. | ++-------------------------------+---------------------------------------------+ +| ``.EXPORT_ALL_VARIABLES`` | If mentioned, all variables will by default | +| | be exported to child processes. | ++-------------------------------+---------------------------------------------+ +| ``.IGNORE`` | Ignore errors in the execution of the recipe| +| | for the targets ``.IGNORE`` depends on, if | +| | no prequisites all targets are affected. | ++-------------------------------+---------------------------------------------+ +| ``.INTERMEDIATE`` | The prerequisites are treated as | +| | intermediate files (implicite rules). | ++-------------------------------+---------------------------------------------+ +| ``.LOW_RESOLUTION_TIME`` | ``kmk`` will assume prerequisite files are | +| | created with low resolution time stamps. | ++-------------------------------+---------------------------------------------+ +| ``.NOTPARALLEL`` | If mentioned without any prerequisites, | +| | ``kmk`` will run serially as if -j1 was | +| | given. If it has prerequisites ``kmk`` [1]_ | +| | will only do this for the targets among | +| | them. | ++-------------------------------+---------------------------------------------+ +| ``.PHONY`` | The prerequisites are considered phony and | +| | will be rebuilt unconditionally. | ++-------------------------------+---------------------------------------------+ +| ``.PRECIOUS`` | The targets which ``.PRECIOUS`` depends | +| | will to be deleted if ``kmk`` is killed or | +| | interrupted while their building. | ++-------------------------------+---------------------------------------------+ +| ``.SECONDARY`` | The prerequisites are treated as | +| | intermediate files, except that they are | +| | never automatically deleted. If used with | +| | no prerequisites all targets gets this | +| | treatement. | ++-------------------------------+---------------------------------------------+ +| ``.SECONDEXPANSION`` | If mentioned, all prerequisite lists after | +| | it will be expanded a second time after all | +| | makefiles have been read. | ++-------------------------------+---------------------------------------------+ +| ``.SECONDTARGETEXPANSION`` | If mentioned, all targets after it will be | +| [1]_ | expanded a second time after all makefiles | +| | have been read. | ++-------------------------------+---------------------------------------------+ +| ``.SILENT`` | ``kmk`` will not print the recipe for | +| | targets listed as prerequisites, if none | +| | then it applies to all targets. | ++-------------------------------+---------------------------------------------+ +| ``.SUFFIXES`` | The prerequisites are the list of suffixes | +| | used in checking for suffix rules. If it | +| | appears without prerequisites it the suffix | +| | will be cleared. | ++-------------------------------+---------------------------------------------+ + + + +Commands +-------- + +Builtin commands [1]_ all start with ``kmk_builtin_``, so in order to save +space this prefix has been omitted in the table below. All commands comes in an +external edition that can be used by/in the shell, these are prefixed ``kmk_``. + ++---------------+-------------------------------------------------------------+ +| Command | Description | ++===============+=============================================================+ +| ``append`` | Append text to a file. The builtin version can output the | +| | value of a variable or the commands of a target. | ++---------------+-------------------------------------------------------------+ +| ``cat`` | The BSD ``cat`` command. | ++---------------+-------------------------------------------------------------+ +| ``chmod`` | The BSD ``chmod`` command. | ++---------------+-------------------------------------------------------------+ +| ``cmp`` | The BSD ``cmp`` command. | ++---------------+-------------------------------------------------------------+ +| ``cp`` | The BSD ``cp`` command with some twaking. | ++---------------+-------------------------------------------------------------+ +| ``echo`` | The BSD ``echo`` command. | ++---------------+-------------------------------------------------------------+ +| ``expr`` | The BSD ``expr`` command. | ++---------------+-------------------------------------------------------------+ +| ``install`` | The BSD ``install`` command with some tweaking. | ++---------------+-------------------------------------------------------------+ +| ``kDepIDB`` | Extract dependencies from a Visual C++ .IDB file. | ++---------------+-------------------------------------------------------------+ +| ``ln`` | The BSD ``ln`` command. | ++---------------+-------------------------------------------------------------+ +| ``md5sum`` | Typical MD5 sum program, custom kBuild version. | ++---------------+-------------------------------------------------------------+ +| ``mkdir`` | The BSD ``mkdir`` command. | ++---------------+-------------------------------------------------------------+ +| ``mv`` | The BSD ``mv`` command with some tweaking. | ++---------------+-------------------------------------------------------------+ +| ``printf`` | The BSD ``printf`` command. | ++---------------+-------------------------------------------------------------+ +| ``rm`` | The BSD ``rm`` command with some tweaking. | ++---------------+-------------------------------------------------------------+ +| ``rmdir`` | The BSD ``rmdir`` command with some tweaking. | ++---------------+-------------------------------------------------------------+ +| ``sleep`` | Typical ``sleep`` program, custom kBuild version. | ++---------------+-------------------------------------------------------------+ +| ``test`` | The BSD ``test`` program with some tweaking. | ++---------------+-------------------------------------------------------------+ + +Some additional external commands are available in the ``kmk`` / ``kBuild`` +environment (``kSomething`` command are not prefixed with ``kmk_``): + ++---------------+-------------------------------------------------------------+ +| Command | Description | ++===============+=============================================================+ +| ``kDepPre`` | Extract dependencies from the C/C++ preprocessor output. | ++---------------+-------------------------------------------------------------+ +| ``kObjCache`` | Simple object file cache program. | ++---------------+-------------------------------------------------------------+ +| ``ash`` | Almquist's shell (NetBSD variant). | ++---------------+-------------------------------------------------------------+ +| ``gmake`` | Vanilla GNU ``make`` from same sources as ``kmk``. | ++---------------+-------------------------------------------------------------+ +| ``redirect`` | Shell avoidance tool. Sets up file descriptors, environment | +| | variables and current directory before kicking of program. | ++---------------+-------------------------------------------------------------+ +| ``sed`` | GNU ``sed`` with some tweaks to avoid involving the shell. | ++---------------+-------------------------------------------------------------+ +| ``time`` | Stopwatch utility for measuring program execution time(s). | ++---------------+-------------------------------------------------------------+ + + + +kmk-expression +-------------- + +``kmk``-expressions [1]_ are related to the C/C++ preprocessor in some ways as +well as ``nmake`` and BSD ``make``. There are however some peculiarities +because of the way GNU ``make`` choose to represent booleans in its function +library, so, strings can be turned into boolean by taking any non-empty string +as true. + +Quoting using single quotes results in hard strings, while double quotes and +unquoted string results in soft strings that can be converted to number or +boolean to fit the situation. + +Here's the operator table in decending precedence order: + ++---------------+--------+-----------------------------------------------------+ +| Operator | Type | Description | ++===============+========+=====================================================+ +| ``defined`` | Unary | Checks if the following variable exists. | ++---------------+ +-----------------------------------------------------+ +| ``exists`` | | Checks if the following file exists. | ++---------------+ +-----------------------------------------------------+ +| ``target`` | | Checks if the following target exists. | ++---------------+ +-----------------------------------------------------+ +| ``bool`` | | Casts the following value to boolean. | ++---------------+ +-----------------------------------------------------+ +| ``num`` | | Casts the following value to a number. | ++---------------+ +-----------------------------------------------------+ +| ``str`` | | Casts the following value to a string. | ++---------------+--------+-----------------------------------------------------+ +| ``!`` | Unary | Logical NOT. | ++---------------+ +-----------------------------------------------------+ +| ``+`` | | Pluss prefix. | ++---------------+ +-----------------------------------------------------+ +| ``-`` | | Minus prefix. | ++---------------+ +-----------------------------------------------------+ +| ``~`` | | Bitwise one's complement. | ++---------------+--------+-----------------------------------------------------+ +| ``*`` | Binary | Multiplication (product). | ++---------------+ +-----------------------------------------------------+ +| ``/`` | | Division (quotient). | ++---------------+ +-----------------------------------------------------+ +| ``%`` | | Modulus (remainder). | ++---------------+--------+-----------------------------------------------------+ +| ``+`` | Binary | Addition (sum). | ++---------------+ +-----------------------------------------------------+ +| ``-`` | | Subtraction (difference). | ++---------------+--------+-----------------------------------------------------+ +| ``<<`` | Binary | Bitwise left shift. | ++---------------+ +-----------------------------------------------------+ +| ``>>`` | | Bitwise right shift. | ++---------------+--------+-----------------------------------------------------+ +| ``<=`` | Binary | Less or equal than. | ++---------------+ +-----------------------------------------------------+ +| ``<`` | | Less than. | ++---------------+ +-----------------------------------------------------+ +| ``>=`` | | Greater or equal than. | ++---------------+ +-----------------------------------------------------+ +| ``>`` | | Greater than. | ++---------------+--------+-----------------------------------------------------+ +| ``==`` | Binary | Equal to. | ++---------------+ +-----------------------------------------------------+ +| ``!=`` | | Not equal to. | ++---------------+--------+-----------------------------------------------------+ +| ``&`` | Binary | Bitwise AND. | ++---------------+--------+-----------------------------------------------------+ +| ``^`` | Binary | Bitwise XOR. | ++---------------+--------+-----------------------------------------------------+ +| ``|`` | Binary | Bitwise OR. | ++---------------+--------+-----------------------------------------------------+ +| ``&&`` | Binary | Logical AND. | ++---------------+--------+-----------------------------------------------------+ +| ``||`` | Binary | Logical OR. | ++---------------+--------+-----------------------------------------------------+ + + + +Built-in functions +------------------ + + +String Manipulation Functions: + + Replace ``from`` with ``to`` in ``text``:: + + $(subst from,to,text) + + Replace words matching ``pattern`` with ``replacement`` in ``text``:: + + $(patsubst pattern,replacement,text) + + Remove excess whitespace characters from ``string``:: + + $(strip string) + + Locate ``find`` in ``text``, returning ``find`` if found:: + + $(findstring find,text) + + Select words in ``text`` that match one of the ``pattern`` words:: + + $(filter pattern...,text) + + Select words in ``text`` that do not match any of the ``pattern`` words:: + + $(filter-out pattern...,text) + + Sort the words in ``list`` lexicographically, removing duplicates:: + + $(sort list) + + Sort the words in ``list`` lexicographically in reserve order, removing + duplicates [1]_:: + + $(rsort list) + + Count the number of words in ``text``:: + + $(words text) + + Extract the ``n``\th word (one-origin) of ``text``:: + + $(word n,text) + + Returns the list of words in ``text`` from ``s`` to ``e`` (one-origin):: + + $(wordlist s,e,text) + + Extract the first word of ``names``:: + + $(firstword names...) + + Extract the last word of ``names``:: + + $(lastword names...) + + Join two parallel lists of words:: + + $(join list1,list2) + + Extract the first defined variable from ``variables``, returning its name + (default) or value:: + + $(firstdefined variables[, name|value]) + + Extract the last defined variable from ``variables``, returning its name + (default) or value:: + + $(lastdefined variables[, name|value]) + + Fold ``text`` to upper case [1]_:: + + $(toupper text) + + Fold ``text`` to lower case [1]_:: + + $(tolower text) + + String formatting a la the unix ``printf`` command [1]_:: + + $(printf fmt, arg...) + + Return the length of a string or a (unexpanded) variable [1]_:: + + $(length string) + $(length-var var) + + Find the position of ``needle`` in ``haystack``, returns 0 if not found. + Negative ``start`` indices are relative to the end of ``haystack``, while + positive ones are one based [1]_:: + + $(pos needle, haystack[, start]) + $(lastpos needle, haystack[, start]) + + Returns the specified substring. The ``start`` works like with ``$(pos )``. + If the substring is partially outside the ``string`` the result will be + padded with ``pad`` if present [1]_:: + + $(substr string, start[, length[, pad]]) + + Insert ``in`` into ``str`` at the specified position. ``n`` works like with + ``$(pos )``, except that ``0`` is the end of the string [1]_:: + + $(insert in, str[, n[, length[, pad]]]) + + Translate ``string`` exchanging characters in ``from-set`` with ``to-set``, + optionally completing ``to-set`` with ``pad-char`` if specified. If no + ``pad-char`` characters absent in ``to-set`` will be deleted [1]_:: + + $(translate string, from-set[, to-set[, pad-char]]) + + +Functions for file names: + + Extract the directory part of each file ``name``:: + + $(dir names...) + + Extract the non-directory part of each file ``name``:: + + $(notdir names...) + + Extract the suffix (the last ``.`` and following characters) of each file + ``name``:: + + $(suffix names...) + + Extract the base name (name without suffix) of each file name:: + + $(basename names...) + + Extract the root specification of each file name (a bit complicated on + Windows & OS/2) [1]_:: + + $(root names...) + + Extract the non-root part of each file name (a bit complicated on + Windows & OS/2) [1]_:: + + $(notroot names...) + + Append ``suffix`` to each word in ``names``:: + + $(addsuffix suffix,names...) + + Prepend ``prefix`` to each word in ``names``:: + + $(addprefix prefix,names...) + + Find file names matching a shell file name ``pattern`` (not a ``%`` + pattern):: + + $(wildcard pattern...) + + For each file name in ``names``, expand to an absolute name that does not + contain any ``.``, ``..``, nor symlinks:: + + $(realpath names...) + + For each file name in ``names``, expand to an absolute name that does not + contain any ``.`` or ``..`` components, but preserves symlinks:: + + $(abspath names...) + + Same as ``$(abspath )`` except that the current directory can be + specified as ``curdir`` [1]_:: + + $(abspathex names...[, curdir]) + + +Arithmetic Functions: + + Returns the sum of the arguments [1]_:: + + $(int-add addend1, addend2[, addendN]) + + Returns the difference between the first argument and the sum of the + rest [1]_:: + + $(int-sub minuend, subtrahend[, subtrahendN]) + + Returns the product of the arguments [1]_:: + + $(int-mul factor1, factor2[, factorN]) + + Returns the quotient of first argument and the rest [1]_:: + + $(int-div dividend, divisor[, divisorN]) + + Returns the modulus of the two arguments [1]_:: + + $(int-mod dividend, divisor) + + Returns the bitwise two-complement of argument [1]_:: + + $(int-not val) + + Returns the result of a bitwise AND of the arguments [1]_:: + + $(int-and val1, val2[, valN]) + + Returns the result of a bitwise OR of the arguments [1]_:: + + $(int-or val1, val2[, valN]) + + Returns the result of a bitwise XOR of the arguments [1]_:: + + $(int-xor val1, val2[, valN]) + + Returns the ``kmk`` boolean (true = non-empty, false = empty) result + of ``val1 == val2`` [1]_:: + + $(int-eq val1, val2) + + Returns the ``kmk`` boolean result of ``val1 != val2`` [1]_:: + + $(int-ne val1, val2) + + Returns the ``kmk`` boolean result of ``val1 > val2`` [1]_:: + + $(int-gt val1, val2) + + Returns the ``kmk`` boolean result of ``val1 >= val2`` [1]_:: + + $(int-ge val1, val2) + + Returns the ``kmk`` boolean result of ``val1 < val2`` [1]_:: + + $(int-lt val1, val2) + + Returns the ``kmk`` boolean result of ``val1 <= val2`` [1]_:: + + $(int-le val1, val2) + + +Boolean and Conditional Functions: + + Condition is false if the ``condition`` evaluates to an empty string + (stripped). Evaluate the ``true-part`` if the condition is true, otherwise + the ``false-part``:: + + $(if condition,true-part[,false-part]) + + Test if any of the conditions evalues to non-empty string, returning the + first one:: + + $(or condition1[,condition2[,condition3[...]]]) + + Test if all of the conditions evaluates to non-empty strings, returning the + last one:: + + $(and condition1[,condition2[,condition3[...]]]) + + + Test if the two strings are identical, returning ``kmk`` boolean (true = + non-empty, false = empty) [2]_:: + + $(eq str1, str2) + + Invert a ``kmk`` boolean value [2]_:: + + $(not val) + + Test if ``variable`` is defined, returning a ``kmk`` boolean value [1]_:: + + $(defined variable) + + Test if ``set-a`` and ``set-b`` intersects, returning a ``kmk`` boolean + value [1]_:: + + $(intersects set-a, set-b) + + Same as ``$(if )`` execpt that the condition is a ``kmk``-expression [1]_:: + + $(if-expr kmk-expression,true-part[,false-part]) + + Select the first true condition (``kmk``-expression) and expand the + following body. Special condition strings ``default`` and + ``otherwise`` [1]_:: + + $(select when1-cond, when1-body[, whenN-cond, whenN-body]) + + Evalutate the ``kmk-expression`` returning what it evalues as. This is + the preferred way of doing arithmentic now [1]_:: + + $(expr kmk-expression) + + +Stack Fuctions: + + Push ``item`` onto the ``stack-var``, returning the empty string [1]_:: + + $(stack-push stack-var, item) + + Pop the top item off the ``stack-var`` [1]_:: + + $(stack-pop stack-var) + + Pop the top item off the ``stack-var``, returning the empty string [1]_:: + + $(stack-popv stack-var) + + Get the top item of the ``stack-var``, returning the empty string [1]_:: + + $(stack-top stack-var) + + +Advanced Functions: + + Evaluates to the contents of the variable ``var``, with no expansion + performed on it:: + + $(value var) + + Evaluate ``body`` with ``var`` bound to each word in ``words``, and + concatenate the results (spaced):: + + $(foreach var,words,body) + + C-style for-loop. Start by evaluating ``init``. Each iteration will + first check whether the ``condition`` (``kmk``-expression) is true, + then expand ``body`` concatenating the result to the previous iterations + (spaced), and finally evaluate ``next`` [1]_:: + + $(for init,conditions,next,body) + + C-style while-loop. Each iteration will check whether the ``condition`` + (``kmk``-expression) is true, then expand ``body`` concatenating the + result to the previous iterations [1]_:: + + $(while conditions,body) + + Evaluate the variable ``var`` replacing any references to ``$(1)``, + ``$(2)`` with the first, second, etc. ``param`` values:: + + $(call var,param,...) + + Evaluate ``text`` then read the results as makefile commands. Expands + to the empty string:: + + $(eval text) + + Same as ``$(eval text)`` except that the ``text`` is expanded in its + own variable context [1]_:: + + $(evalctx text) + + Same as ``$(eval $(value var))`` [1]_:: + + $(evalval var) + + Same as ``$(evalctx $(value var))`` [1]_:: + + $(evalvalctx var) + + A combination of ``$(eval )``, ``$(call )`` and ``$(value )`` [1]_:: + + $(evalcall var) + + A combination of ``$(eval )`` and ``$(call )`` [1]_:: + + $(evalcall2 var) + + Remove comments and blank lines from the variable ``var``. Expands to + the empty string [1]_:: + + $(eval-opt-var var) + + Returns accessing ``$<`` of ``target``, either retriving the whole thing + or the file at ``pos`` (one-origin) [1]_:: + + $(deps target[, pos]) + + Returns accessing ``$+`` (order + duplicates) of ``target``, either + retriving the whole thing or the file at ``pos`` (one-origin) [1]_:: + + $(deps-all target[, pos]) + + Returns accessing ``$?`` of ``target``, either retriving the whole + thing or the file at ``pos`` (one-origin) [1]_:: + + $(deps-newer target[, pos]) + + Returns accessing ``$|`` (order only) of ``target``, either retriving the + whole thing or the file at ``pos`` (one-origin) [1]_:: + + $(deps-oo target[, pos]) + + +Command Functions: + + Create one or more command lines avoiding the max argument + length restriction of the host OS [1]_:: + + $(xargs ar cas mylib.a,$(objects)) + $(xargs ar cas mylib.a,ar as mylib.a,$(objects)) + + + Returns the commands for the specified target separated by new-line, space, + or a user defined string. Note that this might not produce the 100% correct + result if any of the prerequisite automatic variables are used [1]_:: + + $(commands target) + $(commands-sc target) + $(commands-usr target,sep) + + Compares two commands returning the empty string if equal and the 3rd + argument if not. This differs from ``$(comp-vars v1,v2,ne)`` in that + line by line is stripped of leading spaces, command prefixes and + trailing spaces before comparing [1]_:: + + $(comp-cmds cmds-var1, cmds-var2, ne) + $(comp-cmds-ex cmds1, cmd2, ne) + + + Compares the values of the two variables returning the empty string if + equal and the 3rd argument if not. Leading and trailing spaces is + ignored [1]_:: + + $(comp-var var1, var2, ne) + + +Utility functions: + + When this function is evaluated, ``kmk`` generates a fatal error with the + message ``text``:: + + $(error text...) + + When this function is evaluated, ``kmk`` generates a warning with the + message ``text``:: + + $(warning text...) + + When this function is evaluated, ``kmk`` generates a info with the + message ``text``:: + + $(info text...) + + Execute a shell ``command`` and return its output:: + + $(shell command) + + Return a string with the location where the ``kmk`` variable ``variable`` + was defined:: + + $(where variable) + + Return a string describing how the ``kmk`` variable ``variable`` was defined:: + + $(origin variable) + + Return a string describing the flavor of the ``kmk`` variable ``variable``:: + + $(flavor variable) + + Returns the current local time and date formatted in the ``strftime`` + style specifier ``fmt``. ``fmt`` defaults to ``%Y-%m-%dT%H:%M:%S`` when + not specified [1]_:: + + $(date fmt) + + Returns the current UTC time and date formatted in the ``strftime`` + style specifier ``fmt``. ``fmt`` defaults to ``%Y-%m-%dT%H:%M:%SZ`` when + not specified [1]_:: + + $(date-utc fmt) + + Reformats the ``in`` time and date using ``fmt``. The ``in-fmt`` defaults + to ``fmt`` if not specified. While ``fmt`` defaults to + ``%Y-%m-%dT%H:%M:%SZ`` if not specified [1]_:: + + $(date-utc fmt,time,in-fmt) + + Returns the current nanosecond timestamp (monotonic when possible) [1]_:: + + $(nanots ) + + Returns the size of the specified file, or -1 if the size could not + be obtained. This can be used to check if a file exist or not [1]_:: + + $(file-size file) + + Searches the ``PATH`` ``kmk`` variable for the specified ``files`` [1]_:: + + $(which files...) + + OS/2: Returns the specified LIBPATH variable value [1]_:: + + $(libpath var) + + OS/2: Sets the specified LIBPATH variable value, returning the empty + string [1]_:: + + $(libpath var,value) + + +Debugging Functions: + + Returns various make statistics, if no item is specified a default + selection is returned [1]_:: + + $(make-stats item[,itemN]) + + Raise a debug breakpoint. Used for debugging ``kmk`` makefile + parsing [1]_:: + + $(breakpoint ) + + +Recipes +------- + + A typical recipe takes one of the two following forms:: + + targets : normal-prerequisites | order-only-prerequisites + command + ... + + targets : normal-prerequisites | order-only-prerequisites ; command + command + ... + + Specifying more than one file in the ``targets`` lists is the same as + repeating the recipe for each of the files. + + Use ``+`` and ``+|`` in the list of ``targets`` to tell ``kmk`` that the + recipe has more than one output. [1]_ The files after a ``+`` will + always be remade, while the files after a ``+|`` don't have to be remade. + The latter is frequently employed to update files which prerequisites + change wihtout the output files necessarily changing. See also + ``kmk_cp --changed``. + + +Double colon recipes + + Double colon recipes are written with ``::`` instead of ``:`` and are + handled differently from ordinary recipes if the target appears in more + than one recipe. First, all the recipes must be of the double colon type. + Second, the recipes are executed individually and may be omitted depending + on the state of their prerequisites. Double colon recipes without any + prerequisites will always be executed. + + +Pattern rules + + A couple of examples:: + + %.o : %.c + gcc -o $@ $< + %.tab.c %.tab.h : %.y + bison -d $< + + The latter has two outputs. + + +----- + +.. [1] ``kmk`` only feature. +.. [2] Experimental GNU ``make`` feature that is not enabled by default. + +----- + +:Status: $Id: QuickReference-kmk.txt 2532 2011-08-02 13:05:37Z bird $ +:Copyright: Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, + 1996, 1997, 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2006, + 2007 Free Software Foundation, Inc. + + Copyright (c) 2008-2009 knut st. osmundsen diff --git a/kBuild/doc/example1/Config.kmk b/kBuild/doc/example1/Config.kmk new file mode 100644 index 0000000..31eeb84 --- /dev/null +++ b/kBuild/doc/example1/Config.kmk @@ -0,0 +1,25 @@ +# $Id: Config.kmk 2343 2009-04-19 21:44:50Z bird $ +## @file +# kBuild Example no. 1 - Config.kmk - The global configuration file. +# + +# +# The author disclaims copyright to this example script and places +# it in the public domain. +# +# include full-legal-disclaimer.kmk +# + +# +# Some templates. +# +TEMPLATE_ExampleNo1Exe = For creating a program or static library for linking into a program. +TEMPLATE_ExampleNo1Exe_TOOL = GCC +TEMPLATE_ExampleNo1Exe_DEFS = MY_DEFINE=42 MY_OTHER_DEFINE + +TEMPLATE_ExampleNo1Dll = For creating a DLL/SO/DYLIB or static library for linking into a DLL/SO/DYLIB +TEMPLATE_ExampleNo1Dll_EXTENDS = ExampleNo1Exe +TEMPLATE_ExampleNo1Dll_EXTENDS_BY = appending +TEMPLATE_ExampleNo1Dll_DEFS = MY_DLL_INDICATOR + + diff --git a/kBuild/doc/example1/Makefile.kmk b/kBuild/doc/example1/Makefile.kmk new file mode 100644 index 0000000..ecb9350 --- /dev/null +++ b/kBuild/doc/example1/Makefile.kmk @@ -0,0 +1,43 @@ +# $Id: Makefile.kmk 2343 2009-04-19 21:44:50Z bird $ +## @file +# kBuild Example no. 1 - Makefile.kmk - The top-level makefile. +# + +# +# The author disclaims copyright to this example script and places +# it in the public domain. +# +# include full-legal-disclaimer.kmk +# + +SUB_DEPTH = . +include $(KBUILD_PATH)/subheader.kmk + +# +# Include sub-makefiles. +# +include $(PATH_CURRENT)/libhello/Makefile.kmk + +# +# The targets. +# +PROGRAMS += \ + hello \ + hellolib + +# +# Hello world program. +# +hello_TEMPLATE = ExampleNo1Exe +hello_SOURCES = hello.c + +# +# A hello world variant that has some of the code in the libhello directory, +# i.e. linking with a library built by the sub-makefile included above. +# +hellolib_TEMPLATE = ExampleNo1Exe +hellolib_SOURCES = hellolib.c +hellolib_LIBS = $(libhello_1_TARGET) + +include $(FILE_KBUILD_SUB_FOOTER) + diff --git a/kBuild/doc/example1/hello.c b/kBuild/doc/example1/hello.c new file mode 100644 index 0000000..71f37fe --- /dev/null +++ b/kBuild/doc/example1/hello.c @@ -0,0 +1,21 @@ +/* $Id: hello.c 2343 2009-04-19 21:44:50Z bird $ */ +/** @file + * Example no. 1 - hello.c - Hello world program. + */ + +/* + * The author disclaims copyright to this example code and places + * it in the public domain. + * + * #include <full-legal-disclaimer.h> + * + */ + +#include <stdio.h> + +int main() +{ + printf("Hello world!\n"); + return 0; +} + diff --git a/kBuild/doc/example1/hellolib.c b/kBuild/doc/example1/hellolib.c new file mode 100644 index 0000000..feff4c6 --- /dev/null +++ b/kBuild/doc/example1/hellolib.c @@ -0,0 +1,20 @@ +/* $Id: hellolib.c 2343 2009-04-19 21:44:50Z bird $ */ +/** @file + * Example no. 1 - hellolib.c - Hello world program w/ lib. + */ + +/* + * The author disclaims copyright to this example code and places + * it in the public domain. + * + * #include <full-legal-disclaimer.h> + * + */ + +extern int print_hello_world(void); + +int main() +{ + return print_hello_world(); +} + diff --git a/kBuild/doc/example1/libhello/Makefile.kmk b/kBuild/doc/example1/libhello/Makefile.kmk new file mode 100644 index 0000000..674c8b3 --- /dev/null +++ b/kBuild/doc/example1/libhello/Makefile.kmk @@ -0,0 +1,30 @@ +# $Id: Makefile.kmk 2343 2009-04-19 21:44:50Z bird $ +## @file +# kBuild Example no. 1 - libhello/Makefile.kmk - The libhello sub-makefile. +# + +# +# The author disclaims copyright to this example script and places +# it in the public domain. +# +# include full-legal-disclaimer.kmk +# + +SUB_DEPTH = .. +include $(KBUILD_PATH)/subheader.kmk + +# +# The targets. +# +LIBRARIES += libhello + +# +# The hello world library. +# +libhello_TEMPLATE = ExampleNo1Exe +libhello_SOURCES = libhello.c + +## @todo Create a DLL variant. + +include $(FILE_KBUILD_SUB_FOOTER) + diff --git a/kBuild/doc/example1/libhello/libhello.c b/kBuild/doc/example1/libhello/libhello.c new file mode 100644 index 0000000..5a9024d --- /dev/null +++ b/kBuild/doc/example1/libhello/libhello.c @@ -0,0 +1,24 @@ +/* $Id: libhello.c 2343 2009-04-19 21:44:50Z bird $ */ +/** @file + * Example no. 1 - libhello.c - Hello world library. + */ + +/* + * The author disclaims copyright to this example code and places + * it in the public domain. + * + * #include <full-legal-disclaimer.h> + * + */ + +#include <stdio.h> + +extern int print_hello_world(void); + +int print_hello_world(void) +{ + printf("Hello library world!\n"); + return 0; +} + + |