From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from mail.thorsis.com ([92.198.35.195]) by metis.ext.pengutronix.de with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1i57KU-0002pX-6Y for ptxdist@pengutronix.de; Tue, 03 Sep 2019 13:50:35 +0200 Received: from localhost (localhost [127.0.0.1]) by mail.thorsis.com (Postfix) with ESMTP id EB69E4EF9 for ; Tue, 3 Sep 2019 13:51:51 +0200 (CEST) Received: from mail.thorsis.com ([127.0.0.1]) by localhost (mail.thorsis.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 4SxgwIOYicnY for ; Tue, 3 Sep 2019 13:51:48 +0200 (CEST) Received: from adahl by ada.ifak-system.com with local (Exim 4.89) (envelope-from ) id 1i57KL-0001JY-GJ for ptxdist@pengutronix.de; Tue, 03 Sep 2019 13:50:25 +0200 From: Alexander Dahl Date: Tue, 3 Sep 2019 13:50:25 +0200 Message-Id: <20190903115025.5007-1-ada@thorsis.com> Subject: [ptxdist] [RFC PATCH] doc: Add section on creating new layers List-Id: PTXdist Development Mailing List List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: ptxdist@pengutronix.de MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: ptxdist-bounces@pengutronix.de Sender: "ptxdist" To: ptxdist@pengutronix.de After discussing these topics in IRC, it seemed reasonable to add some explanation on how to create a new layer from scratch. Signed-off-by: Alexander Dahl --- doc/dev_manual.rst | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst index d79ebdba7..746f3d695 100644 --- a/doc/dev_manual.rst +++ b/doc/dev_manual.rst @@ -1631,6 +1631,8 @@ convenient way to crate simple templates. It is also possible to create more files. For examples, the builtin ``genimage`` template creates a extra config file for the new package. +.. _layers: + Layers in PTXdist ----------------- @@ -1740,3 +1742,32 @@ layer. The make macros that provide these features are currently used by the barebox and kernel packages and templates. + +Creating a new Layer +~~~~~~~~~~~~~~~~~~~~ + +Adding new layers on top of an already existing BSP is easy: + +#. Create an empty folder, e.g. next to the existing BSP. +#. The lower layer is just a folder named ``base`` (see layers_ above). You + may do one of the following (or something else you consider convenient): + + - Create a symbolic link ``base`` to an outside laying BSP folder. For + an easy start, you can try this method with DistroKit_ for example: + ``$ ln -s ../DistroKit base`` + - Use a Git submodule with a BSP in a folder ``base``. + - Copy over your whole existing BSP to a new subfolder ``base``. + +#. If needed select **ptxconfig** and/or **platformconfig** after copying + that file from the lower layer to your new layer: + +.. code-block:: text + + $ mkdir -p configs/platform-v7a + $ cp base/configs/platform-v7a/platformconfig configs/platform-v7a/ + $ ptxdist platform configs/platform-v7a/platformconfig + +#. Use ``ptxdist menu`` like usual. +#. Put your new layer into Git and add configs and delta configs to it. + +.. _DistroKit: https://www.pengutronix.de/de/software/distrokit.html -- 2.20.1 _______________________________________________ ptxdist mailing list ptxdist@pengutronix.de