From patchwork Thu Apr 14 22:56:17 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Schmidt, Adriaan" X-Patchwork-Id: 1691 Return-Path: Received: from shymkent.ilbers.de ([unix socket]) by shymkent (Cyrus 2.5.10-Debian-2.5.10-3) with LMTPA; Fri, 15 Apr 2022 08:56:46 +0200 X-Sieve: CMU Sieve 2.4 Received: from mail-wm1-f60.google.com (mail-wm1-f60.google.com [209.85.128.60]) by shymkent.ilbers.de (8.15.2/8.15.2/Debian-8) with ESMTPS id 23F6ujKS010367 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT) for ; Fri, 15 Apr 2022 08:56:46 +0200 Received: by mail-wm1-f60.google.com with SMTP id c125-20020a1c3583000000b0038e3f6e871asf3526256wma.8 for ; Thu, 14 Apr 2022 23:56:45 -0700 (PDT) ARC-Seal: i=3; a=rsa-sha256; t=1650005800; cv=pass; d=google.com; s=arc-20160816; b=DwZLrMKjoPcTEa4GvRV6eOAdE6BeixbX/SXsI618IQFW8SaaAeUqSh5szxkZDbHIDZ GRhg371OKjb06hkHC/TxI68D/vrR2NJRHYvKHIuOnnr0Zlrig7HcHuF1DlKumSavVzyE 1a/kdQqVRh6a4MId1h2JHcFQVCZHbNT5SUwrA/czcK50rZht2t3rBMWqvCiyY6XEKHeC D+AufOmtjCXLl+SGOi91pOpWGtJXTaJK13c41lXwcSBT6MVuuznac0Bxx4Zpn5qMIz/i B9ITzfYAWni1iAvSD6motlcg7Rj7U2M6ItlLRlky3oE1crHKpDmUPCfIAOviSq3JPQ4T DNXA== 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:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:sender:dkim-signature; bh=fSZg1bylQDPawSEVSzhZ0OvUjAeDZhrJjeC+FfO8SFk=; b=acM1hCORA3ffLZdG36yskuT+ethR8QcSdAFAUXqryuhCppduC5oZ1apWs+1QSbEIQW AJn70fXhycI7r2SgCY4w6eoAGTyxFvOuF0P+DnzDeZJc8fvOnqRsL/38f9edOX/sj9L3 wKKlmofqitO/wDo7fog0M4FwZLYFP+SMF4mElOnwnrdcqusa2HJ933kphYyNnk6nxLV/ ZcKX2pUFtzRQQKYb8AHzQ6ng8miyA0T4tkrecIUSmLOJWro/ige0Dlt3rPu9c9/FU5De UkopEbGNlY1aXYMeWDtD5w0SC0JQuMcCkwrqDwibjUHlzohzk9nvlSXwkOJdSaA8oHsF 2Gfg== ARC-Authentication-Results: i=3; gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=selector2 header.b=Y63WZxLr; arc=pass (i=1 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of adriaan.schmidt@siemens.com designates 2a01:111:f400:7e1a::611 as permitted sender) smtp.mailfrom=adriaan.schmidt@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20210112; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:x-original-sender:x-original-authentication-results :precedence:mailing-list:list-id:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=fSZg1bylQDPawSEVSzhZ0OvUjAeDZhrJjeC+FfO8SFk=; b=Q+9c/r5U3hMCbW+31TPaf6FPg2FPTwLbRTzrZCoBNfyw2PYGqNnBvbse3AbAylkXHC dYO3fjYmQCCujbq7op2M7OfFcjbdaq9JzbXFF4B9dWIdbSlgdcHrmm95+xUv5b+oHTu0 FD7tpA6oAZnIm4654peWT8eMqKW71ep5ELBWePZQXLUGVfHofL+9rZz5kPcWuLeSLuvh NgItUGdLhCbpYTOFiJBzYBEETcMi2EWsCApbNXII7XtrQdmhg9/n9emi/mLm24s7Lmox 5ekHTfCOX7GGNtDAstCSW3R6mrC+r7KbsawB4DSk/zYNmTD87oyWvwqWIq/i7KgJrNlg FAcg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=sender:x-gm-message-state:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :x-spam-checked-in-group:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=fSZg1bylQDPawSEVSzhZ0OvUjAeDZhrJjeC+FfO8SFk=; b=6x9DPiupm0IrkT3BOKO3VrsCjrmlsJojY4cIfeasmDB+vjrA2Qbupy7P/vPqQ0vZ+a n5A5mRunY9KWd07TduLc+ElYYD6CpZhTRl4BRyKGKOnTdVaFnhCAQdcZXSDU0cwtCd4O KM6j9z/8NuVF3G0G3lici7QKxS8qj5ntWQxRJU5h2YZA5XAhfSfOwqcoYWA5PIuMgWHv SbA24CF+dt3d1FABv1FH3978lgdKOWgHsB5XVXFIBh5NgdBSx8863DV9KqdlPC9+6sky Y5xDHtT1jbqDN9633CV2BMDjCX6+AyDc0xatnwwza2WuZUQCiPlaYUYeV2vyuaCe8LRz ACeA== Sender: isar-users@googlegroups.com X-Gm-Message-State: AOAM532qJ7BgonQOCckgnhj3/NTfYrCXi+J4MDrRHpIP9QTSyiLKS7EE J3pbZS7h5v8gzu+WsDQT54A= X-Google-Smtp-Source: ABdhPJylkWyIPQe+gX2/x8mIRt6BweTpnwguL2eoErHn9ULQrlT4tGpe4l34ml9Z5aNn8BbwnwO21Q== X-Received: by 2002:a1c:4d04:0:b0:38e:bb87:89ca with SMTP id o4-20020a1c4d04000000b0038ebb8789camr1975346wmh.129.1650005800602; Thu, 14 Apr 2022 23:56:40 -0700 (PDT) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a5d:4ccf:0:b0:207:a2b0:7a9 with SMTP id c15-20020a5d4ccf000000b00207a2b007a9ls397136wrt.2.gmail; Thu, 14 Apr 2022 23:56:39 -0700 (PDT) X-Received: by 2002:a05:6000:1c3:b0:207:9dba:1e67 with SMTP id t3-20020a05600001c300b002079dba1e67mr4624027wrx.53.1650005799668; Thu, 14 Apr 2022 23:56:39 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1650005799; cv=pass; d=google.com; s=arc-20160816; b=SOHeMNGC7NIHhBLnSmdlIOeJ9Cplp39zrloFeCNhAZlxgbn1IpkUW4dvQ2FGFHuQL4 dx6+XnkloThJ+KlmyvlnaTkJIah1xiqUD41zOZxSCWS8GfQoo2Qy4H4Jk4akjv+5eOyl mLSrDtycx/3X2YllvDeQ1Zw9Efk9oM9KR/xVWrQINHgdmvXRqYAehvcLCPJum8pizfpi mki68YP9INcEc/c7Gp48yUa5qeXVQ1j/cx/7k9XbGX+Umyi4/VqAvi0NPWsldkEBj+lj 6xwhFxBJW7XLLwxQ9qr/ZalPNqyBTu5grEYxZqmYRnaU+b6W1TUDkQX2ttVfZ5azknM/ 0u3w== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=LJNntfJ2gS1x+E69bo7kqemDAHnKIqDz3ORvQEyywb0=; b=SFZdgnlY0XKPyZNRDthXSXJpZjjxuyz10PTCCYkzMjkPKYtwi6+d4/mhonGmTOttiW E8gLkuebm9TSC/hh6YFbwLGHogvrq/bBlWgvK+0ToRRPbREUrrk59/JL1yNDLdjhZIQc lJAj8chnKtx8WBge8Fj2/Slxy82nrfzzah9TiqP3NEYkMX02AOkqZD0esZWyFCGXTWwY BNKNeEUVHCwR4litO49V+yYKaZs5SndMf0pud/54MJXrTkPgiFiY77c99a9uQf2dq/7f eK2XA5adqVDUBmmXQgdL0cJxqpU06YTc3BRz/4kKd/6kn+FO7IYurCLCGXWTY+jH8puQ J4MQ== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=selector2 header.b=Y63WZxLr; arc=pass (i=1 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of adriaan.schmidt@siemens.com designates 2a01:111:f400:7e1a::611 as permitted sender) smtp.mailfrom=adriaan.schmidt@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Received: from EUR05-DB8-obe.outbound.protection.outlook.com (mail-db8eur05on20611.outbound.protection.outlook.com. [2a01:111:f400:7e1a::611]) by gmr-mx.google.com with ESMTPS id o35-20020a05600c512300b0038cac42709csi225187wms.1.2022.04.14.23.56.39 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 14 Apr 2022 23:56:39 -0700 (PDT) Received-SPF: pass (google.com: domain of adriaan.schmidt@siemens.com designates 2a01:111:f400:7e1a::611 as permitted sender) client-ip=2a01:111:f400:7e1a::611; ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LQR7Y9KdxgZ5fHI/R0hTSR2/LYib4F3yEi5HRw2tEAFKcv/U28EbYXPiCYGofCRJrEx9RzHnslaJXt8UCOP9DZjPLHhNv6GMzJ5WOz3mv7CHKR1ojLm3+/S5CyioMW/XYp5NWO2Dx0k9FnbswSwKy/lb5NhaEDoytlUuTWRBNfq43Lbl3ZJ39sp9zzyA5DtuLPnRl/3Tif1mDMTc3M09m8WCU7sOKaUFRd5x5UqAr/nc8uyD2ecTLgTqN0RQMdzmTENJwFk2O7hIPt1QHTIasUfIqdR06itcqmUeCiobnozM9MuFM5wCGEIInFIhKVXNMTN5gdKr8w1W22rc+AAuEA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; 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=LJNntfJ2gS1x+E69bo7kqemDAHnKIqDz3ORvQEyywb0=; b=flhgQP1i2iKa4BF1bcgewzK0Ic2VT0R5Mv9icGwPYqNh21FBNsNmMj0JV6fi3ojF6kpmcXLbEidOT2Exx0N9w1TH/tmZRxWBxS4StY//J/xrIBj9a6gziXKRKTGobIwbiSUI5nrncRuBgxfY0KpVehEQSxkIIhkeyBN0T4Ie8Gy5qIT6/6KqEjclKHlac/9zitJQ3ih7Mo24ZSxXwtfiXtsFPeNL8884gF8WU5sGOiK0dEyn7MZ3XX1TC+xRV+DzDo3UmocxqIVlxuN58GGawdMKHP0laOoKGLnwKD0vkQJk9IIK/F8rBmLtrQA1lzf6da/g6chA2Xfm8bgQI2v8qA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 194.138.21.73) smtp.rcpttodomain=googlegroups.com smtp.mailfrom=siemens.com; dmarc=pass (p=none sp=none pct=100) action=none header.from=siemens.com; dkim=none (message not signed); arc=none Received: from SV0P279CA0040.NORP279.PROD.OUTLOOK.COM (2603:10a6:f10:13::9) by HE1PR1001MB1098.EURPRD10.PROD.OUTLOOK.COM (2603:10a6:3:6e::22) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5164.20; Fri, 15 Apr 2022 06:56:38 +0000 Received: from HE1EUR01FT048.eop-EUR01.prod.protection.outlook.com (2603:10a6:f10:13:cafe::a2) by SV0P279CA0040.outlook.office365.com (2603:10a6:f10:13::9) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.5164.19 via Frontend Transport; Fri, 15 Apr 2022 06:56:37 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 194.138.21.73) smtp.mailfrom=siemens.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=siemens.com; Received-SPF: Pass (protection.outlook.com: domain of siemens.com designates 194.138.21.73 as permitted sender) receiver=protection.outlook.com; client-ip=194.138.21.73; helo=hybrid.siemens.com; Received: from hybrid.siemens.com (194.138.21.73) by HE1EUR01FT048.mail.protection.outlook.com (10.152.1.17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.5164.19 via Frontend Transport; Fri, 15 Apr 2022 06:56:37 +0000 Received: from DEMCHDC89XA.ad011.siemens.net (139.25.226.103) by DEMCHDC9SNA.ad011.siemens.net (194.138.21.73) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.24; Fri, 15 Apr 2022 08:56:37 +0200 Received: from random.ppmd.siemens.net (139.25.68.25) by DEMCHDC89XA.ad011.siemens.net (139.25.226.103) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.24; Fri, 15 Apr 2022 08:56:36 +0200 From: Adriaan Schmidt To: CC: Adriaan Schmidt Subject: [PATCH v3 7/7] docs: add new imagetypes to user manual Date: Fri, 15 Apr 2022 08:56:17 +0200 Message-ID: <20220415065617.1910954-8-adriaan.schmidt@siemens.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220415065617.1910954-1-adriaan.schmidt@siemens.com> References: <20220415065617.1910954-1-adriaan.schmidt@siemens.com> MIME-Version: 1.0 X-Originating-IP: [139.25.68.25] X-ClientProxiedBy: DEMCHDC89XA.ad011.siemens.net (139.25.226.103) To DEMCHDC89XA.ad011.siemens.net (139.25.226.103) X-TM-AS-Product-Ver: SMEX-14.0.0.3080-8.6.1018-26680.007 X-TM-AS-Result: No-10--16.244900-8.000000 X-TMASE-MatchedRID: 4U5WdtFP0Q4QwVtkLIfLLbHs1wZTXKHBYlldA0POS1Jtdr9d0G+tOpho XhL48wE7eucl7MdNw8RlgPlELHsWWRyr9kofgD0FFR00oYoqDJafbxa3A1yTpzfu+RTlciXg/Md +OvVRT/kR34ro7k23nVBtcAz9x24SKWZyYRZycgtJ/2MFRNZuNR+X41oiFhcu6HuV1BUJYPNBJ1 CxuVkwjUtcaZvMECGy1Br5wWX7YQ2okitJmrFCuON7MovG9cvQ9eUjmTFKQ/T8OMEMU7OyZtPZW t1+42smTPm/MsQarwMBIoIumpW6V/4yf+7IYDgcsW3Cgu625dVTZyP+S3GVYH0OE02QLVC+WRYt BXVuRSVGMe+tDjQ3FnIin2hX71Kr5shPFSKOueR6p3UUV82FSRVdTj9tM44xggra2NOo2i3jLrH qvAiSy6lTFDGZMPhCixP77M1esQwZmf7ofP3gccKwBNRhxAkuxQuyWuTn6yqXfrypKnpvnre2wM m8sT5/E4klva9z5Jx6RaSpHJq/AA/hpPV0bNgBIvabuzhmQeCEtFE/+7XCuolSWYvdSPSYf3PPz 7C7ukZr9YiEX0WhNplA4IpB7gNOs8mgqR6m778aiTke3N9xUXdpFkj4BgGZCtzGvPCy/m68xE2H 2EuMWS5MlWghP7UmX46iGZTPpJ6qqsCwzad2bB6kX/VShDhejxn4v13MgUbB6S7ffS3eayLLJGC SgZKk4PdcWsl+C/MTUMg5euvPiXUbN++MZYTqFUGiMcidh6Px9/PgR0+rlp4CIKY/Hg3AGdQnQS TrKGPEQdG7H66TyOk/y0w7JiZo X-TM-AS-User-Approved-Sender: No X-TM-AS-User-Blocked-Sender: No X-TMASE-Result: 10--16.244900-8.000000 X-TMASE-Version: SMEX-14.0.0.3080-8.6.1018-26680.007 X-TM-SNTS-SMTP: 5B3344FE26509010C8A11A5180C0B79BA50621F9AE30A264F4775D148B49EB432000:8 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 8b2cf5ff-e743-4b26-41bf-08da1ead164d X-MS-TrafficTypeDiagnostic: HE1PR1001MB1098:EE_ X-Microsoft-Antispam-PRVS: X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: TuVoep9207heY9NraCuAPfd/VfFPrLwWGSmiRRwiXUcCUbH3oFmgHxnJYRW6wSz2mGS55c9FnL4f7VJbcMChcmdWKGXs9W26YZkA33dmaU7lGQ8HdGqN6kcjVb+q3TpOGwX+yyBk6kougv+mA04dpc6d0xBt6yCCTu3B6sZi134T/y+ouVNo8oiWH8d+3Xq9O7lV7Cq3NorHvK9eNbbkE1PWnf4TrP5Tn0Pd2gTRZH0GulQ2Cx5C+vVvyp04B2mEFosry1fpJ5saI0IQpmxvf8tmjrZyjWRJlU6vJVZR3gqXpIxSQjCx9KCFK8xcYiSa3rb5eNsdnBjrS/w96fvKdLQEZpOjYmyobhysoUQwr5cMxcYefz2zD7V+LSMN99hc4oDU4iuXCTH3VC0576d8pl0vnMCH3TnZEvTzef8vqZ52KfUK8pGFG2cfnjl4X1lIyPSjsKIKyuJuYNVlrVWfGRXPlh7qceoaC9tZy/fD2XqbHkR/qsv83nX/68cJe3bZ+nDGhUM/jKe2K88xLHbOcJorqBt6T6BBsEZrGOxOpMi80EyxbP0nU0NyHbJgLwy0qHLdmqVZ1uptocOIC62nqBjSg8Gn7g6d2b9P52G38RCI3G53Gzk8MEOjmfLJLonLMmqv+Y0Y4bnNBjyvAAgRneSCyo/BlLv7XqudLVHLIuokgB91m6kYO0jhNX4Uq5GONmG/aRrVlbRoC84udPs9KP889CfOKy83OHgnE7W/pEV9lQklQYzVxsCph5rRMnbpDjr9NitIC9+hUWeKqb+PFwr5Icj/ir2RcYYVUSpfK9voi5Ixwy3zUbtrqT+nQrWCvKQMfLAG5Vfk5B5SpyNStCCLe/V01okgz9Q/jHywAu4= X-Forefront-Antispam-Report: CIP:194.138.21.73; CTRY:DE; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:hybrid.siemens.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230001)(4636009)(36840700001)(46966006)(40470700004)(47076005)(6916009)(40460700003)(966005)(36860700001)(5660300002)(8936002)(86362001)(4326008)(498600001)(82310400005)(26005)(81166007)(356005)(8676002)(82960400001)(2906002)(70586007)(44832011)(16526019)(70206006)(6666004)(186003)(1076003)(36756003)(83380400001)(956004)(2616005)(107886003)(336012)(403724002)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: siemens.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Apr 2022 06:56:37.7902 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 8b2cf5ff-e743-4b26-41bf-08da1ead164d X-MS-Exchange-CrossTenant-Id: 38ae3bcd-9579-4fd4-adda-b42e1495d55a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=38ae3bcd-9579-4fd4-adda-b42e1495d55a; Ip=[194.138.21.73]; Helo=[hybrid.siemens.com] X-MS-Exchange-CrossTenant-AuthSource: HE1EUR01FT048.eop-EUR01.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR1001MB1098 X-Original-Sender: adriaan.schmidt@siemens.com X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@siemens.com header.s=selector2 header.b=Y63WZxLr; arc=pass (i=1 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of adriaan.schmidt@siemens.com designates 2a01:111:f400:7e1a::611 as permitted sender) smtp.mailfrom=adriaan.schmidt@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com 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=-0.9 required=5.0 tests=DKIMWL_WL_MED, DKIM_SIGNED, DKIM_VALID,DKIM_VALID_EF,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H2,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: INBOX Signed-off-by: Adriaan Schmidt --- doc/user_manual.md | 86 ++++++++++++++++++++++++++++------------------ 1 file changed, 53 insertions(+), 33 deletions(-) diff --git a/doc/user_manual.md b/doc/user_manual.md index b950ff7f..cdb73224 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -213,7 +213,7 @@ tmp/deploy/images/rpi/isar-image-base-raspbian-stretch-rpi.wic.img ### Generate full disk image -A bootable disk image is generated if `wic-img` is listed in IMAGE_FSTYPES. +A bootable disk image is generated if `wic` is listed in IMAGE_FSTYPES. Behind the scenes a tool called `wic` is used to assemble the images. It is controlled by a `.wks` file which you can choose with changing WKS_FILE. Some examples in the tree use that feature already. @@ -253,7 +253,8 @@ https://github.com/intel/bmap-tools ### Generate container image with root filesystem A runnable container image is generated if IMAGE_FSTYPES variable includes -'container-img'. +one of the supported container formats `oci`, `oci-archive`, `docker-archive`, +`docker-daemon`, or `containers-storage`. Getting a container image can be the main purpose of an Isar configuration, but not only. A container image created from an Isar configuration meant for bare-metal or @@ -261,10 +262,9 @@ virtual machines can be helpfull to test certain applications which requirements (e.g. libraries) can be easily resolved in a containerized environment. -Container images can be generated in different formats, selected with the -variable `CONTAINER_IMAGE_FORMATS`. One or more (whitespace separated) of following -options can be given: - - `docker-archive`: (default) an archive containing a Docker image that can +Container images can be generated in different formats. One or more (whitespace +separated) of following options can be given: + - `docker-archive`: an archive containing a Docker image that can be imported with [`docker load`](https://docs.docker.com/engine/reference/commandline/load) - `docker-daemon`: resulting container image is made available on the local Docker Daemon @@ -280,12 +280,6 @@ It's technically possible, but requires making host resources (e.g. the Docker Daemon socket) accessible in the container, which can endanger the stability and security of the host. -The resulting container image archives (only for `docker-archive` and -`oci-archive`) are made available as -`tmp/deploy/images/${MACHINE}/${DISTRO}-${DISTRO_ARCH}-${container_format}.tar.xz` -(being `container_format` each one of the formats specified in -`CONTAINER_IMAGE_FORMATS`). - ### Example - Make the relevant environment variables available to the task @@ -293,9 +287,8 @@ The resulting container image archives (only for `docker-archive` and For one-shot builds (use `local.conf` otherwise): ``` -export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE IMAGE_TYPE CONTAINER_IMAGE_FORMATS" -export IMAGE_FSTYPES="container-img" -export CONTAINER_IMAGE_FORMATS="docker-archive" +export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE IMAGE_FSTYPES" +export IMAGE_FSTYPES="docker-archive.xz" ``` - Trigger creation of container image from root filesystem @@ -307,7 +300,7 @@ bitbake mc:qemuarm-buster:isar-image-base - Load the container image into the Docker Daemon ``` -docker load -i build/tmp/deploy/images/qemuarm/isar-image-base-debian-buster-armhf-1.0-r0-docker-archive.tar.xz +docker load -i build/tmp/deploy/images/qemuarm/isar-image-base-debian-buster-armhf-1.0-r0.docker-archive.xz ``` - Run a container using the container image (following commands starting with @@ -460,10 +453,15 @@ Isar can generate various images types for specific machine. The type of the image to be generated may be specified through the `IMAGE_FSTYPES` variable. Currently, the following image types are provided: - - `ext4` - Raw ext4 filesystem image (default option for `qemuarm` machine). - - `wic-img` - A full disk image with user-specified partitions created and populated using the wic tool. - - `ubi-img` - A image for use on mtd nand partitions employing UBI - - `vm-img` - A image for use on VirtualBox or VMware + - `tar` - tarball of the root file system + - `cpio` - cpio archive + - `ext4` - raw ext4 filesystem image (default option for `qemuarm` machine) + - `wic` - full disk image with user-specified partitions created and populated using the wic tool + - `ubi` - image for use on mtd nand partitions employing UBI + - `ova` - Open Virtual Appliance: image for use on VirtualBox or VMware + +In addition, image types can be converted using suffixes, e.g. `tar.gz`. +Available conversions are `gz` and `xz`, which both provide image compression. There are several image types can be listed in `IMAGE_FSTYPES` divided by space. @@ -539,7 +537,7 @@ IMAGE_PREINSTALL = "linux-image-rpi-rpfv \ KERNEL_IMAGE = "vmlinuz-4.4.0-1-rpi" INITRD_IMAGE = "initrd.img-4.4.0-1-rpi" MACHINE_SERIAL = "ttyAMA0" -IMAGE_FSTYPES = "wic-img" +IMAGE_FSTYPES = "wic" WKS_FILE = "rpi-sdimg" ``` @@ -579,22 +577,44 @@ Every image type in Isar is implemented as a `bitbake` class. The goal of these ### Create Custom Image Type -As already mentioned, Isar uses `bitbake`to accomplish the work. The whole build process is a sequence of tasks. This sequence is generated using task dependencies, so the next task in chain requires completion of previous ones. -The last task of image recipe is `do_populate`, so the class that implement new image type should continue execution from this point. According to the BitBake syntax, this can be implemented as follows: +The following steps are required to implement a custom image type: Create a new class: ``` $ vim meta-user/classes/my-image.bbclass ``` -Add these lines: + +Specify the command to generate the new image, and optionally image type +dependencies or required arguments: ``` -do_my_image() { +IMAGE_TYPEDEPS_my_image = "ext4" +IMAGE_CMD_REQUIRED_ARGS_my_image = "MY_ARG" +IMAGE_CMD_my_image() { + INPUT="${PP_DEPLOY}/${IMAGE_FULLNAME}.ext4" + ${SUDO_CHROOT} my_command ${MY_ARG} -i ${INPUT} -o ${IMAGE_FILE_CHROOT} } -addtask my_image before do_build after do_populate ``` -The content of `do_my_image` function can be implemented either in shell or in Python. +The IMAGE_CMD is a shell function, and the environment has some pre-set +variables: + + - `IMAGE_FILE_HOST` and `IMAGE_FILE_CHROOT` are the paths of the output image + (including extension) in the host or buildchroot. + - `SUDO_CHROOT` is a prefix you can use to have a command run inside the + buildchroot. + +If the code you provide in `IMAGE_CMD` requires the building and/or installation +of additional packages in the buildchroot, you can specify this: +``` +IMAGER_BULID_DEPS_my_image = "my_command" +IMAGER_INSTALL_my_image = "my_command" +``` + +To use your custom image class, add it to `IMAGE_CLASSES` in your machine config: +``` +IMAGE_CLASSES += "my-image" +``` -In the machine configuration file, set the following: +And finally select the new image type: ``` IMAGE_FSTYPES = "my-image" ``` @@ -603,11 +623,11 @@ IMAGE_FSTYPES = "my-image" Isar contains additional image type classes that can be used as reference: - - `ext4-img` - - `targz-img` - - `ubifs-img` - - `ubi-img` - - `wic-img` + - `ext4` + - `tar.gz` + - `ubifs` + - `ubi` + - `wic` ---