Add Yaru-dark skin from ConLenov

[kolibrios.git] / build.txt

Most programs in the repository are regularly and automatically compiled\r
by the autobuild server, compiled binaries are available at\r
http://builds.kolibrios.org. The autobuild server uses the build system Tup,\r
data for it are located in files named Tupfile.lua over the repository.\r
\r
-------------------------------------------------------------------------------\r
\r
Q1. I want to build one program and I don't want to know anything about Tup.\r
Q2. I want to build one program using Tup.\r
Q3. I want to add a program to the autobuild.\r
Q4. I want to build the entire system.\r
Q5. I'm sure that I want to build the entire system.\r
    The autobuild server does this, after all.\r
Q6. I don't want to keep a zoo of compilers and tools required for Q5,\r
    but I still want to build as many programs as possible with what I have.\r
Q7. I have modified the source code of the kernel, one driver or one program\r
    and want to test changes.\r
\r
-------------------------------------------------------------------------------\r
\r
Q1. I want to build one program and I don't want to know anything about Tup.\r
A1. Fine. You will need a corresponding compiler, obviously.\r
\r
  * For a FASM program, get FASM at http://flatassembler.net/download.php.\r
    To compile, find the main .asm file of the program and run\r
        path/to/fasm <input.asm>\r
    The compiler will automatically select the name for output, using\r
    base name of input and extension based on file format. Though, you can\r
    give also output name explicitly, as the second argument.\r
\r
    If the compiler produces an error "file not found" regarding 'lang.inc',\r
    the program can be compiled using different languages of interface.\r
    Create a file 'lang.inc' in the same folder as <input.asm> like follows:\r
        lang fix en\r
    Here the last word selects the language. Valid languages are\r
    en, ru, et, it, sp. Not all programs provide all translations,\r
    en should always be available, ru is the most frequent after en.\r
\r
  * For a NASM program, get NASM at http://www.nasm.us/.\r
    To compile, find the main .asm file of the program and run\r
        path/to/nasm -f bin -o <output> <input.asm>\r
    Multi-language is rarely supported in this category, but you could still\r
    see sometimes an error "file not found" regarding 'lang_nasm.inc'. If so,\r
    create a file 'lang_nasm.inc' in the same folder as <input.asm> like follows:\r
        %define lang 'en'\r
    Read the entry about fasm for description of valid languages.\r
\r
  * For a c-- program, try to avoid compiling it and instead rewrite the code\r
    in a normal language like assembler or C. If you absolutely need\r
    to compile, note that the compiler has been abandoned long ago, so\r
    don't look for an official site. It is possible to find the compiler\r
    somewhere on http://board.kolibrios.org, but be prepared to several tries\r
    because there are several slightly different compiler versions, not all of\r
    which are able to build all programs.\r
    There is no Linux version, but Windows version runs fine under Wine.\r
\r
  * For a GCC program, get the toolchain at\r
    http://ftp.kolibrios.org/users/Serge/new/Toolchain/.\r
\r
    Under Windows, you need the package with "msys" in name and MinGW;\r
    after installing MinGW, unpack the package to\r
    \MinGW\msys\1.0\home\autobuild\tools\win32, the package assumes\r
    exactly this path. Run MinGW shell.\r
\r
    Under Linux, you need the package with "linux" in name\r
    and runtime library cloog; e.g. for Debian-based distributives\r
    use apt-get install libcloog-isl4. Unpack the package to\r
    /home/autobuild/tools/win32, the package assumes exactly this path.\r
\r
    In both MinGW and Linux, make sure that the command\r
        /home/autobuild/tools/win32/bin/kos32-gcc\r
    invokes the compiler.\r
\r
    If the program uses libraries, you will also need to either compile\r
    them separately or download SDK, if they are included to SDK.\r
    Compiling is ultimately a sequence of calls to kos32-gcc and kos32-ld,\r
    but filling exact parameters can be tricky, so maybe you want to\r
    use Tup - proceed to Q2/A2 - or Make, if a maintainer has provided\r
    Makefile.\r
\r
  * For a MSVC program, get the compiler as a part of Visual Studio,\r
    Express Edition is fine, or as a part of Windows SDK.\r
    For obvious reasons, there is no Linux version, but the compiler runs fine\r
    under Wine.\r
\r
    If the program uses libraries, you will also need to either compile\r
    them separately or download SDK, if they are included to SDK.\r
    Compiling is ultimately a sequence of calls to cl.exe and link.exe,\r
    but filling exact parameters can be tricky, so maybe you want to\r
    use Tup - proceed to Q2/A2 - or Make, if a maintainer has provided\r
    Makefile.\r
\r
  * For any language, if the program is KolibriOS binary, the compiled binary\r
    can optionally be compiled with kpack. Windows version of kpack\r
    can be downloaded at http://diamond.kolibrios.org/prg/kpack.exe,\r
    Linux version can be compiled from sources at\r
    (repository)/programs/other/kpack/linux.\r
\r
  * The kernel can optionally be compiled with kerpack.\r
    Linux version can be compiled from sources at\r
    (repository)/programs/other/kpack/kerpack_linux.\r
    There is no Windows version.\r
\r
Q2. I want to build one program using Tup.\r
A2. You will still need the corresponding compiler as described in Q1/A1.\r
    You will also need Tup, get it at http://gittup.org/tup/index.html.\r
    Make sure that the corresponding compiler is somewhere in PATH\r
    and can be invoked without explicit path. For Linux, note that\r
    all programs are invoked without extension, like\r
        fasm\r
    or\r
        kos32-gcc\r
    with one exception: MSVC linker is invoked as link.exe to avoid conflict\r
    with link from coreutils. Under Linux, c--, cl, link.exe should be scripts\r
    invoking Wine with the corresponding binary. The interaction tup+wine\r
    does not work by default; ultimately, invoking scripts should be like:\r
        c--: WINEDEBUG=-all LD_PRELOAD=/path/to/nosetsid.so /path/to/wine /path/to/C--.exe $*\r
        cl: WINEDEBUG=-all LD_PRELOAD=/path/to/nosetsid.so /path/to/wine /path/to/cl.exe -I/path/to/cl/include $*\r
        link.exe: WINEDEBUG=-all LD_PRELOAD=/path/to/nosetsid.so /path/to/wine /path/to/link.exe $*\r
    where nosetsid.so is compiled as a 32-bit shared library\r
    from C file with one line "int setsid() { return -1; }".\r
\r
    If the program does not use any libraries, run\r
        tup init\r
    in the directory with the program. Then,\r
        tup\r
    without arguments will build the program with default settings.\r
    Subsequent runs will not do anything unless any file that was used\r
    during the compilation - not necessarily the main file - is changed;\r
    after that, the program will be recompiled.\r
    By default, tup will not track files outside the directory with "tup init";\r
    if tracking files in program directory is not sufficient for you,\r
    consider adding updater.full_deps=1 to tup config - see tup manual\r
    for details, for Linux it requires setting tup as suid root - or extending\r
    tup data to the entire repository as described in Q6/A6. \r
\r
    Settings can be configured using the file tup.config. Look to\r
    tup.config.template in the repository root for complete list;\r
    for most programs, only CONFIG_LANG and CONFIG_KPACK_CMD have effect.\r
\r
    If the program uses libraries or helper files for gcc/msvc and you don't\r
    want to build everything at once like Q6/A6, set\r
        CONFIG_HELPERDIR=.\r
    in tup.config, copy programs/use_gcc.lua or programs/use_msvc.lua\r
    and helpers for used libraries, if any, to the directory of the program.\r
    use_gcc.lua and use_msvc.lua do not require additional configuration;\r
    in helpers for used libraries, set path to library in the first line.\r
    Since copied helpers are local files not for the repository, you may use\r
    absolute pathes specific for your machine.\r
    This was designed so that no repository files need to be modified:\r
    Tupfile.lua for the program is able to use either local helpers when\r
    CONFIG_HELPERDIR is set, or repository helpers when the entire repository\r
    is built.\r
    You will also need compiled libraries. If they are included in SDK, use them.\r
    Otherwise, compile them using the same process. Note that for a library,\r
    "tup init" needs to be called in the library directory with include/ and lib/,\r
    even if Tupfile.lua is present only in src/; libraries will be put in lib/.\r
\r
Q3. I want to add a program to the autobuild.\r
A3. Select a program from repository which uses same language and libraries.\r
    Copy Tupfile.lua from that program to your program.\r
    Change names of source and binary files accordingly.\r
    If external files are referenced, correct relative pathes accordingly:\r
    e.g. when programs/develop/libraries/menuetlibc_example/Tupfile.lua\r
    references ../../../use_menuetlibc.lua, it resolves to\r
    programs/use_menuetlibc.lua, if your program is built by\r
    programs/other/super_program/Tupfile.lua, the path should be\r
    ../../use_menuetlibc.lua. Commit.\r
\r
    After that, the program will be built regularly.\r
    To include the binary in kolibri.img or kolibri.iso, add it to one of\r
    lists in data/Tupfile.lua. Select the section corresponding to the used\r
    language so that people who build images without your compiler would still\r
    be able to do so.\r
\r
Q4. I want to build the entire system.\r
A4. Why? Even the person who has configured the autobuild server does not build\r
    everything on her computer.\r
\r
    If you want to create your own image of the system, it is much simpler to\r
    start from existing one and modify it, building only what is necessary.\r
    Look for Q7/A7 for details of that approach.\r
    If you don't know how to modify an image, don't expect that the build\r
    system will magically do it for you. The build system uses mtools for\r
    image manipulation; if you have configured mtools, you can just use them\r
    directly. There are also other ways of image manipulation, which would\r
    be closed for you once you decide to become attached to the build system.\r
\r
    If you want to verify or debug your changes in Q3/A3, it is normally\r
    sufficient to build just what you have changed as in Q2/A2.\r
    To be extra sure, you can build from the repository root as in Q6/A6\r
    limiting to your compiler and FASM for some helper tasks;\r
    any possible differences between this mode and actions of the autobuild\r
    server are due to environment issues, like Windows vs Linux,\r
    and would not be resolved anyway.\r
\r
    If you just want it, note that the full build requires all compilers\r
    listed in Q1/A1 and Linux. MinGW and Cygwin will not help you.\r
\r
Q5. I'm sure that I want to build the entire system.\r
    The autobuild server does this, after all.\r
A5. The autobuild server has one concrete configuration with 64-bit Linux.\r
    The developers are slightly interested in compiling programs in different\r
    systems, but nobody needs portability of actions that only one server\r
    does anyway.\r
\r
    So, don't expect support from developers. Though, here goes the instruction\r
    in interest of completeness.\r
\r
  * Configure all compilers as described in Q2/A2.\r
  * Configure kpack and kerpack as described in Q2/A2.\r
    They are optional for Q2/A2, but required here,\r
    the image just could not contain all programs in unpacked form.\r
  * Configure mtools, so that mformat, mmd and mcopy are somewhere in PATH.\r
  * Configure mkisofs.\r
  * For full duplication of the autobuild server configure build variants:\r
    create directories build-eng, build-rus, ... in the root of repository for\r
    every subdirectory in data/ except data/common. Create files\r
    build-eng/tup.config, build-rus/tup.config, ... with\r
    CONFIG_BUILD_TYPE=eng, rus, ... correspondingly. This will switch\r
    to out-of-tree builds for every variant. If one build type is sufficient\r
    for you, you may skip this step.\r
  * Run\r
        tup init\r
    in the root of repository.\r
  * Run\r
        tup\r
    anywhere inside repository.\r
  * If everything went good, there should be files kolibri.img and kolibri.iso\r
    in every build-* directory. When you want to update,\r
    rerun tup without arguments.\r
\r
Q6. I don't want to keep a zoo of compilers and tools required for Q5,\r
    but I still want to build as many programs as possible with what I have.\r
A6.\r
  * Configure all compilers you want to use as described in Q2/A2.\r
  * Create tup.config in the root of repository. Disable all compilers you\r
    don't want to use there; comments in tup.config.template should help you.\r
  * Optionally, configure kpack and kerpack as described in Q2/A2.\r
  * Run\r
        tup init\r
    in the root of repository.\r
  * Run\r
        tup\r
    anywhere inside repository.\r
\r
Q7. I have modified the source code of the kernel, one driver or one program\r
    and want to test changes.\r
A7. First, you need to build the corresponding binary as described in Q1/A1 or\r
    Q2/A2.\r
    To test a program, it is sufficient to put it to some place accessible\r
    to the working KolibriOS and just run it from there. Drivers are loaded\r
    from the folder /rd/1/drivers, which is initialized from kolibri.img,\r
    so testing a driver requires either copying the compiled binary to\r
    /rd/1/drivers manually between KolibriOS startup and loading driver or\r
    inserting the driver to the image kolibri.img outside of KolibriOS.\r
    Testing the kernel or an auto-loading driver requires modifying the image.\r
\r
    There are several possible approaches for writing to kolibri.img.\r
  * From inside KolibriOS, write to /rd/1 and then save the ramdisk image.\r
  * On Linux, there is a package named "mtools",\r
    https://www.gnu.org/software/mtools/ . It can be available in the\r
    repository of your Linux distribution or it can be compiled manually.\r
    Compiling mtools for Windows is not impossible, but not supported either.\r
    Using mtools:\r
        mdir -i kolibri.img [<dir>]\r
    lists contents of the given directory of the image or the root directory\r
    if <dir> is omitted;\r
        mcopy -moi kolibri.img <file> ::<imgfile>\r
    inserts the file <file> to the image using the name <imgfile>; with\r
    reverse order of the arguments, it extracts the corresponding file.\r
  * On Linux with root privileges, the standard mount command can be used:\r
        mount -t vfat -o loop kolibri.img <dir>\r
    maps contents of kolibri.img under the directory <dir>, which must exist,\r
    hiding whatever was in <dir>. When done, use\r
        umount <dir>\r
  * On Windows with administrator privileges, the driver ImDisk\r
    http://www.ltr-data.se/opencode.html/#ImDisk can be used:\r
        imdisk -a -m A: -t file -f kolibri.img\r
    maps contents of kolibri.img to the virtual disk A:. When done, use\r
        imdisk -d -m A:\r