keremet/mkimage-profiles
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
07d812d7ff
mkimage-profiles/doc/variables.txt

101 lines
4.7 KiB
Plaintext
Raw Normal View History

doc/: minor update Somewhat more uniform style and a few additional bits.
2011-09-11 19:02:17 +04:00
переменные make
~~~~~~~~~~~~~~~
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
При запуске на сборку принимается ряд переменных
(см. тж. profiles.mk.sample):
- APTCONF
+ задаёт путь к требуемому apt.conf
+ значение: пусто (по умолчанию системный) либо строка
added doc/apt.conf.sample Unfortunately apt configuration is not straightforward at all regarding being overridden: one can't just provide sources.list but needs a corresponding apt.conf along with it, and that apt.conf must disable the SysV-style snippet directories to avoid interesting side effects of all the things getting overlaid. So it's not surprising that torabora has asked for an example... (thanks go to boyarsh@ since I asked him for an example long ago)
2011-10-31 19:06:05 +04:00
+ см. ../image.in/Makefile, apt.conf.sample
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
- ARCH
docs: minor updates doc/variables.txt was missing the already-existing BUILDLOG variable description, and ARCHES got added during multi-target toplevel rewrite. Other minor fixes come as appropriate.
2012-01-02 19:52:48 +04:00
+ задаёт целевую архитектуру образов
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
+ значение: пусто (по умолчанию авто), i586 или x86_64
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
+ см. ../lib/build.mk
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
docs: minor updates doc/variables.txt was missing the already-existing BUILDLOG variable description, and ARCHES got added during multi-target toplevel rewrite. Other minor fixes come as appropriate.
2012-01-02 19:52:48 +04:00
- ARCHES
doc/variables.txt: ARCHES explained Multiple ARCHES won't just magically work without the ability to figure out the correct apt.conf; fortunately there's just the right example handy in profiles.mk.sample already. Thanks glebfm@ for feedback.
2012-04-09 23:06:42 +04:00
+ задаёт набор целевых архитектур при параметрическом задании APTCONF
docs: minor updates doc/variables.txt was missing the already-existing BUILDLOG variable description, and ARCHES got added during multi-target toplevel rewrite. Other minor fixes come as appropriate.
2012-01-02 19:52:48 +04:00
+ значение: пусто (по умолчанию авто) либо список через пробел
doc/variables.txt: ARCHES explained Multiple ARCHES won't just magically work without the ability to figure out the correct apt.conf; fortunately there's just the right example handy in profiles.mk.sample already. Thanks glebfm@ for feedback.
2012-04-09 23:06:42 +04:00
+ см. ../Makefile, profiles.mk.sample
docs: minor updates doc/variables.txt was missing the already-existing BUILDLOG variable description, and ARCHES got added during multi-target toplevel rewrite. Other minor fixes come as appropriate.
2012-01-02 19:52:48 +04:00
BELL support Implemented opportunistic alarm support as proposed by torabora; the actual result depends on readline and/or terminal settings (read up on "visual bell" vs "audible bell" in case it's wrong). TODO: this ought to be shifted downstream when proper logging framework is there.
2011-10-31 18:49:05 +04:00
- BELL
introduced NICE variable This one regulates the build wrapper: if the value is non-empty then nice(1) and ionice(1) will be attempted so that the build behaves better in regard to other tasks running on the system. A few doc/variables.txt updates along the way.
2011-11-04 17:53:06 +04:00
+ подаёт сигнал после завершения сборки
docs: minor updates doc/variables.txt was missing the already-existing BUILDLOG variable description, and ARCHES got added during multi-target toplevel rewrite. Other minor fixes come as appropriate.
2012-01-02 19:52:48 +04:00
+ значение: пусто (по умолчанию нет) либо любая строка
BELL support Implemented opportunistic alarm support as proposed by torabora; the actual result depends on readline and/or terminal settings (read up on "visual bell" vs "audible bell" in case it's wrong). TODO: this ought to be shifted downstream when proper logging framework is there.
2011-10-31 18:49:05 +04:00
+ см. ../lib/build.mk
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
- BUILDDIR
introduced NICE variable This one regulates the build wrapper: if the value is non-empty then nice(1) and ionice(1) will be attempted so that the build behaves better in regard to other tasks running on the system. A few doc/variables.txt updates along the way.
2011-11-04 17:53:06 +04:00
+ задаёт каталог генерируемого профиля и сборки
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
+ значение: пусто (по умолчанию авто) либо строка
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
+ см. ../lib/profile.mk
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
docs: minor updates doc/variables.txt was missing the already-existing BUILDLOG variable description, and ARCHES got added during multi-target toplevel rewrite. Other minor fixes come as appropriate.
2012-01-02 19:52:48 +04:00
- BUILDDIR_PREFIX
+ задаёт префикс каталога генерируемого профиля и сборки
+ значение: строка; по умолчанию выбирается алгоритмически
+ см. ../main.mk
- BUILDLOG
+ задаёт путь к файлу журнала сборки/очистки
+ значение: по умолчанию $(BUILDDIR)/build.log либо строка
+ см. ../lib/log.mk
lib/build.mk: add basic CHECK support The idea is to check: - the reachability of every target used to build the image in question; - the availability of all the package lists and subsequently packages for that image; - the lack of "dangling" intermediate targets, features, pkglists, hooks etc. So far only the first step is implemented -- it's easy and somewhat helpful already for make CHECK=1 all
2011-12-05 21:13:33 +04:00
- CHECK
doc/variables.txt: tweak CHECK description It wasn't exactly obvious that the actual image build isn't started with CHECK=1.
2012-05-19 23:37:33 +04:00
+ включает режим проверки сборки конфигурации (без сборки образа)
lib/build.mk: add basic CHECK support The idea is to check: - the reachability of every target used to build the image in question; - the availability of all the package lists and subsequently packages for that image; - the lack of "dangling" intermediate targets, features, pkglists, hooks etc. So far only the first step is implemented -- it's easy and somewhat helpful already for make CHECK=1 all
2011-12-05 21:13:33 +04:00
+ значение: пусто (по умолчанию) либо любая строка
+ см. ../lib/build.mk
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
- CLEAN
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
+ экономия RAM+swap при сборке в tmpfs, иначе места на диске
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
+ очистка рабочего каталога после успешной сборки очередной стадии
+ может помешать использовать некоторые варианты отладки
CLEAN by default (unless DEBUG) CLEAN is so useful and fiddling with .work chroots does demand knowledge (hsh-shell is handy btw); so unless we really get our hands dirty, let's spare ours preciouss tmpfss.
2011-11-07 14:28:09 +04:00
+ значение: любая строка; по умолчанию пусто при DEBUG, иначе 1
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
+ см. ../lib/clean.mk
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
- DEBUG
introduced NICE variable This one regulates the build wrapper: if the value is non-empty then nice(1) and ionice(1) will be attempted so that the build behaves better in regard to other tasks running on the system. A few doc/variables.txt updates along the way.
2011-11-04 17:53:06 +04:00
+ включает средства отладки
clean.mk and friends: introduced CLEAN control variable make CLEAN=1 will prune workdirs after packing their results, so disk (or preferably tmpfs) usage will be lower
2011-08-16 00:30:20 +04:00
+ значение: пусто (по умолчанию), 1 или 2
official {distro,ve}/* support This is quite a large-scale change since mkimage-profiles got used to baking distributions over the last year, and virtual environments are quite different, so e.g. image.in/Makefile had to be split in two with the main part of it moved into features.in/iso/lib/. Short overview: - features.in/Makefile: lib/ support (supporting VE images requires dynamic modifications to image.in/Makefile before starting the build; the most natural way to achieve that seems to use features mechanism along with makefile include dir) - packaging format related part moved into features.in/pack (should be better prepared for diversity either) - features.in/iso renamed to features.in/build-distro - features.in/ve renamed to features.in/build-ve + NB: these could not be merged as e.g. features.in/build due to completely different script hooks - lib/image.mk renamed to lib/build.mk - image, config, log postprocessing moved downstream - added a sort of a topping in the form of lib/sugar.mk - assorted style fixups (like ifeq usage) - clean.mk: reliability fix (the problem was observed by Oleg Ivanov and me too but finally it did get the attention quantum) - reviewed, updated and extended docs + QUICKSTART: should be[come] a step-by-step guide (thanks Leo-sp50 for prodiving feedback)
2011-10-06 12:46:31 +04:00
+ см. ../lib/log.mk
doc/: minor update Somewhat more uniform style and a few additional bits.
2011-09-11 19:02:17 +04:00
live: introduce homepage redirector knobs There are three more variables to adjust the redirect page: HOMEPAGE, HOMENAME and HOMEWAIT; e.g. live-webkiosk is now quite a bit more whitelabel.
2012-03-31 17:14:00 +04:00
- HOMEPAGE, HOMENAME, HOMEWAIT
+ указывают адрес, название и таймаут перехода для домашней страницы
+ значение: корректный URL, строка, целое неотрицательное число
+ см. ../features.in/live/generate.mk (тж. по умолчаниям)
initial isohybrid support Here we go with postprocessing priorities along the way as ISO hybridization has to occur before implanting final MD5 sum (which must happen earlier than e.g. some external MD5SUM file generation). Unfortunately proper dependencies aren't applicable here (though I'd like to be proved wrong on this one). Please note that this needs propagator > 20101130-alt9 for automatic mode to work (has also been worked around in gfxboot case with design-bootloader-source-6.0-alt1). Thanks rom_as@ for asking about the hybrid image status and helping out with testing.
2011-12-12 19:34:00 +04:00
- ISOHYBRID
+ включает постобработку ISO-образа isohybrid
+ значение: пусто (по умолчанию) либо любая строка
+ см. ../features.in/pack/config.mk
introduced NICE variable This one regulates the build wrapper: if the value is non-empty then nice(1) and ionice(1) will be attempted so that the build behaves better in regard to other tasks running on the system. A few doc/variables.txt updates along the way.
2011-11-04 17:53:06 +04:00
- NICE
+ понижает нагрузку системы сборочной задачей
+ значение: пусто (по умолчанию) либо любая строка
+ см. ../lib/build.mk
initial target tracing support and reporting The purpose is being able to examine particular target interdependency graph for a given image having been configured to avoid convoluted dependencies (loops in particular). The implementation is based on SHELL hook hint by John Graham-Cumming: http://cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make
2012-03-19 15:42:10 +04:00
- REPORT
reports.mk: added reports/scripts This one extracts the exact time-ordered list of script hooks run while building the image. Some commons refactoring is also due.
2012-04-18 23:22:29 +04:00
+ запрашивает создание отчётов о собранном образе
initial target tracing support and reporting The purpose is being able to examine particular target interdependency graph for a given image having been configured to avoid convoluted dependencies (loops in particular). The implementation is based on SHELL hook hint by John Graham-Cumming: http://cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make
2012-03-19 15:42:10 +04:00
+ значение: пусто (по умолчанию) либо любая строка
syslinux configuration revisited - incompatible change (to fix the rather broken early style): use/syslinux/ui-% is now use/syslinux/ui/%; - default timeout changed to 9 seconds (long enough and keeps the countdown in a single figure); - added totaltimeout of 300 seconds; - provided live kiosk images with almost-instant boot by default; ...and some other assorted tweaks here and there, sorry.
2012-03-30 23:41:19 +04:00
+ NB: в силу специфики обработки передаётся только явно
initial target tracing support and reporting The purpose is being able to examine particular target interdependency graph for a given image having been configured to avoid convoluted dependencies (loops in particular). The implementation is based on SHELL hook hint by John Graham-Cumming: http://cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make
2012-03-19 15:42:10 +04:00
+ см. ../Makefile, ../report.mk, ../lib/report.mk
image.in/Makefile: introduced save-profile From now on, non-empty SAVE_PROFILE variable will indicate the need to carry the particular generated profile inside the image built from it. Thanks gns@ for this feature in liveflash.eeepc.
2012-02-08 00:21:33 +04:00
- SAVE_PROFILE
+ сохраняет архив сгенерированного профиля в .disk/
+ значение: пусто (по умолчанию) либо любая строка
+ см. ../image.in/Makefile
stage2: tunable squashfs compression The existing implementation would handle kernel differences just fine but a bit too automatically: if it sees xz support, that's what will end up being used (and if there's -Xbcj binary compression filter available for the target platform, it will be applied unequivocally either). It's perfectly suitabe for getting fine-tuned release images but is also a bit too resource-consuming while developing the image configuration which has no business with its compression. The one and only knob is SQUASHFS (see doc/variables.txt); to give an idea of the differences, here are some numbers for a mostly-binary (43% as per 99-elf-stats) webkiosk livecd and a rather less so (18%) flightgear one on a dual quad-core X5570 node (each mksquashfs run used up all the cores): SQUASHFS | live-webkiosk.iso | live-flightgear.iso ---------+-------------------+--------------------- fast | 3:30 / 130M | 5:11 / 852M normal * | 3:37 / 100M | 5:35 / 688M tight | 3:50 / 98M | 6:47 / 683M Thus if the knob isn't fiddled with, the defaults will allow for a reasonably fast build of a pretty slim image; if one is building a release or if a particular image is very sensitive being close to the media capacity then just add SQUASHFS=tight and see it a percent or two down on size. Please note that lzo/gzip-compressed images are also quicker to uncompress thus further helping with test iterations. Thanks to led@ and glebfm@ for helpful hints and questions.
2012-04-08 20:25:18 +04:00
- SQUASHFS
+ определяет характер сжатия squashfs для stage2
+ значение:
- пусто (по умолчанию) либо normal: xz
- tight: xz с -Xbcj по платформе (лучше, но дольше -- подбор в два прохода)
- fast: gzip/lzo (быстрее запаковывается и распаковывается, меньше степень)
+ см. ../features.in/stage2/stage1/scripts.d/03-test-kernel
better output directory and results structuring Following m-p-d, a more involved default output directory structure is feasible now: ~/out/name/date/name-date-arch.type instead of plain ~/out/name-date-arch.type This particular behaviour can be achieved by passing SORTDIR='$(IMAGE_NAME)/$(DATE)'; note the single quotes. Reports are also saved in this resulting structure albeit the place is still highly debatable.
2012-04-23 22:56:35 +04:00
- SORTDIR
+ дополнительно структурирует каталог собранных образов
+ значение: пусто (по умолчанию) либо строка
- например, '$(IMAGE_NAME)/$(DATE)'
+ см. ../image.in/Makefile
doc/: minor update Somewhat more uniform style and a few additional bits.
2011-09-11 19:02:17 +04:00
пример
~~~~~~
introduced NICE variable This one regulates the build wrapper: if the value is non-empty then nice(1) and ionice(1) will be attempted so that the build behaves better in regard to other tasks running on the system. A few doc/variables.txt updates along the way.
2011-11-04 17:53:06 +04:00
make DEBUG=1 CLEAN=1 distro/syslinux.iso
Reference in New Issue Copy Permalink