From 0204ddfc9a97f2e9d461ff6ebbecd2fb4a2fdfc7 Mon Sep 17 00:00:00 2001 From: Gordon Hecker Date: Mon, 23 Feb 2009 22:45:45 +0100 Subject: [PATCH] initial import of e2factory-2.3.0pre2 into free software repository --- .gitignore | 3 + COPYING | 621 ++++++ Changelog | 6 + Coding | 40 + INSTALL | 53 + Makefile | 141 ++ README | 14 + README.RELEASE_PROCESS | 39 + doc/Makefile | 99 + doc/TOOLS | 147 ++ doc/luadoc/Makefile | 100 + doc/man/Makefile | 96 + doc/man/e2-build-numbers.1 | 68 + doc/man/e2-build.1 | 98 + doc/man/e2-buildid.1 | 89 + doc/man/e2-cf.1 | 64 + doc/man/e2-create-project.1 | 51 + doc/man/e2-dlist.1 | 47 + doc/man/e2-dsort.1 | 40 + doc/man/e2-fetch-project.1 | 56 + doc/man/e2-fetch-sources.1 | 60 + doc/man/e2-install-e2.1 | 59 + doc/man/e2-ls-project.1 | 53 + doc/man/e2-new-source.1 | 87 + doc/man/e2-playground.1 | 51 + doc/man/e2.1 | 48 + doc/man/e2.conf.5 | 57 + doc/man/e2config.5 | 319 +++ doc/man/e2global.7 | 41 + doc/man/e2hooks.7 | 183 ++ doc/man/e2intro.7 | 160 ++ doc/man/e2rc.5 | 44 + doc/man/e2ssh.1 | 38 + doc/man/e2workflow.7 | 103 + doc/man/man-template.1 | 36 + doc/manual/Makefile | 97 + doc/manual/basic-concepts.text | 30 + doc/manual/buildid.odg | Bin 0 -> 11721 bytes doc/manual/buildid.png | Bin 0 -> 24822 bytes doc/manual/buildid.text | 26 + doc/manual/chroot.text | 50 + doc/manual/e2factory_logo.png | Bin 0 -> 28460 bytes doc/manual/environment.text | 39 + doc/manual/faq.text | 17 + doc/manual/footer.html | 2 + doc/manual/header.html | 10 + doc/manual/licences.text | 28 + doc/manual/manual.css | 12 + doc/manual/manual.text | 28 + doc/manual/migration.text | 107 + doc/manual/project.text | 32 + doc/manual/release.text | 32 + doc/manual/results.text | 65 + doc/manual/sources.text | 104 + generic/Makefile | 105 + generic/cache.lua | 452 ++++ generic/collection.lua | 202 ++ generic/convenience.lua | 45 + generic/e2-su-2.2.c | 205 ++ generic/e2hook.lua | 83 + generic/e2lib.lua | 1807 ++++++++++++++++ generic/e2lib_global_prefix.lua | 34 + generic/e2lib_local_prefix.lua | 33 + generic/e2option.lua | 388 ++++ generic/e2util.c | 767 +++++++ generic/error.lua | 112 + generic/lua-version-map.lua.in | 41 + generic/luafile.lua | 146 ++ generic/luafile_ll.c | 271 +++ generic/scm.git.lua | 375 ++++ generic/sha1.lua | 87 + generic/strict.lua | 64 + generic/transport.lua | 394 ++++ generic/url.lua | 71 + global/Makefile | 114 ++ global/config.lua.in | 60 + global/e2-create-project.lua.in | 234 +++ global/e2-fetch-project.lua.in | 192 ++ global/e2-install-e2.lua.in | 156 ++ global/e2-locate-project-root.sh.in | 38 + global/e2-root.lua.in | 192 ++ global/e2-su.c | 98 + global/e2.conf.in | 62 + global/e2.lua.in | 112 + global/e2global.lua.in | 113 + global/e2ssh.sh.in | 29 + local/Makefile | 137 ++ local/build-numbers.lua | 101 + local/build.lua | 169 ++ local/cf.lua | 242 +++ local/config.lua.in | 37 + local/cvs.lua | 445 ++++ local/dlist.lua | 69 + local/dsort.lua | 56 + local/e2api.c | 139 ++ local/e2api.h | 56 + local/e2api.lua | 45 + local/e2build.lua | 1081 ++++++++++ local/e2scm.lua | 385 ++++ local/e2tool.lua | 2377 ++++++++++++++++++++++ local/fetch-sources.lua | 255 +++ local/files.lua | 479 +++++ local/git.lua | 813 ++++++++ local/linux32.c | 68 + local/loader.lua | 31 + local/lookup-server.lua | 54 + local/ls-project.lua | 269 +++ local/make/Makefile | 49 + local/make/README | 165 ++ local/make/build.sh | 81 + local/make/buildall.sh | 40 + local/make/detect_tool | 32 + local/make/makefile.collect_project | 64 + local/make/makefile.res.template | 126 ++ local/make/makefile.template | 53 + local/new-source.lua | 295 +++ local/playground.lua | 117 ++ local/policy.lua | 302 +++ local/result.lua | 548 +++++ local/svn.lua | 380 ++++ local/testapi.c | 74 + local/testapi.lua | 39 + lua/Makefile | 75 + make.vars | 83 + release.sh | 47 + scripts/buildversion.sh | 22 + scripts/detect_tool | 5 + scripts/e2-locate-project-root | 11 + scripts/genscript.sh | 50 + scripts/release.sh | 38 + server-tools/Makefile | 38 + server-tools/e2data_backup | 2 + server-tools/e2nightly | 3 + server-tools/results | 15 + server-tools/upstream | 15 + server/Makefile | 52 + server/web/retrieve-build-numbers.lua.in | 108 + server/web/store-run-log.lua.in | 48 + syntax | 1 + templates/Makefile | 66 + templates/gitignore | 7 + templates/local/build-script | 26 + templates/local/result | 13 + templates/local/source.cvs | 25 + templates/local/source.files | 32 + templates/local/source.git | 21 + templates/local/source.svn | 24 + templates/proj/chroot | 16 + templates/proj/config | 9 + templates/proj/env | 10 + templates/proj/licences | 3 + test/Makefile | 44 + test/runtests.sh | 32 + test/tests/configure.lib | 0 test/tests/create-project.test | 2 + test/tests/fetch.lib | 1 + test/tests/fetch_project.test | 3 + test/tests/init.lib | 9 + test/tests/ls_project.test | 7 + test/tests/new-source.test | 4 + test/tests/new_files_source.lib | 8 + test/tests/use-source.test | 5 + test/tests/use_files_source.lib | 4 + version | 1 + 164 files changed, 21630 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 Changelog create mode 100644 Coding create mode 100644 INSTALL create mode 100644 Makefile create mode 100644 README create mode 100644 README.RELEASE_PROCESS create mode 100644 doc/Makefile create mode 100644 doc/TOOLS create mode 100644 doc/luadoc/Makefile create mode 100644 doc/man/Makefile create mode 100644 doc/man/e2-build-numbers.1 create mode 100644 doc/man/e2-build.1 create mode 100644 doc/man/e2-buildid.1 create mode 100644 doc/man/e2-cf.1 create mode 100644 doc/man/e2-create-project.1 create mode 100644 doc/man/e2-dlist.1 create mode 100644 doc/man/e2-dsort.1 create mode 100644 doc/man/e2-fetch-project.1 create mode 100644 doc/man/e2-fetch-sources.1 create mode 100644 doc/man/e2-install-e2.1 create mode 100644 doc/man/e2-ls-project.1 create mode 100644 doc/man/e2-new-source.1 create mode 100644 doc/man/e2-playground.1 create mode 100644 doc/man/e2.1 create mode 100644 doc/man/e2.conf.5 create mode 100644 doc/man/e2config.5 create mode 100644 doc/man/e2global.7 create mode 100644 doc/man/e2hooks.7 create mode 100644 doc/man/e2intro.7 create mode 100644 doc/man/e2rc.5 create mode 100644 doc/man/e2ssh.1 create mode 100644 doc/man/e2workflow.7 create mode 100644 doc/man/man-template.1 create mode 100644 doc/manual/Makefile create mode 100644 doc/manual/basic-concepts.text create mode 100644 doc/manual/buildid.odg create mode 100644 doc/manual/buildid.png create mode 100644 doc/manual/buildid.text create mode 100644 doc/manual/chroot.text create mode 100644 doc/manual/e2factory_logo.png create mode 100644 doc/manual/environment.text create mode 100644 doc/manual/faq.text create mode 100644 doc/manual/footer.html create mode 100644 doc/manual/header.html create mode 100644 doc/manual/licences.text create mode 100644 doc/manual/manual.css create mode 100644 doc/manual/manual.text create mode 100644 doc/manual/migration.text create mode 100644 doc/manual/project.text create mode 100644 doc/manual/release.text create mode 100644 doc/manual/results.text create mode 100644 doc/manual/sources.text create mode 100644 generic/Makefile create mode 100644 generic/cache.lua create mode 100644 generic/collection.lua create mode 100644 generic/convenience.lua create mode 100644 generic/e2-su-2.2.c create mode 100644 generic/e2hook.lua create mode 100644 generic/e2lib.lua create mode 100644 generic/e2lib_global_prefix.lua create mode 100644 generic/e2lib_local_prefix.lua create mode 100644 generic/e2option.lua create mode 100644 generic/e2util.c create mode 100644 generic/error.lua create mode 100644 generic/lua-version-map.lua.in create mode 100644 generic/luafile.lua create mode 100644 generic/luafile_ll.c create mode 100644 generic/scm.git.lua create mode 100644 generic/sha1.lua create mode 100644 generic/strict.lua create mode 100644 generic/transport.lua create mode 100644 generic/url.lua create mode 100644 global/Makefile create mode 100644 global/config.lua.in create mode 100755 global/e2-create-project.lua.in create mode 100755 global/e2-fetch-project.lua.in create mode 100755 global/e2-install-e2.lua.in create mode 100755 global/e2-locate-project-root.sh.in create mode 100755 global/e2-root.lua.in create mode 100644 global/e2-su.c create mode 100644 global/e2.conf.in create mode 100755 global/e2.lua.in create mode 100644 global/e2global.lua.in create mode 100755 global/e2ssh.sh.in create mode 100644 local/Makefile create mode 100755 local/build-numbers.lua create mode 100755 local/build.lua create mode 100755 local/cf.lua create mode 100644 local/config.lua.in create mode 100644 local/cvs.lua create mode 100755 local/dlist.lua create mode 100755 local/dsort.lua create mode 100644 local/e2api.c create mode 100644 local/e2api.h create mode 100644 local/e2api.lua create mode 100644 local/e2build.lua create mode 100644 local/e2scm.lua create mode 100644 local/e2tool.lua create mode 100755 local/fetch-sources.lua create mode 100644 local/files.lua create mode 100644 local/git.lua create mode 100644 local/linux32.c create mode 100644 local/loader.lua create mode 100755 local/lookup-server.lua create mode 100755 local/ls-project.lua create mode 100644 local/make/Makefile create mode 100644 local/make/README create mode 100755 local/make/build.sh create mode 100755 local/make/buildall.sh create mode 100755 local/make/detect_tool create mode 100644 local/make/makefile.collect_project create mode 100644 local/make/makefile.res.template create mode 100644 local/make/makefile.template create mode 100644 local/new-source.lua create mode 100644 local/playground.lua create mode 100644 local/policy.lua create mode 100644 local/result.lua create mode 100644 local/svn.lua create mode 100644 local/testapi.c create mode 100644 local/testapi.lua create mode 100644 lua/Makefile create mode 100644 make.vars create mode 100644 release.sh create mode 100755 scripts/buildversion.sh create mode 100755 scripts/detect_tool create mode 100755 scripts/e2-locate-project-root create mode 100755 scripts/genscript.sh create mode 100755 scripts/release.sh create mode 100644 server-tools/Makefile create mode 100755 server-tools/e2data_backup create mode 100644 server-tools/e2nightly create mode 100644 server-tools/results create mode 100644 server-tools/upstream create mode 100644 server/Makefile create mode 100644 server/web/retrieve-build-numbers.lua.in create mode 100644 server/web/store-run-log.lua.in create mode 100644 syntax create mode 100644 templates/Makefile create mode 100644 templates/gitignore create mode 100644 templates/local/build-script create mode 100644 templates/local/result create mode 100644 templates/local/source.cvs create mode 100644 templates/local/source.files create mode 100644 templates/local/source.git create mode 100644 templates/local/source.svn create mode 100644 templates/proj/chroot create mode 100644 templates/proj/config create mode 100644 templates/proj/env create mode 100644 templates/proj/licences create mode 100644 test/Makefile create mode 100644 test/runtests.sh create mode 100644 test/tests/configure.lib create mode 100644 test/tests/create-project.test create mode 100644 test/tests/fetch.lib create mode 100644 test/tests/fetch_project.test create mode 100644 test/tests/init.lib create mode 100644 test/tests/ls_project.test create mode 100644 test/tests/new-source.test create mode 100644 test/tests/new_files_source.lib create mode 100644 test/tests/use-source.test create mode 100644 test/tests/use_files_source.lib create mode 100644 version diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ee9fc99 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*~ +*.so +*.lc diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a0453 --- /dev/null +++ b/COPYING @@ -0,0 +1,621 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + 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, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public 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. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS diff --git a/Changelog b/Changelog new file mode 100644 index 0000000..5dcadbe --- /dev/null +++ b/Changelog @@ -0,0 +1,6 @@ +e2factory 2.3.0pre2 + * change email addresses + +e2factory 2.3.0pre1 + * create free software package + * almost no changes to the source since e2factory 2.2.0 diff --git a/Coding b/Coding new file mode 100644 index 0000000..990f2b0 --- /dev/null +++ b/Coding @@ -0,0 +1,40 @@ +Error handling + * Functions should always return: + * a boolean value and an error object on failure. + * or one or more values, or nil as the first value and an error object on + failure. + * when an error occurs, an error object must be created and returned + * error objects must be handled by the caller by + * passing them up + * ignoring them (that usually requires a comment) + * nesting them into another error object from the current layer + * errors shall not be handled by calling e2lib.abort(). + * calling e2lib.bomb() is allowed when signalling a bug in the tool. + E.g. when checking function call parameters, which should never fail. + We need the call stack in those cases to fix that bug. + * the behaviour if e2lib.bomb() may be different when delivering e2factory + to customers. (As they should not see the internals.) + * Example: + -- the error object from the current layer is usually named 'e'. + e = new_error("error copying file for") + -- a boolean return value is usually called 'rc'. + -- an error object return value is usually called 're'. + rc, re = f(...) + if not rc then + -- nest the error object from the f() call into our own one and return + return false, e:cat(re) + end + +Avoid conditional Code - minimize Code paths + * iterate over an empty list instead of checking for nil + * apply a default (e.g. emtpy list instead of nil) as early as possible + where values are optional when building up data structures + +Committing + * follow the one-fix-per-commit and one-commit-per-fix policy + * that gives us readable commits + * do not merge, but rebase, i.e. do not use git-pull to merge your + stuff to the upstream branch, but rebase your commits onto the + upstream branch. + * No merge commits on upstream. + diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..7179004 --- /dev/null +++ b/INSTALL @@ -0,0 +1,53 @@ +INSTALLATION INSTRUCTIONS +========================= + +e2factory, for historical reasons, builds and installs its own lua. +Make sure you download the lua-5.1.3.tar.gz package and place it in +the top level of the e2factory source tree prior to building. That +can be done by creating a symlink. + + ln -s ../lua-5.1.3.tar.gz + +To install e2factory, enter the following commands while +being located in the toplevel source directory (the directory +where this file can be found): + + make all + sudo make install + +This will install the global tools in PREFIX/bin, PREFIX/lib, .... +PREFIX defaults to "/usr/local" can be overridden by passing +"PREFIX" to the "make" invocations given above: + + make PREFIX=$HOME/my-e2 all + sudo make PREFIX=$HOME/my-e2 install + +(Note that the same prefix has also to be given in the install +step) + +The installation step HAS to be done as root, as some global tools +need to have their setuid(1) bit set to create and remove the +chroot(1) environment. + +To build and install the documentation use the doc and install-doc targets: + + make doc + make install-doc + +This will build and install the tutorial, the html manual pages and the +luadoc source code documentation. + +The e2factory-examples package provides an easy way to get started. It +holds everything to setup a simple e2factory environment, with a small +example project. +We recommend to download and install the e2factory-example package to +get a working setup. See INSTALL in the e2factory-example package for +more information. + +In case you have any problems with the installation, please +contact the e2factory team via the mailinglist: + + e2factory-users@lists.e2factory.org + +with a description of your problem and the version of e2factory +that you are using. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..99bb0eb --- /dev/null +++ b/Makefile @@ -0,0 +1,141 @@ +# +# e2factory, the emlix embedded build system +# +# Copyright (C) 2007-2009 Gordon Hecker , emlix GmbH +# Copyright (C) 2007-2009 Oskar Schirmer , emlix GmbH +# Copyright (C) 2007-2008 Felix Winkelmann, emlix GmbH +# +# For more information have a look at http://www.e2factory.org +# +# e2factory is a registered trademark by emlix GmbH. +# +# This file is part of e2factory, the emlix embedded build system. +# +# e2factory is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +SUBDIRS = lua generic global doc templates +LOCALSUBDIRS = lua generic global local doc +TOPLEVEL = . + +include $(TOPLEVEL)/make.vars + +CLEAN_FILES = *~ E2_COMMIT + + +.PHONY: all e2commit install install-local clean local localdist uninstall \ + doc + +help: + @cat INSTALL + +all: e2commit + $(MAKE) -C lua + $(MAKE) -C generic + $(MAKE) -C global + $(MAKE) -C doc/man + $(MAKE) -C templates all + +# this target creates a file E2_COMMIT, holding the current E2_COMMIT +# string, and cleans the tree in case E2_COMMIT changed since the last +# time. That makes sure that the builtin version string is always correct. + +e2commit: + @if [ "$(E2_COMMIT)" != "$(shell cat E2_COMMIT)" ] ; then \ + echo "E2_COMMIT changed. making clean first." ; \ + $(MAKE) clean ; \ + echo "$(E2_COMMIT)" > E2_COMMIT ; \ + fi + +install: all + mkdir -p $(DESTDIR)$(BINDIR) + mkdir -p $(DESTDIR)$(LIBDIR) + mkdir -p $(DESTDIR)$(LIBEXECDIR) + mkdir -p $(DESTDIR)$(INCDIR) + mkdir -p $(DESTDIR)$(MANDIR) + mkdir -p $(DESTDIR)$(TOOLDIR) + $(MAKE) -C lua install + $(MAKE) -C generic install + $(MAKE) -C global install + $(MAKE) -C local install + $(MAKE) -C doc/man install + $(MAKE) -C templates install + +uninstall: + $(MAKE) -C lua uninstall + $(MAKE) -C generic uninstall + $(MAKE) -C global uninstall + $(MAKE) -C doc/man uninstall + $(MAKE) -C templates uninstall + $(MAKE) -C local uninstall + +local: e2commit + $(MAKE) -C generic local + $(MAKE) -C local + $(MAKE) -C templates local + +install-local: + scripts/e2-locate-project-root + $(MAKE) -C generic install-local + $(MAKE) -C local install-local + $(MAKE) -C templates install-local + +doc: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install-doc: + install -d -m 755 $(DOCDIR) + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + install -m 644 Changelog $(DOCDIR)/ + +clean: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + for s in $(LOCALSUBDIRS) ; do \ + $(MAKE) -C $$s $@ ; \ + done + rm -f $(CLEAN_FILES) + if [ -d $(PWD)/test/e2 ]; then \ + sudo $(MAKE) -C test clean; \ + fi + +check: + @echo building e2... + make clean >/dev/null 2>&1 + make PREFIX=$(PWD)/test/e2 >/dev/null 2>&1 + sudo make PREFIX=$(PWD)/test/e2 install >/dev/null 2>&1 + make -C test check + +localdist: all + if test -z "$(DISTNAME)"; then \ + echo; \ + echo "please re-invoke with DISTNAME set to the tag you want to package"; \ + echo; \ + exit 1; \ + fi + rm -fr dist + $(MAKE) -C local PROJECTDIR=$$PWD/dist install-local + $(MAKE) -C generic PROJECTDIR=$$PWD/dist install-local + tar -czvf e2-$(DISTNAME)-$(ARCH)-local.tar.gz -C dist .e2 + rm -fr dist + +dist: + git archive --format=tar --prefix=$(PACKAGE)/ $(PACKAGE) \ + >$(PACKAGE).tar + gzip <$(PACKAGE).tar >$(PACKAGE).tar.gz diff --git a/README b/README new file mode 100644 index 0000000..2742cbc --- /dev/null +++ b/README @@ -0,0 +1,14 @@ +README for e2factory +==================== + + +e2factory is a system for building software in a chroot(1) +environment. The results of the build are fully reproducible and care +is taken to avoid re-builds unless dependencies have changed. + +See INSTALL for installation instructions. + +After installation you can read the manual pages for e2factory, +possibly starting with + + man e2intro diff --git a/README.RELEASE_PROCESS b/README.RELEASE_PROCESS new file mode 100644 index 0000000..96dda35 --- /dev/null +++ b/README.RELEASE_PROCESS @@ -0,0 +1,39 @@ +1. Including the e2 tool version into the buildid calculation + +The content of the version file is available in the source in the E2_VERSION +variable. +This variable is calculated into the buildid, to catch tool changes and +be sure to rebuild results whenever the e2 tool version changes. + +The E2_COMMIT variable is not used, as that makes development impossible, +as buildids would change with each single commit. + +2. The release process + +Releasing e2 requires the following steps: +step 1. change the ./version file (setting the version string) +step 2. commit +step 3. tag +step 4. change the ./version file (appending the "-wip" postfix again) +step 5. commit +step 6. push + +3. Version and Release naming +Any e2 version follows this naming scheme: +MAJOR.MINOR(.PATCHLEVEL)(preNUMBER|rcNUMBER)?(-wip)? +The release name is the version name including the "e2-" prefix + +4. Shell code to support the release process +# set the VERSION variable first, e.g. VERSION="2.2pre1-wip" +RELEASE_NAME="e2-$VERSION" +echo $VERSION >./version +vi Changelog # edit the release string +git commit -m "release $RELEASE_NAME" version Changelog +git tag "$RELEASE_NAME" +git push origin "$RELEASE_NAME" +VERSION=${VERSION}-wip +RELEASE_NAME="e2-$VERSION" +echo $VERSION >./version +vi Changelog # edit the release string: wip again +git commit -m "work in progress $RELEASE_NAME" version Changelog +git push diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..8f14404 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,99 @@ +# +# e2factory, the emlix embedded build system +# +# Copyright (C) 2007-2009 Gordon Hecker , emlix GmbH +# Copyright (C) 2007-2009 Oskar Schirmer , emlix GmbH +# Copyright (C) 2007-2008 Felix Winkelmann, emlix GmbH +# +# For more information have a look at http://www.e2factory.org +# +# e2factory is a registered trademark by emlix GmbH. +# +# This file is part of e2factory, the emlix embedded build system. +# +# e2factory is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +SUBDIRS = luadoc man manual +TOPLEVEL = .. + +include $(TOPLEVEL)/make.vars + +CLEAN_FILES = *~ documentation.tar.gz + +.PHONY: all e2commit install install-local clean local localdist uninstall \ + doc + +all: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +uninstall: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +local: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install-local: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +doc: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + $(MAKE) documentation.tar.gz + +documentation.tar.gz: luadoc/luadoc.tar.gz \ + man/man.tar.gz manual/manual.tar.gz + rm -fr documentation + mkdir documentation + tar -C documentation -xzf luadoc/luadoc.tar.gz + tar -C documentation -xzf man/man.tar.gz + tar -C documentation -xzf manual/manual.tar.gz + tar -czf documentation.tar.gz documentation + +install-doc: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +clean: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + rm -fr documentation + rm -f $(CLEAN_FILES) + +check: + for s in $(SUBDIRS) do ;\ + $(MAKE) -C $$s $@ ;\ + done + +localdist: + for s in $(SUBDIRS) do ;\ + $(MAKE) -C $$s $@ ;\ + done + diff --git a/doc/TOOLS b/doc/TOOLS new file mode 100644 index 0000000..64bd7a1 --- /dev/null +++ b/doc/TOOLS @@ -0,0 +1,147 @@ +1. Dependencies +1.1 dsort +print a valid order for building results according to proj/dependencies + +1.2 dlist +read from stdin a result name +print to stdout the list of build time dependencies + +2. The core tools +All core tools read configuration data frmo stdin and perform some action + +2.1 sources +read the following from stdin + chroot path c + build path T + build path in chroot Tc + result name r +and put everything required to build the result into the build directory: + sources + dependencies + the runbuild script + the build-script + +2.2 runbuild +read the following from stdin + build path T + result name r +and run the build script for the result + +2.3 finish +read the following from stdin + chroot path c + build path T + build path in chroot Tc + result name r +fetch the result file from the build directory + +2.4 cleanup +read the following from stdin + chroot path c + build path T + build path in chroot Tc + result name r +and clean up the build directory + +2.5 all +read the following from stdin + chroot path c + build path T + build path in chroot Tc + result name r +and run all steps required to build without using a chroot environment + +3. The wrapper tools + +3.1 build-config +read a result name from stdin +print the following to stdout for use as input to most build tools + chroot path c + build path T + build path in chroot Tc + result name r + +3.2 build-multiple +read one result name per line from stdin until EOF is reached +run 'build-config | all' for each result + +3.3 build-multiple-chroot +read one result name per line from stdin until EOF is reached +run 'build-config | all-chroot' from each result + +3.4 build +build the project while using tagged source, heads of selected branches +of any available git repositories, or the local working copy + +3.5 fetch-git-source +read a source name from stdin and checkout all git repositories for the source + +3.6 fetch-project +checkout the project given on the command line + +4. The chroot tools +All chroot tools read the following from stdin: + chroot path c + build path T + build path in chroot Tc + result name r + +4.1 chroot-setup +build the chroot environment + +4.2 chroot-cleanup +remove the chroot environment + +4.3 all-chroot +and run all steps required to build inside the chroot environment + +5. Helper tools +5.1 readconfig +read a file from parameter and filter comments + +5.2 locate-project-dir +walk up the directory hierarchy and check if we are inside an e2 project +if successful print the following to stdout: + the current working directory + the basename of the current working directory + the project directory + the path relative to the project directory + the absolute path to the projects' bin/ directory + +5.3 e2 +e2 is the main script that calls all local tools. e2 refuses to call a +local tool if the cwd is not inside a project directory. +Local tools are called from ./bin in the project root unless the +E2_LOCAL_TOOL_PATH environment variable is set. + +6. Bootstrap process to check out a project and the corresponding + version of the e2 tool + +6.1 steps + 1. fetch the e2 tool and perform a global install + 2. clone the project repository (git clone) + .e2/e2version contain information about the corresponding e2 tool version + 3. fetch the corresponding version of the e2 tool repository to .e2/ + (git clone) + 4. build and install the e2 tool inside the project (make; make install) + +6.2 global tools + e2-su + e2-bootstrap-project (steps 2,3,4) + e2 + +6.3 project tools + e2-ls-project + +7. Hacking e2 +This chapter describes how to make hacking the e2 tool convenient. + +7.1 (re)install a development version of e2 + install the global tool + $ make install-global + install symlinks to the local tools in the e2 working tree + $ make install-local-symlinks LOCALBINDIR=$PWD/devel + use the development tools while testing + $ export E2_LOCAL_TOOL_PATH=$PWD/devel + It is possible to edit the local tools in the working copy and immediately + use them in any project without performing additional steps ('make install'). diff --git a/doc/luadoc/Makefile b/doc/luadoc/Makefile new file mode 100644 index 0000000..a049016 --- /dev/null +++ b/doc/luadoc/Makefile @@ -0,0 +1,100 @@ +# +# e2factory, the emlix embedded build system +# +# Copyright (C) 2007-2009 Gordon Hecker , emlix GmbH +# Copyright (C) 2007-2009 Oskar Schirmer , emlix GmbH +# Copyright (C) 2007-2008 Felix Winkelmann, emlix GmbH +# +# For more information have a look at http://www.e2factory.org +# +# e2factory is a registered trademark by emlix GmbH. +# +# This file is part of e2factory, the emlix embedded build system. +# +# e2factory is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +SUBDIRS = +TOPLEVEL = ../.. + +DIR = $(shell pwd) + +include $(TOPLEVEL)/make.vars + +CLEAN_FILES = *~ luadoc.tar.gz + +.PHONY: all e2commit install install-local clean local localdist uninstall \ + doc + +all: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +uninstall: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +local: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install-local: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +doc: luadoc.tar.gz + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install-doc: doc + tar -C $(DOCDIR) -xzf luadoc.tar.gz + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ; \ + done + +luadoc.tar.gz: $(TOPLEVEL)/local/*.lua $(TOPLEVEL)/generic/*.lua + rm -fr luadoc + mkdir luadoc + (cd $(TOPLEVEL) ; luadoc -d $(DIR)/luadoc \ + local/*.lua \ + generic/*.lua) + tar -czf luadoc.tar.gz luadoc + +clean: + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + rm -f $(CLEAN_FILES) + rm -fr luadoc + +check: + for s in $(SUBDIRS) do ;\ + $(MAKE) -C $$s $@ ;\ + done + +localdist: + for s in $(SUBDIRS) do ;\ + $(MAKE) -C $$s $@ ;\ + done + diff --git a/doc/man/Makefile b/doc/man/Makefile new file mode 100644 index 0000000..ab94c91 --- /dev/null +++ b/doc/man/Makefile @@ -0,0 +1,96 @@ +# +# e2factory, the emlix embedded build system +# +# Copyright (C) 2007-2009 Gordon Hecker , emlix GmbH +# Copyright (C) 2007-2009 Oskar Schirmer , emlix GmbH +# Copyright (C) 2007-2008 Felix Winkelmann, emlix GmbH +# +# For more information have a look at http://www.e2factory.org +# +# e2factory is a registered trademark by emlix GmbH. +# +# This file is part of e2factory, the emlix embedded build system. +# +# e2factory is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# + +TOPLEVEL = ../.. + +include $(TOPLEVEL)/make.vars + +MANPAGES1 = \ +e2.1 \ +e2-build.1 \ +e2-buildid.1 \ +e2-cf.1 \ +e2-create-project.1 \ +e2-dlist.1 \ +e2-dsort.1 \ +e2-fetch-project.1 \ +e2-fetch-sources.1 \ +e2-install-e2.1 \ +e2-ls-project.1 \ +e2-new-source.1 \ +e2-playground.1 \ +e2ssh.1 \ +e2.conf.5 \ +e2-build-numbers.1 + +MANPAGES5 = e2rc.5 e2config.5 +MANPAGES7 = e2global.7 e2hooks.7 e2intro.7 e2workflow.7 +MANPAGES = $(MANPAGES1) $(MANPAGES5) $(MANPAGES7) + +MANPAGES_HTML = $(MANPAGES:=.html) + +CLEAN_FILES = *~ man.tar.gz $(MANPAGES_HTML) + +.PHONY: html man doc install-doc + +all: + +install: + mkdir -p $(DESTDIR)$(MANDIR)/man1 $(DESTDIR)$(MANDIR)/man5 $(DESTDIR)$(MANDIR)/man7 + install -m644 $(MANPAGES1) $(DESTDIR)$(MANDIR)/man1 + install -m644 $(MANPAGES5) $(DESTDIR)$(MANDIR)/man5 + install -m644 $(MANPAGES7) $(DESTDIR)$(MANDIR)/man7 + +uninstall: + for x in $(MANPAGES1) ; do rm -f $(DESTDIR)$(MANDIR)/man1/$$x ; done + for x in $(MANPAGES5) ; do rm -f $(DESTDIR)$(MANDIR)/man5/$$x ; done + for x in $(MANPAGES7) ; do rm -f $(DESTDIR)$(MANDIR)/man7/$$x ; done + +doc: man.tar.gz + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + +install-doc: doc + for s in $(SUBDIRS) ; do \ + $(MAKE) -C $$s $@ ;\ + done + tar -C $(DOCDIR) -xzf man.tar.gz + +clean: + rm -f $(CLEAN_FILES) + rm -fr html man + +%.html: % + man2html -r $< >$@ + +man.tar.gz: $(MANPAGES_HTML) + mkdir -p html man/man{1,5,7} + cp *.1.html man/man1/ + cp *.5.html man/man5/ + cp *.7.html man/man7/ + tar -czf man.tar.gz man diff --git a/doc/man/e2-build-numbers.1 b/doc/man/e2-build-numbers.1 new file mode 100644 index 0000000..34ab093 --- /dev/null +++ b/doc/man/e2-build-numbers.1 @@ -0,0 +1,68 @@ +.\" Man page for e2-build-numbers +.\" +.\" (c)2007 emlix GmbH +.\" +.TH e2-build-numbers 1 "Jun 17, 2008" "0.1" + +.SH NAME +e2-build-numbers \- updates build-numbers for one, multiple or all results + +.SH SYNOPSIS +e2-build-numbers [OPTION | RESULT ...] + +.SH DESCRIPTION +This tool allows creating and maintaining a monotonically increasing +build-number for each result. The build-numbers, together with the +build-id is stored in the local project-file "proj/build-numbers". +The build-number can be manually increased or synchronized with +a central server. Build-numbers always strictly increase with each +change. After synchronization, an environment file with suitable +variable definitions is generated in "proj/build-numbers.env". This +file can be included in "proj/env" with the following command: + +.nf + env "proj/build-numbers.env" +.fi + +This tool implicitly operates in "tag" mode, that is, it computes +the results fingerprint with sources specified in the "tag" field +of the source configuration, if the source refers to version-controlled +files. + +.SH RETURN VALUE +Normally, exit status is 0. On error, it is non-zero. + +.SH OPTIONS +.TP +.BR \-\-no\-sync +Do not synchronize with the server, just update local build-number file. +.TP +.BR +.BR \-\-prefix=PREFIX +Add a user-defined prefix before the local build-numbers. +.TP +.BR \-\-force +Force increasing the build number for the results given on the +command line, or all, if no results have been specified. +.TP +.BR \-\-dry\-run +Do not change any files. +.TP +.BR \-\-help +Show usage information. + +.P +For further global options, see \fBe2intro\fR(7). + +.SH BUGS +Doubtless there are many. + +.SH "SEE ALSO" +.BR e2intro (7), +.BR e2-build (1). + +.SH AUTHORS +Gordon Hecker, Oskar Schirmer and Felix Winkelmann + +.SH COPYRIGHT +(c)2007 emlix GmbH diff --git a/doc/man/e2-build.1 b/doc/man/e2-build.1 new file mode 100644 index 0000000..cb2ec95 --- /dev/null +++ b/doc/man/e2-build.1 @@ -0,0 +1,98 @@ +.\" Man page for e2-build +.\" +.\" (c)2007, 2008 emlix GmbH +.\" +.TH e2-build 1 "Dec 1, 2008" "2.2" + +.SH NAME +e2-build \- build results from repository or local sources + +.SH SYNOPSIS +e2-build [OPTION|RESULT ...] + +.SH DESCRIPTION +\fBe2-build\fR builds one or more results, +dependencies are taken into account. +Depending on the intended outcome, different versions of the source +files to use may be retrieved for the build process. +See \fBe2config\fR for a description of the source config file format. +Invokes the hooks "pre-build" and "post-build". + +.SH RETURN VALUE +Normally, exit status is 0. On error, it is non-zero. + +.SH OPTIONS +.TP +.BR \-\-build-mode=MODE +results can be built according to different build modes, as defined by the +(currently builtin) policy module. +A build mode sets the class of sources to take, and influences the buildid, +the dependencies used and the place to store results. +.TP +.BR \-\-branch-mode +build selected results in 'branch' build-mode. +.TP +.BR \-\-wc-mode +build selected results in 'working-copy' build-mode. +.TP +.BR \-\-all +Possibly build all results listed in the dependencies. +This is the default when building from repository sources. +.TP +.BR \-\-playground +Prepare build environment but do not start the build script. The build +environment can later be entered using the \fBe2-playground\fR tool. +.TP +.BR \-\-keep +Do not remove the \fBchroot\fR(1) environment after a build (regardless +of whether it is successful or not). +.TP +.BR \-\-help +Show usage information. + +.P +Valid build modes according to the builtin policy are +\fBworking-copy\fR, \fBtag\fR, \fBrelease\fR and \fBbranch\fR. +\fBtag\fR is the default build mode. \fBrelease\fR is exactly the same +as \fBtag\fR but the results will be stored in a special location on the +server side. (To be archived, separated from lots of results built +for testing.) + +.P +To use the branch from the scm source configuration for selected results +build in 'tag' mode, and select the results to build in branch-mode. + +.SH Examples: +build selected results from their source branches. Dependencies not selected +on the command line are built in the default build-mode. +.IP +e2-build --branch-mode ... +.PP +build a release +.IP +e2-build --build-mode=release +.PP +build +.IP +e2-build +.PP + +For further global options, see \fBe2intro\fR(7). + +.SH BUGS +Doubtless there are many. + +.SH "SEE ALSO" +.BR e2intro (7), +.BR e2-ls-project (1), +.BR e2-playground (1), +.BR e2config (5), +.BR e2hooks (7), +.BR e2-sync-results (1), +.BR e2-runbuild (1). + +.SH AUTHORS +Gordon Hecker, Oskar Schirmer and Felix Winkelmann + +.SH COPYRIGHT +(c)2007, 2008 emlix GmbH diff --git a/doc/man/e2-buildid.1 b/doc/man/e2-buildid.1 new file mode 100644 index 0000000..9de66d3 --- /dev/null +++ b/doc/man/e2-buildid.1 @@ -0,0 +1,89 @@ +.\" Man page for e2-buildid +.\" +.\" (c)2007 emlix GmbH +.\" +.TH e2-buildid 1 "Aug 2, 2007" "0.1" + +.SH NAME +e2-buildid \- computes the build-id for a given result + +.SH SYNOPSIS +e2-buildid [OPTION | RESULT ...] + +.SH DESCRIPTION +To avoid rebuilding whole projects everytime a change is done, for +each distinct result in a project, a finger print for its sources and +configuration is calculated, called "build id". Result files are +stored in a sub directory to "out/", which is named after the +build-id. This directory is checked to see whether a single result +must be rebuilt due to source changes. Note that the build-id of +dependencies of a result influence the id of the result itself. + +For temporary results (mode local), the build id is always the dummy +value "last". + +The algorithm for the build id is as follows: + +.nf + bhash(result) :- sha1sum(for r in {dlist(result), result} phash(r)) + dlist(result) :- dependencies for result, including indirect + phash(result) :- sha1sum(bchroot(result), + for f in {proj/chroot, + proj/env, + proj/init/*, + proj/hooks/*, + res/result/build-script, + res/result/config:files + } sha1sum(f), + for s in sources revisionid(s)) + bchroot(result) :- sha1sum(for g in chrootgroups[result] ghash(g)) + ghash(group) :- sha1sum(for e in chroot/group: server, file) + revisionid(source:files) :- sha1sum( + for f in expanded_files_list(source) sha1sum(f) + basename(f)) +.fi + +The tool \fBe2-ls-project\fR(1) uses the build-id algorithm to check +whether results have been built, when called with the "--status" flag. + +\fBe2-buildid\fR writes the build-id for the result and in the build mode +passed in the "RESULT" and "MODE" arguments to standard output. + +.SH RETURN VALUE +Normally, exit status is 0. On error, it is non-zero. + +.SH OPTIONS +.TP +.BR \-\-all +Compute build-ids for all results (default unless for working copy). +.TP +.BR +.BR \-\-tag +Compute build-id based on tagged sources from repository. +.TP +.BR \-\-head +Compute build-id for head revision of sources from repository. +.TP +.BR \-\-working\-copy +Show build-id for local working copies: 'last' always. +.TP +.BR \-\-ignore\-env=VARIABLE +Ignore a particular project environment variable when computing the build-id. +.TP +.BR \-\-help +Show usage information. + +.P +For further global options, see \fBe2intro\fR(7). + +.SH BUGS +Doubtless there are many. + +.SH "SEE ALSO" +.BR e2intro (7), +.BR e2-ls-project (1). + +.SH AUTHORS +Gordon Hecker, Oskar Schirmer and Felix Winkelmann + +.SH COPYRIGHT +(c)2007 emlix GmbH diff --git a/doc/man/e2-cf.1 b/doc/man/e2-cf.1 new file mode 100644 index 0000000..b1ba69b --- /dev/null +++ b/doc/man/e2-cf.1 @@ -0,0 +1,64 @@ +.\" Man page for +.\" +.\" (c)2007 emlix GmbH +.\" +.TH 1 "Dec 12, 2007" "2.1" + +.SH NAME +e2-cf \- modify and create configuration files + +.SH SYNOPSIS +usage: e2 cf ... + +.SH DESCRIPTION +commands are: + newresult + newsource + editresult + editbuildscript + editsource + +Commands starting with 'edit' can be abbreviated by using e... +Commands starting with 'new' can be abbreviated by using n... +Commands can be shortened as long as they remain unambiguous + +e.g.: eb is equivalent to editbuildscript + +Templates are used as initial config files. An editor is started +for each file that must be configured by the user. + +.SH RETURN VALUE +Normally, exit status is 0. On error, it is non-zero. + +.SH OPTIONS +.TP +.BR \-\-help +Show usage information. +.P +For further global options, see \fBe2intro\fR(7). + +.SH EXAMPLES +The following three commands do exactly the same: Create a new result +configuration for a result named 'foo': +.IP +.nf +e2-cf newresult foo +e2-cf newr foo +e2-cf nr foo +.PP + +.SH ENVIRONMENT +e2-cf uses the EDITOR environment variable to determine which editor to +start. The default editor is 'vi'. + +.SH BUGS +Doubtless there are many. + +.SH "SEE ALSO" +.BR e2intro (7). + +.SH AUTHORS +Gordon Hecker, Oskar Schirmer and Felix Winkelmann + +.SH COPYRIGHT +(c)2007 emlix GmbH diff --git a/doc/man/e2-create-project.1 b/doc/man/e2-create-project.1 new file mode 100644 index 0000000..efb5af6 --- /dev/null +++ b/doc/man/e2-create-project.1 @@ -0,0 +1,51 @@ +.\" Man page for e2-create-project +.\" +.\" (c)2007 emlix GmbH +.\" +.TH e2-create-project 1 "Aug 6, 2007" "0.1" + +.SH NAME +e2-create-project \- create a new project + +.SH SYNOPSIS +e2-create-project [