From patchwork Wed Jan 31 12:39:04 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 38502 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3CE0AC47258 for ; Wed, 31 Jan 2024 12:39:37 +0000 (UTC) Received: from mail-wm1-f42.google.com (mail-wm1-f42.google.com [209.85.128.42]) by mx.groups.io with SMTP id smtpd.web11.12847.1706704768156841429 for ; Wed, 31 Jan 2024 04:39:28 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=Qy2PTiKe; spf=pass (domain: gmail.com, ip: 209.85.128.42, mailfrom: alex.kanavin@gmail.com) Received: by mail-wm1-f42.google.com with SMTP id 5b1f17b1804b1-40e9101b5f9so53546145e9.3 for ; Wed, 31 Jan 2024 04:39:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1706704766; x=1707309566; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=AmQGjY1te0AGqhInnPQPcrxg275ASE4XHxYII59HiYs=; b=Qy2PTiKezLY4gbQb4Z2E1bjaRg5ZCwzn1EGxrtHELG/Ge1dKOUn6cdD7tC//GN7YvJ gLs+5BL7pQT3cnfDh9xC54/SpdUMh2qYwtnJ2mMpNohPfFK9ULPFa/K9NVitHRHxO3GR jm7Uee8AA20rWeHvVG3lwdmruRJ6ONBJCHNyzgFcxotaOBvXtlTv7S3s7Ef5zWiXkXp8 CTsq71nRHiXk2hh4WQRJXLvRsMt272l7f6+3VCtsx9/EoSOVmMc40jvHUB1/j+oTsm7K ZTc3gE1c+e2yP06lXEtH1tovS3HqQTkJTC2y/5gZKGO7ZLoRNO6fBAO7qGu0RycUdWq8 RNJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706704766; x=1707309566; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=AmQGjY1te0AGqhInnPQPcrxg275ASE4XHxYII59HiYs=; b=H5KSiYsBLB7tWXtByLDOk2fFqMv2dCTOsAzBdPloAZgG62F778cUBcmyUpGNFPjn21 eNCKfKqhg16UpJWLBjVMbUZLogZxoBrb9BQuTypLheIfKgdqdFpjJtnvLxd+NiXg/RwI 9Ng7yWRvcNfxKuHmcibowv36QeEzT8PVAlXmrimsT3sLCCBzME0GDCmknJdp6zEExfp7 f/2Slnm1JDEPsvS2H/Lh0ij7lWGR3N/tviEwZhihC16cKh2mTt8YjeBnrLq+J2Ey/NNu WPkNCeQDi1x+fyn/2cZdC6FLrQx3b0zKN6Fr7gQYaSKR16qRvC64u0fvjt4/l3W3shec c2BA== X-Gm-Message-State: AOJu0Yw12YW7ajKfmCsayfFJweeLMrYxU6vYMBa1gO/Ebs+Ni0y3yf2/ xZvmwNhsgfjOlPxNBoEyBAvEU1CqyFg2+6kJ7ZPTfEKfRgJ1+GPQoRYi1/Ha X-Google-Smtp-Source: AGHT+IGcY5wE3KeMdzULcWf322Tvg2YL4Erk/I6X1y2SHHuG8FfBe8yhnTmFdAfU/dEnbhZHzmurfg== X-Received: by 2002:a05:600c:3504:b0:40e:aecc:25ac with SMTP id h4-20020a05600c350400b0040eaecc25acmr1100213wmq.30.1706704766468; Wed, 31 Jan 2024 04:39:26 -0800 (PST) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id ba1-20020a0560001c0100b0033ae593e830sm10898058wrb.23.2024.01.31.04.39.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jan 2024 04:39:26 -0800 (PST) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: openembedded-core@lists.openembedded.org Cc: Alexander Kanavin Subject: [PATCH 1/5] meta/conf/templates/default/conf-description.txt: add a template description Date: Wed, 31 Jan 2024 13:39:04 +0100 Message-Id: <20240131123908.1098544-1-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 31 Jan 2024 12:39:37 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/194519 Existing conf-notes.txt is not adequate in situations where the user needs to select a config template from several, or get an overview of them and is interested only in a brief explanation of what the template is for, but not extended multi-paragraph instructions for how to use it. Such descriptions can be provided via conf-description.txt and this patch adds such a description for the oe-core default template. Updates to the tools and a tool for selecting templates which will make specific use of the description will follow. Signed-off-by: Alexander Kanavin --- meta/conf/templates/default/conf-description.txt | 1 + 1 file changed, 1 insertion(+) create mode 100644 meta/conf/templates/default/conf-description.txt diff --git a/meta/conf/templates/default/conf-description.txt b/meta/conf/templates/default/conf-description.txt new file mode 100644 index 00000000000..e49172fa0ce --- /dev/null +++ b/meta/conf/templates/default/conf-description.txt @@ -0,0 +1 @@ +This is the default build configuration for the openembedded-core layer. From patchwork Wed Jan 31 12:39:05 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 38505 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5D38DC47DDF for ; Wed, 31 Jan 2024 12:39:37 +0000 (UTC) Received: from mail-wm1-f48.google.com (mail-wm1-f48.google.com [209.85.128.48]) by mx.groups.io with SMTP id smtpd.web11.12848.1706704768532298215 for ; Wed, 31 Jan 2024 04:39:28 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=CE9sVgVd; spf=pass (domain: gmail.com, ip: 209.85.128.48, mailfrom: alex.kanavin@gmail.com) Received: by mail-wm1-f48.google.com with SMTP id 5b1f17b1804b1-40fb3b5893eso5336155e9.0 for ; Wed, 31 Jan 2024 04:39:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1706704767; x=1707309567; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=z+r3xp0YVppG+K2zbU8EUAKGRhHjAC7qKZPG0gnL87Q=; b=CE9sVgVdsd124Lsbhj3k0POYfR94szlu7vipDaNPIzoYmuDDIWzJJBTf3b6mI+fmo/ UoxOj6RR8her4vxqU6oa+UcmV6eFl/kRaobXk1PN/csZo+fwuxiRsIeyP6fPVLkY3Cph 2h3pY7LyCQB/jaTVyBze4rVBGlEKt9eskWqfW03TXpM8Ju4fL3Rv1oUgqXma7bVjeKV4 fbQyuezrWoRKR4dzmBUYqwc7Y/H9x3qdrkjxUF1tXmLYq4jGkumw+IxNCL+I+jGDYmkS P7Ytk/Dwq3N8o2BrJJZAGAxqmRJNcevJ1S+myCsSxVXc+d1z88F8HO4zb+uEC2ZzfpSw eTgg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706704767; x=1707309567; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=z+r3xp0YVppG+K2zbU8EUAKGRhHjAC7qKZPG0gnL87Q=; b=cxb3pXwnmm7BWMuENxwfjJ9Rqly9m16KgcA6S/NEcLPRNjdILe5q/HiGqnGcUcXPh+ lICgbHk4DEWb5oyl4CJwcpVwY4Po43LQtkQUyLLXBwtFNiEChCQeIqG57B02O5ewYDqM fQoe9AjEyOQ4TwVmqT6i0ReYVy7Zr74zDsi162wSqTPRApYYZG5Ox0RjGqy1zL4SdM2W N3hD/TRNKciSL3u0kVOY5RD0+9zd8bj2wCwDTzyG6wxe2pVoIisTQEP3b6CBx9sZoF1M UDq0TuPJ+q/s78QM3SKh+B4GuQViavZcqvaQgI+0YjwHX45qZi9n2qYaU5H2EnIABlPh 65Dw== X-Gm-Message-State: AOJu0YyD0MjhvPZZE3Dv5bISKkSSh3EpWZ4K1Ll6vQOvJcZc1LAty2ND luS9pSqAzSWdLh4ctD/qdu3rO1xx3wXksmbn7wDmvKxmDR2I7oKFwcHcIKxZ X-Google-Smtp-Source: AGHT+IF9iFAhCQm1tXJLFfpgvYzOdinTLYI2B4YzGjrjT4q0qUrs/A0AK8gsHIIwM6LCSbreFl2oMw== X-Received: by 2002:a5d:4202:0:b0:33a:e9eb:c637 with SMTP id n2-20020a5d4202000000b0033ae9ebc637mr969929wrq.42.1706704766993; Wed, 31 Jan 2024 04:39:26 -0800 (PST) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id ba1-20020a0560001c0100b0033ae593e830sm10898058wrb.23.2024.01.31.04.39.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jan 2024 04:39:26 -0800 (PST) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: openembedded-core@lists.openembedded.org Cc: Alexander Kanavin Subject: [PATCH 2/5] meta/lib/bblayers/buildconf.py: add support for configuration descriptions Date: Wed, 31 Jan 2024 13:39:05 +0100 Message-Id: <20240131123908.1098544-2-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240131123908.1098544-1-alex@linutronix.de> References: <20240131123908.1098544-1-alex@linutronix.de> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 31 Jan 2024 12:39:37 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/194520 Signed-off-by: Alexander Kanavin --- meta/lib/bblayers/buildconf.py | 10 ++++++++-- meta/lib/oeqa/selftest/cases/bblayers.py | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/meta/lib/bblayers/buildconf.py b/meta/lib/bblayers/buildconf.py index 87a5e5a55bc..a7d06471df5 100644 --- a/meta/lib/bblayers/buildconf.py +++ b/meta/lib/bblayers/buildconf.py @@ -20,7 +20,10 @@ def plugin_init(plugins): return BuildConfPlugin() class BuildConfPlugin(LayerPlugin): - notes_fixme = """FIXME: Please place here the description of this build configuration. + notes_fixme = """FIXME: Please place here the detailed instructions for using this build configuration. +They will be shown to the users when they set up their builds via TEMPLATECONF. +""" + description_fixme = """FIXME: Please place here the short description of what this build configuration is for. It will be shown to the users when they set up their builds via TEMPLATECONF. """ @@ -41,14 +44,17 @@ It will be shown to the users when they set up their builds via TEMPLATECONF. bblayers_data = bblayers_data.replace(abspath, "##OEROOT##/" + relpath) dest.write(bblayers_data) + with open(os.path.join(destdir, "conf-description.txt"), 'w') as dest: + dest.write(self.description_fixme) with open(os.path.join(destdir, "conf-notes.txt"), 'w') as dest: dest.write(self.notes_fixme) logger.info("""Configuration template placed into {} Please review the files in there, and particularly provide a configuration description in {} +and notes in {} You can try out the configuration with TEMPLATECONF={} . {}/oe-init-build-env build-try-{}""" -.format(destdir, os.path.join(destdir, "conf-notes.txt"), destdir, oecorepath, templatename)) +.format(destdir, os.path.join(destdir, "conf-description.txt"), os.path.join(destdir, "conf-notes.txt"), destdir, oecorepath, templatename)) def do_save_build_conf(self, args): """ Save the currently active build configuration (conf/local.conf, conf/bblayers.conf) as a template into a layer.\n This template can later be used for setting up builds via TEMPLATECONF. """ diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py index 8faa0602348..819ddf51bcd 100644 --- a/meta/lib/oeqa/selftest/cases/bblayers.py +++ b/meta/lib/oeqa/selftest/cases/bblayers.py @@ -121,7 +121,7 @@ class BitbakeLayers(OESelftestTestCase): self.assertEqual(bb_vars['BBFILE_PRIORITY_%s' % layername], str(priority), 'BBFILE_PRIORITY_%s != %d' % (layername, priority)) result = runCmd('bitbake-layers save-build-conf {} {}'.format(layerpath, "buildconf-1")) - for f in ('local.conf.sample', 'bblayers.conf.sample', 'conf-notes.txt'): + for f in ('local.conf.sample', 'bblayers.conf.sample', 'conf-description.txt', 'conf-notes.txt'): fullpath = os.path.join(layerpath, "conf", "templates", "buildconf-1", f) self.assertTrue(os.path.exists(fullpath), "Template configuration file {} not found".format(fullpath)) From patchwork Wed Jan 31 12:39:06 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 38504 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 648CCC4828E for ; Wed, 31 Jan 2024 12:39:37 +0000 (UTC) Received: from mail-wm1-f44.google.com (mail-wm1-f44.google.com [209.85.128.44]) by mx.groups.io with SMTP id smtpd.web10.12873.1706704768970386443 for ; Wed, 31 Jan 2024 04:39:29 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=M21AZiQX; spf=pass (domain: gmail.com, ip: 209.85.128.44, mailfrom: alex.kanavin@gmail.com) Received: by mail-wm1-f44.google.com with SMTP id 5b1f17b1804b1-40eacb4bfa0so52232275e9.1 for ; Wed, 31 Jan 2024 04:39:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1706704767; x=1707309567; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=PLQMCs1ZetI3OguaqrNJCbkxa3dflVXmcMdDNOHosVE=; b=M21AZiQXUuNTDUEI9vSfodM/wDaLfuP+dXkYYgQR5mydhMUryyRdT1ruNFgPd6++Cv L5smRwOUFMKfrC7goJXtzQcH1ynqtx9TFvaU/bDbNoy26LOrflIHAjpUHjI74EqS3b40 ZGG9k6uea2s4m5EVK9SwpXeWdZn9CVHYoSHxLAK74AVM+tl859MChrPpe4G1G7iPc3di NZ3tfXeaO6JubDy8tdcCxTgvb7IrxSChKX2RE1IaT1PgPcactgXsUFssgE7vuEiBI0BX czfxi3ldVKSdD6xY1q4nEd1NxL5q9bxqBThYPGqOcHimRhiiiMoxpJ9z430waTzrk8k3 oUvg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706704767; x=1707309567; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=PLQMCs1ZetI3OguaqrNJCbkxa3dflVXmcMdDNOHosVE=; b=kkIzKmMr18d7BdBmTt1fiDcmbwn+6oILjDOUXS9BLgn7D53duqg9wqsh8ybp5piLk1 ma7GjVlZWYvXsF2G0QS8yZKmQZsehxSFyK4lkdo8TCAf/CKWXIUrOg0HfzVHez78C2+i qebZf14L5hpIax08h/CaejK7XLK/cG7whhmmSxUHztNbUWU0UyX76UK6YWitwnfUyUyM TJw7fr2CaJtfCptW66eIg3GiNCc5YMTzygFeOUJl5MQdmlfX6qtdKWu6u4v5pysODymC +WyuZj1ak6x5CmKYgTmT3RertUsfTUW6wilA4CuRrRDuEGezOBom7GsmCYQ0Ud+TUp92 HJ+w== X-Gm-Message-State: AOJu0YzY2LGWFBW2nAMQbuHUShi1D5iFCuOS9ane6k7WSrKbtaWD2UMn MiNMs0nsn3AtrFNs42ZhjVyFDphlm8wGUkVK9UpQl2INu0WQXka+G2hhiR28 X-Google-Smtp-Source: AGHT+IFLi8zaeIk5S3+H6zXiJ8HFQCAnkuEavRPMSEmTCHBwYaYSuI3YXWh5zJ72gHic8G8hxzsXaQ== X-Received: by 2002:a05:600c:511e:b0:40f:b5d2:1b17 with SMTP id o30-20020a05600c511e00b0040fb5d21b17mr788355wms.12.1706704767469; Wed, 31 Jan 2024 04:39:27 -0800 (PST) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id ba1-20020a0560001c0100b0033ae593e830sm10898058wrb.23.2024.01.31.04.39.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jan 2024 04:39:27 -0800 (PST) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: openembedded-core@lists.openembedded.org Cc: Alexander Kanavin Subject: [PATCH 3/5] scripts/oe-setup-builddir: add support for configuration descriptions Date: Wed, 31 Jan 2024 13:39:06 +0100 Message-Id: <20240131123908.1098544-3-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240131123908.1098544-1-alex@linutronix.de> References: <20240131123908.1098544-1-alex@linutronix.de> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 31 Jan 2024 12:39:37 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/194521 They are handled exactly same as conf-notes.txt. Signed-off-by: Alexander Kanavin --- scripts/oe-setup-builddir | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/scripts/oe-setup-builddir b/scripts/oe-setup-builddir index 678aeac4be5..1b5dc55743e 100755 --- a/scripts/oe-setup-builddir +++ b/scripts/oe-setup-builddir @@ -57,6 +57,7 @@ if [ -n "$TEMPLATECONF" ]; then fi OECORELAYERCONF="$TEMPLATECONF/bblayers.conf.sample" OECORELOCALCONF="$TEMPLATECONF/local.conf.sample" + OECOREDESCRCONF="$TEMPLATECONF/conf-description.txt" OECORENOTESCONF="$TEMPLATECONF/conf-notes.txt" fi @@ -98,6 +99,13 @@ EOM SHOWYPDOC=yes fi +if [ -z "$OECOREDESCRCONF" ]; then + OECOREDESCRCONF="$OEROOT/meta/conf/templates/default/conf-description.txt" +fi +if [ ! -r "$BUILDDIR/conf/conf-description.txt" ]; then + [ ! -r "$OECOREDESCRCONF" ] || cp "$OECOREDESCRCONF" "$BUILDDIR/conf/conf-description.txt" +fi + if [ -z "$OECORENOTESCONF" ]; then OECORENOTESCONF="$OEROOT/meta/conf/templates/default/conf-notes.txt" fi @@ -108,6 +116,7 @@ fi # Prevent disturbing a new GIT clone in same console unset OECORELOCALCONF unset OECORELAYERCONF +unset OECOREDESCRCONF unset OECORENOTESCONF # Ending the first-time run message. Show the YP Documentation banner. @@ -124,6 +133,7 @@ EOM # unset SHOWYPDOC fi +[ ! -r "$BUILDDIR/conf/conf-description.txt" ] || cat "$BUILDDIR/conf/conf-description.txt" [ ! -r "$BUILDDIR/conf/conf-notes.txt" ] || cat "$BUILDDIR/conf/conf-notes.txt" if [ ! -f "$BUILDDIR/conf/templateconf.cfg" ]; then From patchwork Wed Jan 31 12:39:07 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 38503 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 49950C47DB3 for ; Wed, 31 Jan 2024 12:39:37 +0000 (UTC) Received: from mail-wr1-f48.google.com (mail-wr1-f48.google.com [209.85.221.48]) by mx.groups.io with SMTP id smtpd.web10.12874.1706704769613215056 for ; Wed, 31 Jan 2024 04:39:29 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=Bdk7vhyL; spf=pass (domain: gmail.com, ip: 209.85.221.48, mailfrom: alex.kanavin@gmail.com) Received: by mail-wr1-f48.google.com with SMTP id ffacd0b85a97d-33ae7681d03so2479676f8f.1 for ; Wed, 31 Jan 2024 04:39:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1706704768; x=1707309568; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=VeWnfP2noUuR+FR0QhynccQcXIrQl2AULlnsr4oCqJA=; b=Bdk7vhyL4n7wm3Wb43Zu+2HR1wWyCaQolcJqOBmuAyTyTd4gUzUc0tsJoYqOWt5DC6 WZU+zAhGLIOXXZQD5iqtO7WDxfE985CDdJCOKTlR96O4smt0mDXngYeyB/kXtQNCojmm p8Yj/1qkKXEz9+UCo+gSQa31q71B6IEauZDz7vTpylkGfNZXOX0QY3lMMNU7M2SaT9fa igj14ieO79fvumDWG/cEOMYquV+8uGp29qHG7Qb7N+oAGJ4YvIad/FULwZOd35QQF9Ia ++lGoxJoV7XiXedOavMDcG4OnFg4a26h79RmAPMJ+7u0E6zD88+blXJyJ6/6n9IG9jwt ll3w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706704768; x=1707309568; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=VeWnfP2noUuR+FR0QhynccQcXIrQl2AULlnsr4oCqJA=; b=bj+L7dMFBRKiWvzCj/ds0gRnFlsrt+NZZ0IvwZAKixNWFM6zZgHjdXpLtjWf0L3bhN HadYXMBOXR29BO2n0JWGR+KDiVA71kowbzOrGSs/3/2LdImBVd3i+ohojPFZvXCCr/R8 r7dI0WLuMr7GlwcsjtpboG92dINz/79kU9adL19GYSnNqA7whgNGV0nuswzOG++VMcwr YKhPm4UtscifZsY8PcuK9/O9Cv29CscXGCosXs62e8iDFNXnhDOTjt8Cjwzy5Ajwr7+s AFn/BkXqYhH9i4PQqXMP2PdvawDWWScyDcQWF+ol3cdf3h71DMqCFNjEJ+K/m41Cf6ZO +ihg== X-Gm-Message-State: AOJu0YyWf7HC/t678I3++b2VuGUpiIBKlLdNd7mSwlFXcEN+5O81DFkT wlRpaoaguBlORy8Q0ZZISzD88WV3KCp10i7CihfYSLmtseNKVlBTnKOu89V6 X-Google-Smtp-Source: AGHT+IF5MmrEC4BefKGCkCiMOTXzdavorbgW4bu5eU7Ms1EI3kocPiu/bPc4bpZs4bx5I6NoTHqN9A== X-Received: by 2002:a5d:6851:0:b0:33a:e43a:4ba6 with SMTP id o17-20020a5d6851000000b0033ae43a4ba6mr1016858wrw.57.1706704768039; Wed, 31 Jan 2024 04:39:28 -0800 (PST) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id ba1-20020a0560001c0100b0033ae593e830sm10898058wrb.23.2024.01.31.04.39.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jan 2024 04:39:27 -0800 (PST) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: openembedded-core@lists.openembedded.org Cc: Alexander Kanavin Subject: [PATCH 4/5] scripts/oe-setup-layers: write a list of layer paths into the checkout's top dir Date: Wed, 31 Jan 2024 13:39:07 +0100 Message-Id: <20240131123908.1098544-4-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240131123908.1098544-1-alex@linutronix.de> References: <20240131123908.1098544-1-alex@linutronix.de> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 31 Jan 2024 12:39:37 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/194522 This is beneficial for setting up builds, as this list can be used to determine reliably where the actual layers are, and discover available configurations from them. Also adjust the selftest to check the presence of that file rather than any specific layer in a hardcoded location. Sample output (paths are written relative to the file for relocatability and ease of reading): { "layers": [ "meta-openembedded/meta-filesystems", "meta-openembedded/meta-gnome", "meta-openembedded/meta-initramfs", "meta-openembedded/meta-multimedia", "meta-openembedded/meta-networking", "meta-openembedded/meta-oe", "meta-openembedded/meta-perl", "meta-openembedded/meta-python", "meta-openembedded/meta-webserver", "meta-openembedded/meta-xfce", "poky/bitbake/lib/layerindexlib/tests/testdata/layer1", "poky/bitbake/lib/layerindexlib/tests/testdata/layer2", "poky/bitbake/lib/layerindexlib/tests/testdata/layer3", "poky/bitbake/lib/layerindexlib/tests/testdata/layer4", "poky/meta-poky", "poky/meta-selftest", "poky/meta-skeleton", "poky/meta-yocto-bsp", "poky/meta" ], "version": "1.0" } Signed-off-by: Alexander Kanavin --- meta/lib/oeqa/selftest/cases/bblayers.py | 6 ++---- scripts/oe-setup-layers | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py index 819ddf51bcd..01fe17842e4 100644 --- a/meta/lib/oeqa/selftest/cases/bblayers.py +++ b/meta/lib/oeqa/selftest/cases/bblayers.py @@ -163,7 +163,5 @@ class BitbakeLayers(OESelftestTestCase): testcheckoutdir = os.path.join(self.builddir, 'test-layer-checkout') result = runCmd('{}/setup-layers --destdir {}'.format(self.testlayer_path, testcheckoutdir)) - # May not necessarily be named 'poky' or 'openembedded-core' - oecoredir = os.listdir(testcheckoutdir)[0] - testcheckoutfile = os.path.join(testcheckoutdir, oecoredir, "oe-init-build-env") - self.assertTrue(os.path.exists(testcheckoutfile), "File {} not found in test layer checkout".format(testcheckoutfile)) + layers_json = os.path.join(testcheckoutdir, ".oe-layers.json") + self.assertTrue(os.path.exists(layers_json), "File {} not found in test layer checkout".format(layers_json)) diff --git a/scripts/oe-setup-layers b/scripts/oe-setup-layers index 6d49688a32c..bee4ef0fec8 100755 --- a/scripts/oe-setup-layers +++ b/scripts/oe-setup-layers @@ -49,11 +49,24 @@ def _is_repo_at_remote_uri(repodir, remote, uri): def _contains_submodules(repodir): return os.path.exists(os.path.join(repodir,".gitmodules")) +def _write_layer_list(dest, repodirs): + layers = [] + for r in repodirs: + for root, dirs, files in os.walk(r): + if os.path.basename(root) == 'conf' and 'layer.conf' in files: + layers.append(os.path.relpath(os.path.dirname(root), dest)) + layers_f = os.path.join(dest, ".oe-layers.json") + print("Writing list of layers into {}".format(layers_f)) + with open(layers_f, 'w') as f: + json.dump({"version":"1.0","layers":layers}, f, sort_keys=True, indent=4) + def _do_checkout(args, json): repos = json['sources'] + repodirs = [] for r_name in repos: r_data = repos[r_name] repodir = os.path.abspath(os.path.join(args['destdir'], r_data['path'])) + repodirs.append(repodir) if 'contains_this_file' in r_data.keys(): force_arg = 'force_bootstraplayer_checkout' @@ -96,6 +109,8 @@ def _do_checkout(args, json): if _contains_submodules(repodir): print("Repo {} contains submodules, use 'git submodule update' to ensure they are up to date".format(repodir)) + _write_layer_list(args['destdir'], repodirs) + parser = argparse.ArgumentParser(description="A self contained python script that fetches all the needed layers and sets them to correct revisions using data in a json format from a separate file. The json data can be created from an active build directory with 'bitbake-layers create-layers-setup destdir' and there's a sample file and a schema in meta/files/") parser.add_argument('--force-bootstraplayer-checkout', action='store_true', From patchwork Wed Jan 31 12:39:08 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexander Kanavin X-Patchwork-Id: 38506 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 55C21C4828D for ; Wed, 31 Jan 2024 12:39:37 +0000 (UTC) Received: from mail-wm1-f42.google.com (mail-wm1-f42.google.com [209.85.128.42]) by mx.groups.io with SMTP id smtpd.web10.12875.1706704770573688413 for ; Wed, 31 Jan 2024 04:39:30 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20230601 header.b=D2AW+sv2; spf=pass (domain: gmail.com, ip: 209.85.128.42, mailfrom: alex.kanavin@gmail.com) Received: by mail-wm1-f42.google.com with SMTP id 5b1f17b1804b1-40e7e2e04f0so54419765e9.1 for ; Wed, 31 Jan 2024 04:39:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1706704769; x=1707309569; darn=lists.openembedded.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=/GeOd3dtwtx9QdV2t4G7yeddx/0/tx+2yLUeV4Sx5uM=; b=D2AW+sv2czj1ZWeh/BOI3bKlHB41NjU9nGrrPQvOVJne0TGqWv9m/tfvm2PwsHLdGf +rHmNi5exWDJhc7367GMOA4YRARmxZiyLZHbYz7x7Wd/SSmaTdALYUqUXocTrBMRr0Gv IJNcLd/1nDKeDdT7jGgIx7t3O7EL+lZL2dagyhgb0gGW7kTtdlKWzWw+50xduBkKlccC C3akjFU7Z+VLQwaKUOR63/NwNPFkIS+1o/0jmXuxWjePdMiyyhbZvc8/6uxo6zZskP1F VvDzBNvZCeXc6/UY7vqpKWnhNkCOkYVT+STg0E1HjMYbNNt8loM1iw7kz+cfovVxOQxh 5Nbg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1706704769; x=1707309569; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=/GeOd3dtwtx9QdV2t4G7yeddx/0/tx+2yLUeV4Sx5uM=; b=bDvAmBl///H1hHP2nLU7O9oy7KS4ToIpBteeb40fl5JiGGjdKTbR0yeEA86TnmCf8Y 4cvCKSgXUr17UE4e+CIlZcr2VrVfrQauhhIMy7OK7ng5F9QEpN5Rgv/6d621SzQU4QTF RUIozyRED9/JgHn6HD1ndjrlenSsdtkOW1312xwQowkVg8pJJ6SP4j7aZfbJekaBvqVN e87UZxVp/cbBplaVmAl9UPpjZhJ9VmJS3/yQU4oSUDJpvJ+CWzP4OW0O5ZPSLgoJCt7r U5QS2umN0cKbbHCALo3ZyCt0BkgTkw8ztnTLbzP23ihixA9wYi4zBHL1n7/xcrgL+TUX JEAQ== X-Gm-Message-State: AOJu0YwLFzeEiJEhO0QsGkjDi0lzYGRlKt9tglgOB+NFPOtqGizil+sW AvTWXoeVPVhTideG2WiEBTfcLMpxqkYB7zphofrVoUWQHdJxySamTxEHJSOs X-Google-Smtp-Source: AGHT+IH3odVD7jJp1O3tz9xWI3xV699qtn4wgL4Tr9QMYPriYS1qMyVwKsbmZKitff/yx8aquu2qww== X-Received: by 2002:a05:600c:1516:b0:40e:c564:a9ea with SMTP id b22-20020a05600c151600b0040ec564a9eamr1352143wmg.20.1706704768604; Wed, 31 Jan 2024 04:39:28 -0800 (PST) Received: from Zen2.lab.linutronix.de. (drugstore.linutronix.de. [80.153.143.164]) by smtp.gmail.com with ESMTPSA id ba1-20020a0560001c0100b0033ae593e830sm10898058wrb.23.2024.01.31.04.39.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 31 Jan 2024 04:39:28 -0800 (PST) From: Alexander Kanavin X-Google-Original-From: Alexander Kanavin To: openembedded-core@lists.openembedded.org Cc: Alexander Kanavin Subject: [PATCH 5/5] oe-setup-build: add a tool for discovering config templates and setting up builds Date: Wed, 31 Jan 2024 13:39:08 +0100 Message-Id: <20240131123908.1098544-5-alex@linutronix.de> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240131123908.1098544-1-alex@linutronix.de> References: <20240131123908.1098544-1-alex@linutronix.de> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Wed, 31 Jan 2024 12:39:37 -0000 X-Groupsio-URL: https://lists.openembedded.org/g/openembedded-core/message/194523 This is another piece of the puzzle in setting up builds from nothing without having to write custom scripts or use external tools. After layers have been fetched and placed into their respective locations by oe-setup-layers, one would surely want to proceed to the actual build, and here's how: 1. Without arguments the tool reads available layers from .oe-layers.json file (written out by oe-setup-layers or a fallback under scripts/), prints what templates it has found, and asks the user to select one, as seen below. This will land the user in a shell ready to run bitbake: ============================================= alex@Zen2:/srv/work/alex$ ./setup-build Available build configurations: 1. alex-configuration-gadget This configuration will set up a build for the purposes of supporting gadget. 2. alex-configuration-gizmo This configuration allows building a gizmo. 3. poky-default This is the default build configuration for the Poky reference distribution. Re-run with 'list -v' to see additional information. Please choose a configuration by its number: 1 Running: TEMPLATECONF=/srv/work/alex/meta-alex/conf/templates/configuration-gadget . /srv/work/alex/poky/oe-init-build-env /srv/work/alex/build-alex-configuration-gadget && /bin/bash You had no conf/local.conf file. This configuration file has therefore been created for you from /srv/work/alex/meta-alex/conf/templates/configuration-gadget/local.conf.sample You may wish to edit it to, for example, select a different MACHINE (target hardware). You had no conf/bblayers.conf file. This configuration file has therefore been created for you from /srv/work/alex/meta-alex/conf/templates/configuration-gadget/bblayers.conf.sample To add additional metadata layers into your configuration please add entries to conf/bblayers.conf. The Yocto Project has extensive documentation about OE including a reference manual which can be found at: https://docs.yoctoproject.org For more information about OpenEmbedded see the website: https://www.openembedded.org/ This configuration will set up a build for the purposes of supporting gadget. Please refer to meta-alex/README for additional details and available bitbake targets. ============================================== 2. It is also possible to list available configurations without selecting one using 'setup-build list' or to select and setup one non-interactively with 'setup-build setup'. 3. The full set of command line options is: $ ./setup-build --help usage: setup-build [-h] [--layerlist LAYERLIST] {list,setup} ... A script that discovers available build configurations and sets up a build environment based on one of them. Run without arguments to choose one interactively. positional arguments: {list,setup} list List available configurations setup Set up a build environment and open a shell session with it, ready to run builds. optional arguments: -h, --help show this help message and exit --layerlist LAYERLIST Where to look for available layers (as written out by setup-layers script) (default is /srv/work/alex/.oe-layers.json). $ ./setup-build list --help usage: setup-build list [-h] [-v] optional arguments: -h, --help show this help message and exit -v Print detailed information and usage notes for each available build configuration. $ ./setup-build setup --help usage: setup-build setup [-h] [-c configuration_name] [-b build_path] [--no-shell] optional arguments: -h, --help show this help message and exit -c configuration_name Use a build configuration configuration_name to set up a build environment (run this script with 'list' to see what is available) -b build_path Set up a build directory in build_path (run this script with 'list -v' to see where it would be by default) --no-shell Create a build directory but do not start a shell session with the build environment from it. 4. There's an an added hint in oe-setup-layers about how to proceed (as it is really not user-friendly to fetch the layer repos successfully and then exit without a word), and a symlink to the script from the top level layer checkout directory. 5. The selftest to check layer setup has been adjusted to run a basic check for template discovery and build setup. The revision of poky to be cloned has been bumped to 4.1, as that's the first version with a default template in a standard location. Signed-off-by: Alexander Kanavin --- meta/lib/oeqa/selftest/cases/bblayers.py | 26 ++++- scripts/.oe-layers.json | 7 ++ scripts/oe-setup-build | 122 +++++++++++++++++++++++ scripts/oe-setup-layers | 10 ++ 4 files changed, 163 insertions(+), 2 deletions(-) create mode 100644 scripts/.oe-layers.json create mode 100755 scripts/oe-setup-build diff --git a/meta/lib/oeqa/selftest/cases/bblayers.py b/meta/lib/oeqa/selftest/cases/bblayers.py index 01fe17842e4..00b1e6ce96f 100644 --- a/meta/lib/oeqa/selftest/cases/bblayers.py +++ b/meta/lib/oeqa/selftest/cases/bblayers.py @@ -152,12 +152,12 @@ class BitbakeLayers(OESelftestTestCase): self.validate_layersjson(jsonfile) # The revision-under-test may not necessarily be available on the remote server, - # so replace it with a revision that has a yocto-4.0 tag. + # so replace it with a revision that has a yocto-4.1 tag. import json with open(jsonfile) as f: data = json.load(f) for s in data['sources']: - data['sources'][s]['git-remote']['rev'] = '00cfdde791a0176c134f31e5a09eff725e75b905' + data['sources'][s]['git-remote']['rev'] = '5200799866b92259e855051112520006e1aaaac0' with open(jsonfile, 'w') as f: json.dump(data, f) @@ -165,3 +165,25 @@ class BitbakeLayers(OESelftestTestCase): result = runCmd('{}/setup-layers --destdir {}'.format(self.testlayer_path, testcheckoutdir)) layers_json = os.path.join(testcheckoutdir, ".oe-layers.json") self.assertTrue(os.path.exists(layers_json), "File {} not found in test layer checkout".format(layers_json)) + + # As setup-layers checkout out an old revision of poky, there is no setup-build symlink, + # and we need to run oe-setup-build directly from the current poky tree under test + oe_setup_build = os.path.join(get_bb_var('COREBASE'), 'scripts/oe-setup-build') + oe_setup_build_l = os.path.join(testcheckoutdir, 'setup-build') + os.symlink(oe_setup_build,oe_setup_build_l) + + cmd = '{} --layerlist {} list -v'.format(oe_setup_build_l, layers_json) + result = runCmd(cmd) + cond = "conf/templates/default" in result.output + self.assertTrue(cond, "Incorrect output from {}: {}".format(cmd, result.output)) + + # rather than hardcode the build setup cmdline here, let's actually run what the tool suggests to the user + conf = None + if 'poky-default' in result.output: + conf = 'poky-default' + elif 'meta-default' in result.output: + conf = 'meta-default' + self.assertIsNotNone(conf, "Could not find the configuration to set up a build in the output: {}".format(result.output)) + + cmd = '{} --layerlist {} setup -c {} --no-shell'.format(oe_setup_build_l, layers_json, conf) + result = runCmd(cmd) diff --git a/scripts/.oe-layers.json b/scripts/.oe-layers.json new file mode 100644 index 00000000000..1b00a84b542 --- /dev/null +++ b/scripts/.oe-layers.json @@ -0,0 +1,7 @@ +{ + "layers": [ + "../meta-poky", + "../meta" + ], + "version": "1.0" +} diff --git a/scripts/oe-setup-build b/scripts/oe-setup-build new file mode 100755 index 00000000000..074f0b4c13e --- /dev/null +++ b/scripts/oe-setup-build @@ -0,0 +1,122 @@ +#!/usr/bin/env python3 +# +# Copyright OpenEmbedded Contributors +# +# SPDX-License-Identifier: MIT +# + +import argparse +import json +import os +import subprocess + +def defaultlayers(): + return os.path.abspath(os.path.join(os.path.dirname(__file__), '.oe-layers.json')) + +def makebuildpath(topdir, template): + return os.path.join(topdir, "build-{}".format(template)) + +def discover_templates(layers_file): + if not os.path.exists(layers_file): + print("List of layers {} does not exist; were the layers set up using the setup-layers script?".format(layers_file)) + return None + + templates = [] + layers_list = json.load(open(layers_file))["layers"] + for layer in layers_list: + template_dir = os.path.join(os.path.dirname(layers_file), layer, 'conf','templates') + if os.path.exists(template_dir): + for d in sorted(os.listdir(template_dir)): + templatepath = os.path.join(template_dir,d) + if not os.path.isfile(os.path.join(templatepath,'local.conf.sample')): + continue + layer_base = os.path.basename(layer) + templatename = "{}-{}".format(layer_base[5:] if layer_base.startswith("meta-") else layer_base, d) + buildpath = makebuildpath(os.getcwd(), templatename) + notespath = os.path.join(template_dir, d, 'conf-notes.txt') + try: notes = open(notespath).read() + except: notes = None + try: description = open(os.path.join(template_dir, d, 'conf-description.txt')).read() + except: description = None + templates.append({"templatename":templatename,"templatepath":templatepath,"buildpath":buildpath,"notespath":notespath,"notes":notes,"description":description}) + + return templates + +def print_templates(templates, verbose): + print("Available build configurations:\n") + + for i in range(len(templates)): + t = templates[i] + print("{}. {}".format(i+1, t["templatename"])) + print("{}".format(t["description"].strip() if t["description"] else "This configuration does not have a description.")) + if verbose: + print("Configuration template path:", t["templatepath"]) + print("Build path:", t["buildpath"]) + print("Usage notes:", t["notespath"] if t["notes"] else "This configuration does not have usage notes.") + print("") + if not verbose: + print("Re-run with 'list -v' to see additional information.") + +def list_templates(args): + templates = discover_templates(args.layerlist) + if not templates: + return + + verbose = args.v + print_templates(templates, verbose) + +def find_template(template_name, templates): + print_templates(templates, False) + if not template_name: + n_s = input("Please choose a configuration by its number: ") + try: return templates[int(n_s) - 1] + except: + print("Invalid selection, please try again.") + return None + else: + for t in templates: + if t["templatename"] == template_name: + return t + print("Configuration {} is not one of {}, please try again.".format(tempalte_name, [t["templatename"] for t in templates])) + return None + +def setup_build_env(args): + templates = discover_templates(args.layerlist) + if not templates: + return + + template = find_template(args.c, templates) + if not template: + return + builddir = args.b if args.b else template["buildpath"] + no_shell = args.no_shell + coredir = os.path.abspath(os.path.join(os.path.dirname(os.path.realpath(__file__)), '..')) + cmd = "TEMPLATECONF={} . {} {}".format(template["templatepath"], os.path.join(coredir, 'oe-init-build-env'), builddir) + if not no_shell: + cmd = cmd + " && {}".format(os.environ['SHELL']) + print("Running:", cmd) + subprocess.run(cmd, shell=True, executable=os.environ['SHELL']) + +parser = argparse.ArgumentParser(description="A script that discovers available build configurations and sets up a build environment based on one of them. Run without arguments to choose one interactively.") +parser.add_argument("--layerlist", default=defaultlayers(), help='Where to look for available layers (as written out by setup-layers script) (default is {}).'.format(defaultlayers())) + +subparsers = parser.add_subparsers() +parser_list_templates = subparsers.add_parser('list', help='List available configurations') +parser_list_templates.add_argument('-v', action='store_true', + help='Print detailed information and usage notes for each available build configuration.') +parser_list_templates.set_defaults(func=list_templates) + +parser_setup_env = subparsers.add_parser('setup', help='Set up a build environment and open a shell session with it, ready to run builds.') +parser_setup_env.add_argument('-c', metavar='configuration_name', help="Use a build configuration configuration_name to set up a build environment (run this script with 'list' to see what is available)") +parser_setup_env.add_argument('-b', metavar='build_path', help="Set up a build directory in build_path (run this script with 'list -v' to see where it would be by default)") +parser_setup_env.add_argument('--no-shell', action='store_true', + help='Create a build directory but do not start a shell session with the build environment from it.') +parser_setup_env.set_defaults(func=setup_build_env) + +args = parser.parse_args() + +if 'func' in args: + args.func(args) +else: + from argparse import Namespace + setup_build_env(Namespace(layerlist=args.layerlist, c=None, b=None, no_shell=False)) diff --git a/scripts/oe-setup-layers b/scripts/oe-setup-layers index bee4ef0fec8..6fbfefd656f 100755 --- a/scripts/oe-setup-layers +++ b/scripts/oe-setup-layers @@ -63,6 +63,7 @@ def _write_layer_list(dest, repodirs): def _do_checkout(args, json): repos = json['sources'] repodirs = [] + oesetupbuild = None for r_name in repos: r_data = repos[r_name] repodir = os.path.abspath(os.path.join(args['destdir'], r_data['path'])) @@ -108,9 +109,18 @@ def _do_checkout(args, json): if _contains_submodules(repodir): print("Repo {} contains submodules, use 'git submodule update' to ensure they are up to date".format(repodir)) + if os.path.exists(os.path.join(repodir, 'scripts/oe-setup-build')): + oesetupbuild = os.path.join(repodir, 'scripts/oe-setup-build') _write_layer_list(args['destdir'], repodirs) + if oesetupbuild: + oesetupbuild_symlink = os.path.join(args['destdir'], 'setup-build') + if os.path.exists(oesetupbuild_symlink): + os.remove(oesetupbuild_symlink) + os.symlink(os.path.relpath(oesetupbuild,args['destdir']),oesetupbuild_symlink) + print("\nRun '{}' to list available build configuration templates and set up a build from one of them.".format(oesetupbuild_symlink)) + parser = argparse.ArgumentParser(description="A self contained python script that fetches all the needed layers and sets them to correct revisions using data in a json format from a separate file. The json data can be created from an active build directory with 'bitbake-layers create-layers-setup destdir' and there's a sample file and a schema in meta/files/") parser.add_argument('--force-bootstraplayer-checkout', action='store_true',