From patchwork Fri Aug 23 09:58:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Storm, Christian" X-Patchwork-Id: 1975984 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=googlegroups.com header.i=@googlegroups.com header.a=rsa-sha256 header.s=20230601 header.b=GqUCCrnA; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=googlegroups.com (client-ip=2607:f8b0:4864:20::438; helo=mail-pf1-x438.google.com; envelope-from=swupdate+bncbdd6bwv65qpbbwv2ug3amgqewvecera@googlegroups.com; receiver=patchwork.ozlabs.org) Received: from mail-pf1-x438.google.com (mail-pf1-x438.google.com [IPv6:2607:f8b0:4864:20::438]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4WqwWf2H6jz1yNr for ; Fri, 23 Aug 2024 19:58:54 +1000 (AEST) Received: by mail-pf1-x438.google.com with SMTP id d2e1a72fcca58-7144c67e3d0sf277988b3a.0 for ; Fri, 23 Aug 2024 02:58:54 -0700 (PDT) ARC-Seal: i=3; a=rsa-sha256; t=1724407131; cv=pass; d=google.com; s=arc-20160816; b=xOFQF+KhQn+xMidxwE6Z1NgxYiD3ylLMwKB+R9rWrrnMKH9MeKJv8/cf67TyT0wA3P KIYOoKJDce+xT9bdQwNJrWvQiD8Tm7uWoWI9LdAAJLpLTh7Qzzz4lz09KovYuP7qfWqM sggrR6Jub4dUn0bwxgO0pkuleaOIay5/jd11q5a8kTedj2ue4eEbsYp6M9kXjR/CvCCr tCKESLL0x3+gXj5KwEI847NL9B3uowGvgatX3JFTMxLg4mohANbb0IgcK65+X42nxukN hLluviHSgPBud4N5mNdPCfWl38q4cR7WdD60eSCnxH/COtQqyF2qkNXDRnCK2kioz0SD yfNw== ARC-Message-Signature: i=3; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:reply-to:mime-version:content-id :content-language:accept-language:message-id:date:thread-index :thread-topic:subject:to:from:dkim-signature; bh=CZN+1DmWIFgVsXPlBXni67CqciiY3Yzqpd580lnNCNA=; fh=gBSA/TsJMouikI4NFpcALHUwUlGF+CxkaPUxzlkmMGY=; b=vhSMRjUdaqm5kewV7rHwBuEf9t3tYE9DoK+fe7DlyBWfhdwHjCaocYIZVB1wTykHz5 ZRVYSsU/m3C54u1asRpOhSir3bG1hYv/IZKclJrxUkCbVroYAmIBllXJ2C/tBovIr8zn 7EQzfEu4PvoCbv6OxfH89rsxuyhyAqZexLebj7qrgk/OL8XH8Zbf2Uh2B1UgcDpG0VwW l4wKuLJZrWLcSKZd3cld+5ud2BqsOKg2LiX+NEPU2IDBE//cV7pRTYNEfKO8pO1PU7gU 6pKCLKeAazMofwTmMLMUUNHbvT+Uftx2+UmjBvfN2qoqApJtzoosDO+Xje+1DhYmDHoh F6wQ==; darn=patchwork.ozlabs.org ARC-Authentication-Results: i=3; gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=selector2 header.b=TWlYJJ3C; arc=pass (i=1 spf=pass spfdomain=siemens.com dkim=pass dkdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of christian.storm@siemens.com designates 2a01:111:f400:7e1a::601 as permitted sender) smtp.mailfrom=christian.storm@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=20230601; t=1724407131; x=1725011931; darn=patchwork.ozlabs.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:mime-version :content-id:content-language:accept-language:message-id:date :thread-index:thread-topic:subject:to:from:from:to:cc:subject:date :message-id:reply-to; bh=CZN+1DmWIFgVsXPlBXni67CqciiY3Yzqpd580lnNCNA=; b=GqUCCrnA6sBFu9UYsfrrF9TSNVCHXbWEhzyvAi2ZUiQgq1zW+1pXzACg1O+Us1BG1D dobayjxvgyWikdu6yrB6qDMk2N5H2DsO6ptitQTjppvGC8JkpCUu9I9JeLejd1ap0rS5 anOM5XCbY2ftu15Pvi+aYGWXgndxBRaT6bJjvyNSBN8ck6iDLoMmBtlAxYNoknzfV0st TUmkPYykVHrsJ8DiLFbi+yhG/hHAHu3wCUrXuDYNfClEnO0sLvwFa2H32PWVkDvbtMRe I3aOfD+UM9O4h9Uvc/RoQ0ODcCYwvnmrnvVN5A/Z+3InC4dp4otVr+wc/gZDtWuzE96f 91TQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1724407131; x=1725011931; 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:mime-version :content-id:content-language:accept-language:message-id:date :thread-index:thread-topic:subject:to:from:x-beenthere :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=CZN+1DmWIFgVsXPlBXni67CqciiY3Yzqpd580lnNCNA=; b=w/uVr3U3/3Ru6zz4RhD7d4zhOo6juC9f96jm8nkaedulmQzdtrsEaNrllWa9ZMemkY pxAh9uSb2YqAVL3IpoidI1GFXq6P/RAV1R14h9pMnYFj7ZiXQ6ii721N7kGRg3pvJiNX Iays5pEMcrba3sCX67VKT2Rzl+YQh4tZ3uCQdDNdydXYPcSblQ+v7ttLyhdthpM2LUOe io65JkEsPY7YMeMLeTxmzEmyLbqLR58DEmIH6FMNzJLdutplyxprcdjYsX20ON3iCfvt y+NSHjHLZtP4D4nstrcKyRApJJM1GWDsnBj9qSoixkcirsTn/MXFj2WY4Ac+/04fZnYC GpZQ== X-Forwarded-Encrypted: i=3; AJvYcCUawg1kSagEBis58RROt2wx8CYiEL1A8GLgLUEJFuXg8+kxhpB52G/oZi4bdXayE2NHaRUSQUT9ew==@patchwork.ozlabs.org X-Gm-Message-State: AOJu0YzwIS0yjhejrNEFFXfVM4B9HeXeQyb1Zszhc6obgO7BTSTR2Ehq yLYjpPdOvMOr+e6VY0EKDLn5zUcxxAKKuPwFf4W/AckWPRSVrhps X-Google-Smtp-Source: AGHT+IEgnmLnxY1MFUGyXO5KboSai4ddcWXhNMnC7mEbKUyBkY04bD4kw7oeDWGeQbMzOf2XUsUCOw== X-Received: by 2002:a05:6a00:2383:b0:706:3329:5533 with SMTP id d2e1a72fcca58-7144587f44fmr2321269b3a.24.1724407130929; Fri, 23 Aug 2024 02:58:50 -0700 (PDT) X-BeenThere: swupdate@googlegroups.com Received: by 2002:a05:6a00:999:b0:714:2ca8:49d4 with SMTP id d2e1a72fcca58-7143339f789ls1874153b3a.2.-pod-prod-07-us; Fri, 23 Aug 2024 02:58:49 -0700 (PDT) X-Received: by 2002:a05:6a00:9499:b0:70d:2fb5:f997 with SMTP id d2e1a72fcca58-714457e0f3fmr1853598b3a.16.1724407129116; Fri, 23 Aug 2024 02:58:49 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1724407129; cv=pass; d=google.com; s=arc-20160816; b=f0/NyAjrYougQxlzNQcCIoWckuxsqjnbGxO946jcl1eTEgTCSU+hMubPqdd6lJIuHP O+/kAwdtzrhBPeWp50ozfkHm5LQGtx/LLBUesgzUwOrklxsO8cArB97mHXBQ5A51avU6 kvnsbWr76hz/gphbvEqd+rkO+Dng9oQ3chR6igQdo/TuoYUOsw/ZeRXOAEF3+nct9ysy O7EoZNCfncEz46hUDWDyMoi9rBuiEZMJV9IlTpciF3S1LiwH8NUScBa9Xd9O2e9n5AfP ElrcAZFM2rc/TQqWLxFbaZ6ipjZA0QBwXGUTMxRvpyD02a6kNYidCEYQOPgUQv75dc+k bIYw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=mime-version:content-transfer-encoding:content-id:content-language :accept-language:message-id:date:thread-index:thread-topic:subject :to:from:dkim-signature; bh=WDqq56g+oFQMdKnsIpihKYWjySyBIMXJAqDTTJWy5w4=; fh=ZnR/GV7fAozRX3tpIO3vp/Jbul8ISZhdVjghlw9eWq0=; b=f48pEWickej306ZjuJmOuSuXXhCcXum3ueoqorHfa9qfkn36dVtdkZ+QxtPG+7NIln fWMTdykjRuGlrlPMazzUf81fZDkhyp9RZ1AIH7B+kLK8EiAu2iU4ZpkeEPZyL8/dAQR1 gtHiC9aBUsj4y4GWf+NgqKxbm5FaZ4GgVrGmDlPObXXcl8llGPLMVkf6o2PmAsnKsaeA j3YWez3wLhqwZdWV0OJFYWV3Agrj1K2ci92ERefdLyTQeFP51eqKRdkTYBYcCjjxqMgH DjnQQiF9OmOgGCV2Fr1WjLH5mc9v98TPE4r0bKQmhIkQap2S1gLVI8nPB01p8lWApCJx BaEg==; dara=google.com ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=selector2 header.b=TWlYJJ3C; arc=pass (i=1 spf=pass spfdomain=siemens.com dkim=pass dkdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of christian.storm@siemens.com designates 2a01:111:f400:7e1a::601 as permitted sender) smtp.mailfrom=christian.storm@siemens.com; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com Received: from EUR05-DB8-obe.outbound.protection.outlook.com (mail-db8eur05on20601.outbound.protection.outlook.com. [2a01:111:f400:7e1a::601]) by gmr-mx.google.com with ESMTPS id d2e1a72fcca58-714340ed19fsi148474b3a.0.2024.08.23.02.58.48 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Fri, 23 Aug 2024 02:58:48 -0700 (PDT) Received-SPF: pass (google.com: domain of christian.storm@siemens.com designates 2a01:111:f400:7e1a::601 as permitted sender) client-ip=2a01:111:f400:7e1a::601; ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=s0XgLD6GiTalm0Og6lmKOZ9fzyBrCbaYwTn5Zk0+X1Z952B9q/xcQwkF0nXdokJxkIp8xnIcoC/V2YUmkIoZVWOYhdCyD2Zg1Iednn0zTr0yOgXIWqvqElI1KRLjoZLfLBG1dHZKWBcQKBtnmL8otwDSZjCyCOU7auT+jwX1qiHuQVDxi/AdnI/TBixUNYZ1ZtDRE9XyG67vdvQwh3QT8BnEKRJeU19aRs0m0MVc0T2x/UQ+LbOsT9K38OmIYZEKdzP6BH1ECnGJsFEceo4THvcqbAAPEiV5rxEJlIYhOO85citt0P2c+3EZZ0l/FQocIpvGAS7JhITtW18SElMsdQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=WDqq56g+oFQMdKnsIpihKYWjySyBIMXJAqDTTJWy5w4=; b=bXazW+a4FMI3ddKg0GFQOXCuEnx6RYEVnqepWBqSoXUx4T8pdmE835/SbhK8rIIrHRNeZb/NyG4TVrjSsXT5lv8I9JJm8eRlbsPbtbzcZITDQ47pu79AB/Ndx2+4mkl6MmyfUKovaX4i9/Sb/yN2v1QFoh0T6tqCv6g2iXgfSjyph2xhMoairDvzq2oFaRkPaEHUv3irXq3BqHe0IobiS6rpF65Ds6Rqg6EOvwYacZu5b8k8rJapjzj71srsKIGqBPF/F4UA7xNlwuLRnE258p90Q3lpCAygg41Zk+5FnhDWnZGVubf+tIlAFq1hmReEi7QLhi7t4lVYiQEbAk/rXg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=siemens.com; dmarc=pass action=none header.from=siemens.com; dkim=pass header.d=siemens.com; arc=none Received: from DB9PR10MB5404.EURPRD10.PROD.OUTLOOK.COM (2603:10a6:10:333::17) by DB9PR10MB7363.EURPRD10.PROD.OUTLOOK.COM (2603:10a6:10:45d::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7897.16; Fri, 23 Aug 2024 09:58:46 +0000 Received: from DB9PR10MB5404.EURPRD10.PROD.OUTLOOK.COM ([fe80::e659:e46:3b99:a440]) by DB9PR10MB5404.EURPRD10.PROD.OUTLOOK.COM ([fe80::e659:e46:3b99:a440%3]) with mapi id 15.20.7875.019; Fri, 23 Aug 2024 09:58:46 +0000 X-Patchwork-Original-From: "'Storm, Christian' via swupdate" From: "Storm, Christian" To: swupdate Subject: [swupdate] [PATCH] doc: Improve configuration & build section Thread-Topic: [PATCH] doc: Improve configuration & build section Thread-Index: AQHa9UML0itN7Z5aBkiyAp/rlK2KCQ== Date: Fri, 23 Aug 2024 09:58:46 +0000 Message-ID: Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ms-publictraffictype: Email x-ms-traffictypediagnostic: DB9PR10MB5404:EE_|DB9PR10MB7363:EE_ x-ms-office365-filtering-correlation-id: 62857a7d-b68e-440b-815b-08dcc35a2dd8 x-ms-exchange-atpmessageproperties: SA x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0;ARA:13230040|366016|376014|1800799024|38070700018; x-microsoft-antispam-message-info: Wr+OsYcawatLRIJjdKUU36zx7eytIDVEEuHKOyp4duRDJqtN3LJtl6gNKFO5uK8NO48AI2AE9oEcG8WdlaUMYiLvXfVcoWKiNj5ejFOGHpPXroo0cbPUFPMq+1SNom9f97rtPxsb8JynL10hzDW4WQ7IoQQ8raveZveDEIL+majLKlJkRsOUnBG5segLCaqLzRJCz6h6+PxzrL7hpHn2JX6ckfAXs5mT9C8hwNxblkBebgbb8NPjrfFV3x3J8WgUCR+loMfPF0D1wwrs5/ij/4BzgKZW+l9XBrP9TT95WfcZJjTy66iopp1OHc86i6v66hQ2XO5xCHFz8uAQTgXgVKeP2DSkL7CMkQVvQqKg7B0chWF8m+kfFVA6JrW+UpeFO1rUsDSDtuvZDaLiE+cPQFZUqzqRJJomyUMyc26YSe+EfGuEzJe5wBymvEH36i1BwlHQoZZTrB2wRIK++g7maS7htROlM2q8qJV4UQoSOnFjTvf0bywbJp4aJ7qgbV6ikDLD5k8QOo4o31EhqRj8Eo/yXa2n81vxVYC0IF0l/nyrWoWzTLooZl+O0wuFhovyGJHt27ybK3le+OWdnvmMDVWGF4TVUeQyQVqG8RbtQlSgK+fUAkYBA6RM0A48gRGca71+kUcIcHhWDuL14rsVWa802Dy8rBEeF0a+FtGqTJdtH7rkbkHDMe8qr1x4FeM9yso0uX2xKS8tD958Y8hoNKKaG7dremK769Ntw4sCLZzH5iBs7S/TBx2BpIuJCZK31BjAlseIOcydSs6OwU5zzI187ISMrGVyeZGuwbpHdEbwiEaL/UrODxSPmp3rA5w8J4hVFcv7w6tqPPHUKN4++6D2vSy+ugjGYNWwvw1GusK/SjI3dAG+LVXHAbFOjkGHF8F4xDpDbGZQu9AFpSeHY+/QNozP4xyACkciGZmjSIdZcCITAnBMpbiBWdy+dSI+ZkjivZI8zbd+PZFg+woHBO9ESautDx9UDOvTUvcQab8BITp34ancMmj0kCdV47a87S8Z5ZQU3xlrp5VqR4KQUQS97Vzxr6Si+BqTrMLGNxXmYAlBbWAkj3L+IYKjNltjmlH4FGQTzbgeBsQA+9ArUb9vxwlo/g9VacYLXJg4TbVoIho+YJO0GGZfjc5jYmCZ6KmPSwvIjd0p2V2SgxQfVQqpZA1pw7Nye8nUo9V1L4OYt++8Mk/7vNiChqsFI9ZOWDfPceO5VCDst34MkNVDX3D6rT658J91aNyY57MdCZ03mj3+Q0lx9Y4iFaT7bBgCCFPFmL2SAk+WTcA6GCZrifmWZWTGkDIYIqQJR296fixkmwch01YLAOg+1OYQvbx4MKqpW7o4g/7zXkQnIjv+uP7YZVsfHGn68i3it043BAc= x-forefront-antispam-report: CIP:255.255.255.255;CTRY:;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:DB9PR10MB5404.EURPRD10.PROD.OUTLOOK.COM;PTR:;CAT:NONE;SFS:(13230040)(366016)(376014)(1800799024)(38070700018);DIR:OUT;SFP:1101; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: wGJ1VzQExyNQPtkPgLzZeoufXOJhDkeGsZx4Ioqnzf6vNTwG7b1xwOrZ42PS87ZWiJu5L8Hvl3/NkjdyPisVDPvJDAKd0OCbMfy1wfV+091i5ZguenWYtqt+5HIy9cNIqUMOCPsf8Hxdz2UIZJS6CShdAsA6593bbxFX28y89cOuMDACjJFF9pjfz6Y7bl3vSrhlCyWfaGB1yUG+l1jKJA52DlcU6e8NXg+JH3FPfNux7x/dYmuWuYOwM2eqmC3rvL4aEe960qZ9pukpJX1apDa/eDBszHjV2JmgCILc2FhQ8Xy5CO4Rz0d5xvjEFh4ZbWgkneQ9Pw6nNLZ9C20xorPwtXZWaqqVjCjRwnq/KDKeen6tPGpmdXeYi3ifSt9kA6hf4pjg2d2+vyO84PW+wDqgnEcMmbjXDXvrUGxmCwgGASe+dy95aYrWau7kYmxTbJytN32UTejURJ9Tsxhq7yKk1bH0mHBQVEw/jfL8saA0A7YaHKG9qcDfOWg/6hoBJurPclirJsJYrLJbKEZXyIyHqSK00cPR/YN0iNYRMSMn6hNa6/SzR5MHcy9iBMICoG2LOwSU+RX2QHq9hzTU5oZnYFz/AkC18ns5rWNZYi995LXdMcLNgIL8VHikfdAspLcv7WTCtar3R6lRLLgjVc5iVMMPMASpNqBMOhfFHf3GhBZw+gMUMKXpXh0AX8zn02cr04LQgZJcDAXwrbFc/kDCridtW0ABogwMbe4omZRpy8mwvu6YsESF4muijC1noucs5pqqKgxbFJpsoTiq/K+lOZ05TLcezWi0lCCnr8aHOt10IFb/7jbp5F6fVgDJC74ZmIQ/6U2Wmlo7vsLOQHAlCz7Xb++IkVfrucMybWtu/94Kmlx8AKjBS0v1nV/lbIw3yxbcLzxGLvfmIimDaKGFZ5OtfwLlPIMZuHxr2XEU9cPKZ1eMMoOe934UlsCOePwlqbTjQRITE5W3YE1SGnaFLfIS84SxqTFShsIknyFCq5z0e49XAmGPh9czGN4hR+X5x7HfovvnrYyEBSU4sG02mvF39dEYYNPPJlcZ1zZJSNOvBo3gt3JjXI3z+HAAn+E8+eGcv52//U5mYgsvH0NB9LQIcwMdyu+ogsy3MshiuNDD4Q0unljuDomo5ZGvwTZ4b5ZduwvBodicPaU2NYtcf8e+TlzYAshRNbL2GCPeSQLQYivityZY6qAGEmRIhqdHvn7RRgtJLVbgf+Rmdysgv/USVpDjT4lbiOkE1QiGAsfCagN7i/YMtXnecr7CQVe3nz9nlq0nrssgw1eyqgdMT1YEzbT047kqvSzIkA7lwSSH2Jxi5WLpyXzEEziufkTgjqH5Q2nshXAyukBfmK075o4u0YEsgFNWzHZOF3dH7kt7axqJcPvV3cY3/cI4yalbOU+CBjY3hjv4v+cCno0vLWw3G1fhoeVT5zG6C7fch5y5+fz3Psi7eLEHq+DCwBAvD9OQbuYu7xIoU1c4SGlLqomFvKHF1jdZLhO3oraxLJP12zmgUu4JGUV8jvb6zXbtHWtthT/V3rho9o13YEmImjcMU2SUgYFFsgfvnkSLI9eyzvrO5RDAaX5NjCo6TnMCcug9fwZ6hNYkjylMng== Content-ID: <2EFFB0100AAF25458BFE40C9A26ABAB2@EURPRD10.PROD.OUTLOOK.COM> MIME-Version: 1.0 X-OriginatorOrg: siemens.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DB9PR10MB5404.EURPRD10.PROD.OUTLOOK.COM X-MS-Exchange-CrossTenant-Network-Message-Id: 62857a7d-b68e-440b-815b-08dcc35a2dd8 X-MS-Exchange-CrossTenant-originalarrivaltime: 23 Aug 2024 09:58:46.3312 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 38ae3bcd-9579-4fd4-adda-b42e1495d55a X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: ytKnjEdqFgnAbXb7CIzpLraFfq3oriDJoav+Z2iqlqOx3JuAaNfSlR9In3KVJBtrkkwSBEdLF1qnrSPOa6ViudprSUSWPmVn/EdE2AjJaKI= X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB9PR10MB7363 X-Original-Sender: christian.storm@siemens.com X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=selector2 header.b=TWlYJJ3C; arc=pass (i=1 spf=pass spfdomain=siemens.com dkim=pass dkdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of christian.storm@siemens.com designates 2a01:111:f400:7e1a::601 as permitted sender) smtp.mailfrom=christian.storm@siemens.com; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com X-Original-From: "Storm, Christian" Reply-To: "Storm, Christian" Precedence: list Mailing-list: list swupdate@googlegroups.com; contact swupdate+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: swupdate@googlegroups.com X-Google-Group-Id: 605343134186 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , Clean up the requirements list as determined by allnoconfig. Reword the building process. Remove Yocto specifics as that's handled in a dedicated document. Signed-off-by: Christian Storm --- doc/source/swupdate.rst | 84 +++++++++++------------------------------ 1 file changed, 21 insertions(+), 63 deletions(-) diff --git a/doc/source/swupdate.rst b/doc/source/swupdate.rst index 38a16f14..87150711 100644 --- a/doc/source/swupdate.rst +++ b/doc/source/swupdate.rst @@ -204,42 +204,31 @@ copies. Not all handlers support to stream directly into the target. Streaming with zero-copy is enabled by setting the flag "installed-directly" in the description of the single image. -Configuration and build +Configuration and Build ======================= Requirements ------------ -There are only a few libraries that are required to compile SWUpdate. +There are only a few libraries strictly required to compile SWUpdate: -- mtd-utils: internally, mtd-utils generates libmtd and libubi. - They are commonly not exported and not installed, but they are - linked by SWUpdate to reuse the same functions for upgrading - MTD and UBI volumes. -- openssl / wolfssl / mbedtls (optional) for cryptographic operations -- p11-kit & wolfssl (optional) for PKCS#11 support -- Lua: liblua and the development headers. -- libz is always linked. -- libconfig (optional) for the default parser -- libarchive (optional) for archive handler -- librsync (optional) for support to apply rdiff patches -- libjson (optional) for JSON parser and hawkBit -- libubootenv (optional) if support for U-Boot is enabled -- libebgenv (optional) if support for EFI Boot Guard is enabled -- libcurl used to communicate with network +- ``zlib`` (https://www.zlib.net) +- ``libubootenv`` for U-Boot environment support + (https://github.com/sbabic/libubootenv) +- ``json-c`` for parsing JSON + (https://github.com/json-c/json-c) -New handlers can add some other libraries to the requirement list - -check if you need all handlers in case you get build errors, -and drop what you do not need. +Further library dependencies may be required when activating more +SWUpdate features, see the next section on `Configuring SWUpdate`_. Configuring SWUpdate -------------------- -SWUpdate is configurable via "make menuconfig". The small footprint -is reached using the internal parser and disabling the web server. -Any option has a small help describing its usage. In the default -configuration, many options are already activated. +SWUpdate is configurable via ``make menuconfig``. A small footprint +is realized, e.g., by using the internal parser and disabling the +web server. Every option has a small help describing its usage. +In the default configuration, many options are already activated. To configure the options: @@ -250,50 +239,19 @@ To configure the options: Building -------- -- to cross-compile, set the CC and CXX variables before running make. - It is also possible to set the cross-compiler prefix as option with - make menuconfig. -- generate the code +To cross-compile, set the ``CC`` and ``CXX`` variables before running make. +It is also possible to set the cross-compiler prefix as option with +``make menuconfig``. Then, generate the code by running :: make -The result is the binary "swupdate". A second binary "progress" is built, -but it is not strictly required. It is an example how to build your -own interface to SWUpdate to show a progress bar or whatever you want on your -HMI. The example simply prints on the console the current status of the update. - -In the Yocto buildsystem,: - -:: - - bitbake swupdate - -This will build the package - -:: - - bitbake swupdate-image - -This builds a rescue image. The result is a Ramdisk that -can be loaded directly by the bootloader. -To use SWUpdate in the double-copy mode, put the package -swupdate into your rootfs. Check your image recipe, and -simply add it to the list of the installed packages. - -For example, if we want to add it to the standard "core-image-full-cmdline" -image, we can add a *recipes-extended/images/core-image-full-cmdline.bbappend* - -:: - - IMAGE_INSTALL += " \ - swupdate \ - swupdate-www \ - " - -swupdate-www is the package with the website, that you can customize with -your own logo, template ans style. +The result is the binary ``swupdate``. Notably, the ``tools/swupdate-progress`` +binary is built as well. It is an example of how to build your own interface to +SWUpdate to, e.g., show a progress bar on an HMI. This example simply prints on +the console the current status of the update and, more importantly, reboots the +machine after successful installation. Building with Yocto -------------------