You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Aurélien Gâteau 3d40527d29 Make it possible to "resize" (aka delete + create for now) existing partitions		11 years ago
..
dummyprocess	Alignment fix.	11 years ago
dummypython	Do not make dummypython fail	11 years ago
fstab	Some test data for fstab module	11 years ago
greeting	Prepare for late enqueuing of jobs to the JobQueue.	11 years ago
grub	Add some test file for grub module	11 years ago
initcpio	initcpio module, very loosely based on the one from the manjaro branch	11 years ago
keyboard	Store keyboard layout information in GlobalStorage.	11 years ago
locale	Create jobs in locale viewmodule.	11 years ago
mount	Use libcalamares.utils.mount	11 years ago
partition	Make it possible to "resize" (aka delete + create for now) existing partitions	11 years ago
summary	Show a summary of the partition changes on the summary page	11 years ago
umount	PEPify umount	11 years ago
unsquashfs	Simplify unsquash code	11 years ago
users	Add autologinUser to GlobalStorage.	11 years ago
CMakeLists.txt	Add CalamaresAddModuleSubdirectory, a CMake function for modules that	11 years ago
README.md	Update README.md	11 years ago
globalStorage.yaml	Consistency: calamares_main ==> run; global_storage => globalStorage	11 years ago
testmodule.py	globalStorage ==> globalstorage fix	11 years ago

README.md

Calamares modules directory

Calamares modules are plugins that provide features like installer pages, batch jobs, etc. Each Calamares module lives in its own directory.

Qt plugin viewmodules

Currently the only way to write a module which exposes one or more installer pages (viewmodule) is through a Qt plugin. Viewmodules should implement Calamares::ViewStep. They can also implement Calamares::Job to provide jobs.

To add a Qt plugin module, put it in a subdirectory and make sure it has a module.conf and a CMakeLists.txt with a calamares_add_plugin call. It will be picked up automatically by our CMake magic.

Python and process jobmodules

Batch jobs for Calamares can be written as Python scripts or as generic commands (shell scripts, external programs, etc.). To add a Python or process jobmodule, put it in a subdirectory and make sure it has a module.conf. It will be picked up automatically by our CMake magic. CMakeLists.txt is not used for Python and process jobmodules.

All code in Python job modules must obey PEP8, the only exception are libcalamares.globalstorage keys, which should always be camelCaseWithLowerCaseInitial.