| Name | tuxmake JSON |
| Version |
1.23.1
JSON |
| download |
| home_page | https://tuxmake.org/ |
| Summary | Thin wrapper to build Linux kernels |
| upload_time | 2024-02-29 09:29:04 |
| maintainer | None |
| docs_url | None |
| author | Antonio Terceiro |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<img src="docs/tuxmake_full.svg" alt="TuxMake Logo" width="50%" />
</div>
[](https://gitlab.com/Linaro/tuxmake/pipelines)
[](https://gitlab.com/Linaro/tuxmake/commits/master)
[](https://pypi.org/project/tuxmake/)
[](https://github.com/psf/black)
[](https://gitlab.com/Linaro/tuxmake/blob/master/LICENSE)
[Documentation](https://tuxmake.org/) - [Repository](https://gitlab.com/Linaro/tuxmake) - [Issues](https://gitlab.com/Linaro/tuxmake/-/issues)
TuxMake, by [Linaro](https://www.linaro.org/), is a command line tool and
Python library that provides portable and repeatable Linux kernel builds across
a variety of architectures, toolchains, kernel configurations, and make
targets. TuxMake is a part of [TuxSuite](https://tuxsuite.com), a suite of
tools and services to help with Linux kernel development.
[[_TOC_]]
# About TuxMake
Building Linux is easy, right? You just run "make defconfig; make"!
It gets complicated when you want to support the following combinations:
- Architectures (arc, arm, arm64, i386, mips, parisc, powerpc, riscv, s390, sh,
sparc, x86_64, etc)
- Toolchains (gcc-8, gcc-9, gcc-10, clang-10, clang-11, clang-nightly, etc)
- Configurations (defconfig, distro configs, allmodconfigs, randconfig, etc)
- Targets (kernel image, documentation, selftests, perf, cpupower, etc)
- Build-time validation (coccinelle, sparse checker, etc)
Each of those items requires specific configuration, and supporting all
combinations is difficult. TuxMake seeks to simplify Linux kernel building by
providing a consistent command line interface to each of those combinations
listed above. You specify what to build at the command line, and TuxMake drives
the build for you, doing the same steps the same way every time.
The real power comes from using TuxMake's curated, portable build environments
distributed as Docker/Podman [container images](https://hub.docker.com/u/tuxmake).
When using these versioned and hermetic filesystem images, your team can use
the same exact toolchain(s) across different workstation platforms. Reporting
and reproducing build failures is trivial by sharing TuxMake command lines with
others.
# Installing TuxMake
There are several options for installing TuxMake:
- [From PyPI](docs/install-pypi.md)
- [Debian packages](docs/install-deb.md)
- [RPM packages](docs/install-rpm.md)
- [Run uninstalled](docs/run-uninstalled.md)
# Using TuxMake
To use TuxMake, navigate to a Linux source tree (where you might usually run
`make`), and run `tuxmake`. By default, it will perform a defconfig build on
your native architecture, using a default compiler (`gcc`).
The behavior of the build can be modified with command-line arguments. Run
`tuxmake --help` to see all command-line arguments.
# Examples
Build from current directory:
$ tuxmake
Build using Podman:
$ tuxmake --runtime podman
Build from specific directory:
$ tuxmake --directory /path/to/linux
Build an arm64 kernel:
$ tuxmake --target-arch=arm64
Build an arm64 kernel with gcc-10:
$ tuxmake --target-arch=arm64 --toolchain=gcc-10
Build an arm64 kernel with clang-10:
$ tuxmake --target-arch=arm64 --toolchain=clang-10
Build tinyconfig on arm64 with gcc-9:
$ tuxmake -a arm64 -t gcc-9 -k tinyconfig
Build defconfig with additional config from file:
$ tuxmake --kconfig-add /path/to/my.config
Build defconfig with additional config from URL:
$ tuxmake --kconfig-add https://foo.com/my.config
Build defconfig with additional in-tree config:
$ tuxmake --kconfig-add kvm_guest.config
Build defconfig with additional inline config:
$ tuxmake --kconfig-add CONFIG_KVM_GUEST=y
Build tinyconfig on arm64 with gcc-9 using docker:
$ tuxmake -r docker -a arm64 -t gcc-9 -k tinyconfig
Build DTBs on arm64 using podman:
$ tuxmake -r podman -a arm64 -t gcc-9 dtbs
Incremental builds can be done by reusing a build directory:
$ tuxmake --build-dir=/path/to/output
# hack on source ...
$ tuxmake --build-dir=/path/to/output
# only rebuilds what is needed
Using configuration files:
# reads command line options from ~/.config/tuxmake/myconfig
$ tuxmake @myconfig
# reads command line options from /tmp/myconfig
$ tuxmake @/tmp/myconfig
Display all options:
$ tuxmake --help
# Contributing to TuxMake
See the [Contribution Guidelines](docs/contributing.md) document for details in
how to contribute to TuxMake. Contributors are expected to follow the [TuxMake
Code of Conduct](docs/code-of-conduct.md) (the same adopted in the Linux kernel
community).
Raw data
{
"_id": null,
"home_page": "https://tuxmake.org/",
"name": "tuxmake",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Antonio Terceiro",
"author_email": "antonio.terceiro@linaro.org",
"download_url": "https://files.pythonhosted.org/packages/36/c1/e0b1afb1af096d4d00e1cda7323a0ae4562f1d1dac065d3dc058158e97d7/tuxmake-1.23.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"docs/tuxmake_full.svg\" alt=\"TuxMake Logo\" width=\"50%\" />\n</div>\n\n[](https://gitlab.com/Linaro/tuxmake/pipelines)\n[](https://gitlab.com/Linaro/tuxmake/commits/master)\n[](https://pypi.org/project/tuxmake/)\n[](https://github.com/psf/black)\n[](https://gitlab.com/Linaro/tuxmake/blob/master/LICENSE)\n\n[Documentation](https://tuxmake.org/) - [Repository](https://gitlab.com/Linaro/tuxmake) - [Issues](https://gitlab.com/Linaro/tuxmake/-/issues)\n\nTuxMake, by [Linaro](https://www.linaro.org/), is a command line tool and\nPython library that provides portable and repeatable Linux kernel builds across\na variety of architectures, toolchains, kernel configurations, and make\ntargets. TuxMake is a part of [TuxSuite](https://tuxsuite.com), a suite of\ntools and services to help with Linux kernel development.\n\n[[_TOC_]]\n\n\n# About TuxMake\n\nBuilding Linux is easy, right? You just run \"make defconfig; make\"!\n\nIt gets complicated when you want to support the following combinations:\n\n- Architectures (arc, arm, arm64, i386, mips, parisc, powerpc, riscv, s390, sh,\n sparc, x86_64, etc)\n- Toolchains (gcc-8, gcc-9, gcc-10, clang-10, clang-11, clang-nightly, etc)\n- Configurations (defconfig, distro configs, allmodconfigs, randconfig, etc)\n- Targets (kernel image, documentation, selftests, perf, cpupower, etc)\n- Build-time validation (coccinelle, sparse checker, etc)\n\nEach of those items requires specific configuration, and supporting all\ncombinations is difficult. TuxMake seeks to simplify Linux kernel building by\nproviding a consistent command line interface to each of those combinations\nlisted above. You specify what to build at the command line, and TuxMake drives\nthe build for you, doing the same steps the same way every time.\n\nThe real power comes from using TuxMake's curated, portable build environments\ndistributed as Docker/Podman [container images](https://hub.docker.com/u/tuxmake).\nWhen using these versioned and hermetic filesystem images, your team can use\nthe same exact toolchain(s) across different workstation platforms. Reporting\nand reproducing build failures is trivial by sharing TuxMake command lines with\nothers.\n\n# Installing TuxMake\n\nThere are several options for installing TuxMake:\n\n- [From PyPI](docs/install-pypi.md)\n- [Debian packages](docs/install-deb.md)\n- [RPM packages](docs/install-rpm.md)\n- [Run uninstalled](docs/run-uninstalled.md)\n\n# Using TuxMake\n\nTo use TuxMake, navigate to a Linux source tree (where you might usually run\n`make`), and run `tuxmake`. By default, it will perform a defconfig build on\nyour native architecture, using a default compiler (`gcc`).\n\nThe behavior of the build can be modified with command-line arguments. Run\n`tuxmake --help` to see all command-line arguments.\n\n# Examples\n\nBuild from current directory:\n\n $ tuxmake\n\nBuild using Podman:\n\n $ tuxmake --runtime podman\n\nBuild from specific directory:\n\n $ tuxmake --directory /path/to/linux\n\nBuild an arm64 kernel:\n\n $ tuxmake --target-arch=arm64\n\nBuild an arm64 kernel with gcc-10:\n\n $ tuxmake --target-arch=arm64 --toolchain=gcc-10\n\nBuild an arm64 kernel with clang-10:\n\n $ tuxmake --target-arch=arm64 --toolchain=clang-10\n\nBuild tinyconfig on arm64 with gcc-9:\n\n $ tuxmake -a arm64 -t gcc-9 -k tinyconfig\n\nBuild defconfig with additional config from file:\n\n $ tuxmake --kconfig-add /path/to/my.config\n\nBuild defconfig with additional config from URL:\n\n $ tuxmake --kconfig-add https://foo.com/my.config\n\nBuild defconfig with additional in-tree config:\n\n $ tuxmake --kconfig-add kvm_guest.config\n\nBuild defconfig with additional inline config:\n\n $ tuxmake --kconfig-add CONFIG_KVM_GUEST=y\n\nBuild tinyconfig on arm64 with gcc-9 using docker:\n\n $ tuxmake -r docker -a arm64 -t gcc-9 -k tinyconfig\n\nBuild DTBs on arm64 using podman:\n\n $ tuxmake -r podman -a arm64 -t gcc-9 dtbs\n\nIncremental builds can be done by reusing a build directory:\n\n $ tuxmake --build-dir=/path/to/output\n # hack on source ...\n $ tuxmake --build-dir=/path/to/output\n # only rebuilds what is needed\n\nUsing configuration files:\n\n # reads command line options from ~/.config/tuxmake/myconfig\n $ tuxmake @myconfig\n # reads command line options from /tmp/myconfig\n $ tuxmake @/tmp/myconfig\n\nDisplay all options:\n\n $ tuxmake --help\n\n# Contributing to TuxMake\n\nSee the [Contribution Guidelines](docs/contributing.md) document for details in\nhow to contribute to TuxMake. Contributors are expected to follow the [TuxMake\nCode of Conduct](docs/code-of-conduct.md) (the same adopted in the Linux kernel\ncommunity).\n",
"bugtrack_url": null,
"license": null,
"summary": "Thin wrapper to build Linux kernels",
"version": "1.23.1",
"project_urls": {
"Homepage": "https://tuxmake.org/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1f4fa2233a6912c52f940fcc7720e42d675432d92a8ad6b0b34462872f7bb5b2",
"md5": "fa062c17e33435f899e2c36fbce155a1",
"sha256": "fc09d89ed6900c053c1c61e83cbc055f25e699dc79b75fe8c941aa8dd0e40fd6"
},
"downloads": -1,
"filename": "tuxmake-1.23.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa062c17e33435f899e2c36fbce155a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 67841,
"upload_time": "2024-02-29T09:29:01",
"upload_time_iso_8601": "2024-02-29T09:29:01.212222Z",
"url": "https://files.pythonhosted.org/packages/1f/4f/a2233a6912c52f940fcc7720e42d675432d92a8ad6b0b34462872f7bb5b2/tuxmake-1.23.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "36c1e0b1afb1af096d4d00e1cda7323a0ae4562f1d1dac065d3dc058158e97d7",
"md5": "b28a85e0ca9a32bf28d62bb42db86fc1",
"sha256": "b3f2278ed6570f9d4370cb38d796861976fffc91d5da605fa41fef6be18d2228"
},
"downloads": -1,
"filename": "tuxmake-1.23.1.tar.gz",
"has_sig": false,
"md5_digest": "b28a85e0ca9a32bf28d62bb42db86fc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 131105,
"upload_time": "2024-02-29T09:29:04",
"upload_time_iso_8601": "2024-02-29T09:29:04.930257Z",
"url": "https://files.pythonhosted.org/packages/36/c1/e0b1afb1af096d4d00e1cda7323a0ae4562f1d1dac065d3dc058158e97d7/tuxmake-1.23.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 09:29:04",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "tuxmake"
}
