cargo-ebuild

Build Status Latest Version All downloads Downloads of latest version

cargo ebuild is a Cargo subcommand that generates an ebuild recipe that uses cargo.eclass to build a Cargo based project for Gentoo

Installation

Install it with Cargo:

$ cargo install cargo-ebuild

Usage

You will first need to get the sources to the crate you want to install. Your best bet is to search for the crate at crates.io and follow the Repository link. This should give you the ability to clone the repo. Once you have cloned the repo, change into the directory and ensure that you checkout the tag corresponding to the version you would like to package. Lastly you will execute the cargo ebuild command to generate the ebuild for that crate.

Example

shell-session $ git clone https://github.com/gentoo/cargo-ebuild.git $ cd cargo-ebuild $ git checkout 0.5.3 $ cargo ebuild $ cat cargo-ebuild-0.5.3.ebuild

```bash

Copyright 2023 Gentoo Authors

Distributed under the terms of the GNU General Public License v2

Auto-Generated by cargo-ebuild 0.5.3

EAPI=8

CRATES=" aho-corasick-0.7.20 ansiterm-0.12.1 anyhow-1.0.68 atty-0.2.14 autocfg-1.1.0 bitflags-1.3.2 block-buffer-0.10.3 bstr-0.2.17 camino-1.1.1 cargo-lock-8.0.3 cargo-platform-0.1.2 cargometadata-0.15.2 cc-1.0.78 cfg-if-1.0.0 clap-2.34.0 cpufeatures-0.2.5 crates-index-0.18.11 crossbeam-channel-0.5.6 crossbeam-deque-0.8.2 crossbeam-epoch-0.9.13 crossbeam-utils-0.8.14 crypto-common-0.1.6 cvss-2.0.0 digest-0.10.6 either-1.8.0 fnv-1.0.7 formurlencoded-1.1.0 fs-err-2.9.0 generic-array-0.14.6 git2-0.15.0 globset-0.4.9 globwalk-0.8.1 heck-0.3.3 hermit-abi-0.1.19 hermit-abi-0.2.6 hex-0.4.3 home-0.5.4 humantime-2.1.0 humantime-serde-1.1.1 idna-0.3.0 ignore-0.4.18 itertools-0.10.5 itoa-1.0.5 jobserver-0.1.25 lazystatic-1.4.0 libc-0.2.139 libgit2-sys-0.14.0+1.5.0 libssh2-sys-0.2.23 libz-sys-1.1.8 log-0.4.17 memchr-2.5.0 memoffset-0.7.1 numcpus-1.15.0 oncecell-1.17.0 openssl-probe-0.1.5 openssl-sys-0.9.80 percent-encoding-2.2.0 pest-2.5.2 pestderive-2.5.2 pestgenerator-2.5.2 pestmeta-2.5.2 phf-0.11.1 phfgenerator-0.11.1 phfmacros-0.11.1 phfshared-0.11.1 pkg-config-0.3.26 platforms-3.0.2 proc-macro-error-1.0.4 proc-macro-error-attr-1.0.4 proc-macro2-1.0.49 quote-1.0.23 rand-0.8.5 randcore-0.6.4 rayon-1.6.1 rayon-core-1.10.1 regex-1.7.0 regex-syntax-0.6.28 rustc-hash-1.1.0 rustsec-0.26.4 ryu-1.0.12 same-file-1.0.6 scopeguard-1.1.0 semver-1.0.16 serde-1.0.152 serdederive-1.0.152 serdejson-1.0.91 sha1-0.10.5 siphasher-0.3.10 smartstring-1.0.1 staticassertions-1.1.0 strsim-0.8.0 structopt-0.3.26 structopt-derive-0.4.18 syn-1.0.107 tera-1.17.1 textwrap-0.11.0 thiserror-1.0.38 thiserror-impl-1.0.38 threadlocal-1.1.4 time-0.3.17 time-core-0.1.0 tinyvec-1.6.0 tinyvecmacros-0.1.0 toml-0.5.10 typenum-1.16.0 ucd-trie-0.1.5 unic-char-property-0.9.0 unic-char-range-0.9.0 unic-common-0.9.0 unic-segment-0.9.0 unic-ucd-segment-0.9.0 unic-ucd-version-0.9.0 unicode-bidi-0.3.8 unicode-ident-1.0.6 unicode-normalization-0.1.22 unicode-segmentation-1.10.0 unicode-width-0.1.10 url-2.3.1 vcpkg-0.2.15 vecmap-0.8.2 versioncheck-0.9.4 walkdir-2.3.2 winapi-0.3.9 winapi-i686-pc-windows-gnu-0.4.0 winapi-util-0.1.5 winapi-x86_64-pc-windows-gnu-0.4.0 "

inherit cargo

DESCRIPTION="Generates an ebuild for a package using the in-tree eclasses."

Double check the homepage as the cargo_metadata crate

does not provide this value so instead repository is used

HOMEPAGE="https://github.com/gentoo/cargo-ebuild" SRCURI="$(cargocrate_uris)"

License set may be more restrictive as OR is not respected

use cargo-license for a more accurate license picture

LICENSE="Apache-2.0 Boost-1.0 MIT MPL-2.0+ Unicode-DFS-2016 Unlicense ZLIB" SLOT="0" KEYWORDS="~amd64"

DEPEND="" RDEPEND="${DEPEND}" BDEPEND=""

rust does not use *FLAGS from make.conf, silence portage warning

update with proper path to binaries this crate installs, omit leading /

QAFLAGSIGNORED="usr/bin/${PN}" ```

API

API documentation is available at docs.rs.

Templates

cargo-ebuild allows you to use a custom tera template.

The built-in base.tera provided is the following:

``` tera {%- block header -%}

Copyright 2017-{{ this_year }} Gentoo Authors

Distributed under the terms of the GNU General Public License v2

Auto-Generated by cargo-ebuild {{ cargoebuildver }}

{% endblock %} EAPI={%- block eapi -%}7{%- endblock %}

{% block crates -%} CRATES=" {% for crate in crates -%} {{ crate }} {%- endfor -%}" {%- endblock %}

inherit {% block inherit -%}cargo{%- endblock %}

DESCRIPTION={%- block description -%}"{{ description | trim }}"{%- endblock %}

Double check the homepage as the cargo_metadata crate

does not provide this value so instead repository is used

HOMEPAGE={%- block homepage -%}"{{ homepage }}"{%- endblock %} SRCURI={%- block srcuri -%}{% raw -%}"$(cargocrateuris ${CRATES})"{%- endraw %}{%- endblock %}

License set may be more restrictive as OR is not respected

use cargo-license for a more accurate license picture

LICENSE={%- block license -%}"{{ license }}"{%- endblock %} SLOT={%- block slot -%}"0"{%- endblock %} KEYWORDS={%- block keyword -%}"~amd64"{%- endblock %} {% block variables -%} RESTRICT="mirror" {%- endblock %}

{%- block phases -%} {%- endblock -%} ```

``` tera {%- extends "base.tera" -%}

{% block variables -%} USE="+capi"

ASMDEP=">=dev-lang/nasm-2.14" BDEPEND=" amd64? ( ${ASMDEP} ) capi? ( dev-util/cargo-c ) " {%- endblock %}

{% block phases -%} srccompile() { export CARGOHOME="${ECARGO_HOME}" local args=$(usex debug "" --release)

cargo build ${args} \
    || die "cargo build failed"

if use capi; then
    cargo cbuild ${args} \
        --prefix="/usr" --libdir="/usr/$(get_libdir)" \
        || die "cargo cbuild failed"
fi

}

srcinstall() { export CARGOHOME="${ECARGO_HOME}" local args=$(usex debug "" --release)

if use capi; then
    cargo cinstall $args \
        --prefix="/usr" --libdir="/usr/$(get_libdir)" --destdir="${ED}" \
        || die "cargo cinstall failed"
fi

cargo_src_install

} {%- endblock -%} ```