From patchwork Mon Mar 23 10:52:30 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Quirin Gylstorff X-Patchwork-Id: 4988 Return-Path: Received: from shymkent.ilbers.de ([unix socket]) by shymkent (Cyrus 2.5.10-Debian-2.5.10-3+deb9u2) with LMTPA; Mon, 23 Mar 2026 11:53:52 +0100 X-Sieve: CMU Sieve 2.4 Received: from mail-wr1-f59.google.com (mail-wr1-f59.google.com [209.85.221.59]) by shymkent.ilbers.de (8.15.2/8.15.2/Debian-8+deb9u1) with ESMTPS id 62NArqag030994 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Mar 2026 11:53:52 +0100 Received: by mail-wr1-f59.google.com with SMTP id ffacd0b85a97d-43b4a9a3bf6sf1129291f8f.0 for ; Mon, 23 Mar 2026 03:53:52 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1774263225; cv=pass; d=google.com; s=arc-20240605; b=R+CTOSbUAW9NXo7ZbjqGBPEtCvU/GkQ6vzGIA4oSYrxdI9bed9EWB3Pv/kKfVyLyTa AmmxJaOsK7W+CIetG00Znfed/pvr+F+Z8jvmBDYSUjl5SFVRRUhMEggdxWfQ+zeL6qbE 2ElKjUJ91kdtgoHS9Jx8YpraoVYElxmMUHCXws2k605AofuEx2OmnmruCIw+3cbQZOyQ 0DVzMZTCAKU7sODYuVQVNcGnv9mowq8bmhPwiOkoMiY41z3cO4QstdGGyIqfKRIUdJqI vmMIeZ4NnEJXY1Ra3ipO4Sj2Y44sXLiZMxB28IkOW9jMZJgNOIfivnfvQ+Jo2Mbf2ylm rL1g== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:reply-to:feedback-id:mime-version :references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=liLVvEMsKaBFQzWkCS4fO8CbkAvd6Znvqgx/kf5zrn4=; fh=SylsekhwwY1kazYmax3ysh26JNpufMw/I8XGRIzXdKQ=; b=Y0+gfKs6rzL+icOw15vnirAgrdJk+tMICjNC8GuwzChjy/XkChFCvXapGQvgRp63n1 mdoJkEiBK4mukedde23r5qNlLxEU1prfkDBlvoVkuOSwy5YD/tMK6SAeBILvlLdURHdA dXI3hk4KdQTfAsiG0Dq4AE2POMEUhXUvA1jLodoplHfPqMJxd9Ko/FO/b/3y0pKTOr3i pV00QjMxnq2dIf56dCZglb6ogMV12gbTGWd7bdfybnHtMGmURAwjtz+B7zdYE5TLhkX7 E2sAlIRGx4PH1MO4+emLD8RiR79m0pPCh0J+7ncs3IQ2j2TPa/dGOwKM3Modzg2VF98K I36w==; darn=isar-build.org ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=fm1 header.b=B+2kFMFJ; spf=pass (google.com: domain of fm-51332-202603231053424c47bd1a5900020784-ofhexo@rts-flowmailer.siemens.com designates 185.136.64.227 as permitted sender) smtp.mailfrom=fm-51332-202603231053424c47bd1a5900020784-ofHeXO@rts-flowmailer.siemens.com; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20251104; t=1774263225; x=1774868025; darn=isar-build.org; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:reply-to :x-original-authentication-results:x-original-sender:feedback-id :mime-version:references:in-reply-to:message-id:date:subject:to:from :from:to:cc:subject:date:message-id:reply-to; bh=liLVvEMsKaBFQzWkCS4fO8CbkAvd6Znvqgx/kf5zrn4=; b=yFAy7G4UjGveM0KUwylLrzN3t8NDGlAsisiMN3UP9JFGdOxQBDD4uVSlBRVxGL4nIm oo6CWaMdkJzqaaSDfaPJbCy5gbztsNwoKJh/KjBifGfjTh/Zm29LzzREfDTEDleUtY42 kUMdEdQK5UDROAlaSzxusrBDH/di98TFn8rt6KsXQ+iMex3ZlCLUTLzXxwNciRppTDHf 5jjULoFyq77DM7IXpKhYm7JY9dMR82wLfG9ygXItfdFqG3Szg5wnmZGm3YUw2ZfKDKN1 zAEu9NVdgx8luKnDsecPqrl6HkBl0l1Sx4UUlxWAIYfy+8graaHWsjLYo1X5JCOzh+hO giHw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1774263225; x=1774868025; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :x-spam-checked-in-group:list-id:mailing-list:precedence:reply-to :x-original-authentication-results:x-original-sender:feedback-id :mime-version:references:in-reply-to:message-id:date:subject:to:from :x-beenthere:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=liLVvEMsKaBFQzWkCS4fO8CbkAvd6Znvqgx/kf5zrn4=; b=T872/8xi88Q1z7WLhjU3S73l0xd4WxCA/kmNMg0TLa96NvvJOUEaTOJEqaWlmVeUBs MlHIlHRRIxZSedQZ24PYQwrYLcu3/6gPZ/zdOE6D8y0VLA0XdIkh10CWQB3rmrhtzERq hU+z5ier39oGKra2OpiKaIMz7WALr2IMNBuv3/KKSQIQCnfcqd4znk5vqhbAs7jiA2K3 Ln21biMsnBZL2SV22hsFFgEl17vQKzLcRQU1nWSi1sIHfOLQ68KXxc5k/9jIEM+8cUUB ZVz44ji5KMvcgJyNOuykeHWcDbLWFcBvVBsr3GvGH6eAtBSqN1nsTRc8YVacAyFpJYDB KAIA== X-Forwarded-Encrypted: i=2; AJvYcCVC0EodPTdYEGeiu0pGWLGnhBzQ/yy2OHDPDxpald9IU/80NsjyvLkvHAjMAcIPWMJMoYPy6F8=@isar-build.org X-Gm-Message-State: AOJu0YztyGysn1Q8AElygq4wHMTp858IzqmSUNn+BAuTVHA2UNH3XQQy MnWGL5ryfXUv4OK5PVDmTXnT83WYaW0YUhlG+zFIUH+jHFzVTObzIUjq X-Received: by 2002:a05:600c:3b07:b0:486:af22:4a2a with SMTP id 5b1f17b1804b1-486febbc445mr162998115e9.7.1774263224820; Mon, 23 Mar 2026 03:53:44 -0700 (PDT) X-BeenThere: isar-users@googlegroups.com; h="AV1CL+H1FBMjFJ3GpTuE38XbHw26VM7HwIKdVLbGyRf0gI1m5g==" Received: by 2002:a05:600c:4f42:b0:485:f1d6:2b15 with SMTP id 5b1f17b1804b1-486f93a7e6dls33540385e9.1.-pod-prod-04-eu; Mon, 23 Mar 2026 03:53:42 -0700 (PDT) X-Received: by 2002:a05:600c:3b07:b0:485:3193:6ddb with SMTP id 5b1f17b1804b1-486febbc65emr162585925e9.3.1774263222493; Mon, 23 Mar 2026 03:53:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1774263222; cv=none; d=google.com; s=arc-20240605; b=WZAJYNHBTPcV0KgeBpJ/7p0UeiOe6uV2tw4xmuFpc0NZB2tX7fX1fjQHXC1yUozi2x 9fccKtZPivvWiF+AzXBvq0prPlUsCTZyTc1On+S3AyYhk5WIna6qkMQ4eZAttVx4hDJ7 d8OP1BtOGI+EBVku1R9Wkxo51NksPnJpOww/JEGvlLaKw2ZqsJ3JYhP9i+lfZWBnMhoe xCgQ86Gy+cwRmar0mW513GczSPvDYZ8nTx9ooJpEjRLbX+xYraFvpaksNlztru/05ojY KFLMtP9rSbdfpL6xIdandvq5U1JhXBXh5my2dOBDDom8N/Cj8SjNRL7fINs9ycJgommX 3iKA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=feedback-id:content-transfer-encoding:mime-version:references :in-reply-to:message-id:date:subject:to:from:dkim-signature; bh=bem2UvfQJxgxc4bTuU7Yg1BJpi8lDGJ5SOrRZvXIfwk=; fh=7tclEdh7YbwSQowgJ6LNq720O7H5HTEaqj22NJWRE2E=; b=IrwN4rw7mKoAgBfLcGgF9ze0BsQOXfyWgkzWgXxuD8YZO3hSQhXqpn0F9MoPctVNzo cFgOSoe5DUYAKQsWXFF3Y2RCQxfVEeqAgp1fFCIC7sNozbRe8ULvb0r8DJ4t4HOpsS0k xK4RM78ow+5/+5mDlUHgGejaoOYtZLGKcTmU44j3gSJ8++VgJlSJ9pu88BfK3/qVXUxo /qkNUr9ljQtA9aZ7i3cyZbO0mgKlxu47x3ugKVEdsDapRlb8luhWH5DtLDZV2CPXMv4Y 2okwJrbRzVTIme1LqW/I+hv+7r7vnA+WCXMCboYFtRRe5QAm3M2xuAiALQIikQmAkc4q Pwkw==; dara=google.com ARC-Authentication-Results: i=1; gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=fm1 header.b=B+2kFMFJ; spf=pass (google.com: domain of fm-51332-202603231053424c47bd1a5900020784-ofhexo@rts-flowmailer.siemens.com designates 185.136.64.227 as permitted sender) smtp.mailfrom=fm-51332-202603231053424c47bd1a5900020784-ofHeXO@rts-flowmailer.siemens.com; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com Received: from mta-64-227.siemens.flowmailer.net (mta-64-227.siemens.flowmailer.net. [185.136.64.227]) by gmr-mx.google.com with ESMTPS id 5b1f17b1804b1-486fe861d95si655545e9.1.2026.03.23.03.53.42 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Mon, 23 Mar 2026 03:53:42 -0700 (PDT) Received-SPF: pass (google.com: domain of fm-51332-202603231053424c47bd1a5900020784-ofhexo@rts-flowmailer.siemens.com designates 185.136.64.227 as permitted sender) client-ip=185.136.64.227; Received: by mta-64-227.siemens.flowmailer.net with ESMTPSA id 202603231053424c47bd1a5900020784 for ; Mon, 23 Mar 2026 11:53:42 +0100 X-Patchwork-Original-From: "'Quirin Gylstorff' via isar-users" From: Quirin Gylstorff To: isar-users@googlegroups.com Subject: [RFC PATCH 3/3] user_manual: add rust section Date: Mon, 23 Mar 2026 11:52:30 +0100 Message-ID: <20260323105332.2721282-4-Quirin.Gylstorff@siemens.com> In-Reply-To: <20260323105332.2721282-1-Quirin.Gylstorff@siemens.com> References: <20260323105332.2721282-1-Quirin.Gylstorff@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-51332:519-21489:flowmailer X-Original-Sender: quirin.gylstorff@siemens.com X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=fm1 header.b=B+2kFMFJ; spf=pass (google.com: domain of fm-51332-202603231053424c47bd1a5900020784-ofhexo@rts-flowmailer.siemens.com designates 185.136.64.227 as permitted sender) smtp.mailfrom=fm-51332-202603231053424c47bd1a5900020784-ofHeXO@rts-flowmailer.siemens.com; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com X-Original-From: Quirin Gylstorff Reply-To: Quirin Gylstorff Precedence: list Mailing-list: list isar-users@googlegroups.com; contact isar-users+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: isar-users@googlegroups.com X-Google-Group-Id: 914930254986 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , X-Spam-Status: No, score=-4.9 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,MAILING_LIST_MULTI, RCVD_IN_DNSWL_BLOCKED,RCVD_IN_MSPIKE_H2,RCVD_IN_RP_CERTIFIED, RCVD_IN_RP_RNBL,RCVD_IN_RP_SAFE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on shymkent.ilbers.de X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= From: Quirin Gylstorff Signed-off-by: Quirin Gylstorff --- doc/user_manual.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/doc/user_manual.md b/doc/user_manual.md index 7520854b..75f72355 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -20,6 +20,7 @@ Copyright (C) 2016-2019, ilbers GmbH - [Customize and configure image](#customize-and-configure-image) - [Create a Custom Image Recipe](#create-a-custom-image-recipe) - [Add a Custom Application](#add-a-custom-application) + - [Rust in ISAR Builds](#rust-in-isar-builds) - [Build statistics collection](#build-statistics-collection) - [Isar Cross-compilation](#isar-cross-compilation) - [Examining and debugging package generation inside their schroot rootfs](#examining-and-debugging-package-generation-inside-their-schroot-rootfs) @@ -1039,6 +1040,71 @@ be installed via `IMAGE_INSTALL`. Have a look at `prebuilt-deb`. --- +## Rust in ISAR Builds + +This is a collection of recipes and links on how to +package rust crates. + +This document takes most of its input from https://rust-team.pages.debian.net/book +which contains the practices of the Debian rust team. + +### Crates on crates.io + +We provide a generator in `scripts/generate_cargo_crate.sh` which +generates the scaffold for these crates. This follows more or less +the approach of Debian with https://salsa.debian.org/rust-team/debcargo-conf. + +The user steps necessary are the following: + +1. Generate the package by calling: +`scripts/generate_cargo_crate.sh [CRATE_VERSION]`. + +2. Patch to build with the current Debian release, e.g. relax the dependencies +in `Cargo.toml` + + +### Crates not on crates.io + +There is currently no generator and it is recommended to follow the traditional +packaging approach, see also https://rust-team.pages.debian.net/book/process-workspace.html#general-setup. + +A working rules file could look like this: +``` +#!/usr/bin/make -f + +export DEB_BUILD_MAINT_OPTIONS = hardening=+all +DPKG_EXPORT_BUILDFLAGS = 1 +include /usr/share/dpkg/default.mk +include /usr/share/rustc/architecture.mk +export DEB_HOST_RUST_TYPE +export PATH:=/usr/share/cargo/bin:$(PATH) +export CARGO=/usr/share/cargo/bin/cargo +export CARGO_HOME=$(CURDIR)/debian/cargo_home +export CARGO_REGISTRY=$(CURDIR)/debian/cargo_registry +export DEB_CARGO_CRATE=$(DEB_SOURCE)_$(DEB_VERSION_UPSTREAM) + +%: + dh $@ --buildsystem=cargo + +execute_after_dh_auto_clean: + $(CARGO) clean + rm -rf $(CARGO_HOME) + rm -rf $(CARGO_REGISTRY) + rm -f debian/cargo-checksum.json + +execute_before_dh_auto_configure: + $(CARGO) prepare-debian $(CARGO_REGISTRY) --link-from-system + rm -f Cargo.lock + touch debian/cargo-checksum.json + +``` +This example works for a cargo application and cannot be reused by other components +as the file `debian/cargo-checksum.json` is empty. + +An example for the initial cargo crate can be found at `meta-isar/recipes-app/rust-hello-isar/`. + +--- + ## Build statistics collection While isar is building the system, build statistics is collected in