diff options
Diffstat (limited to 'doc/intro.rst')
| -rw-r--r-- | doc/intro.rst | 73 |
1 files changed, 58 insertions, 15 deletions
diff --git a/doc/intro.rst b/doc/intro.rst index b827834..d07a238 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -12,10 +12,27 @@ minimalistic) Embedded Linux system with modern components: It can be used as a base for further BSP development. -Installing the BSP ------------------- +DistroKit supports multiple hardware platforms, see chapter +:ref:`hardware-platforms` for more information about them. -DistroKit is built with ptxdist. In order to install ptxdist, + +Quick Start +----------- + +The next sections below describe briefly how to build the BSP from scratch, +but for more in-depth documentation, refer to the `PTXdist manual +<https://www.ptxdist.org/doc/>`_ (or the later chapters if you're reading this +documentation in the HTML or the PDF version). + +If you already have a working environment, you can skip to the section about the +individual :ref:`hardware-platforms` for more information on how to build +images, how to flash an image to a board, or how to get a serial console. + +Installing PTXdist +~~~~~~~~~~~~~~~~~~ + +DistroKit is built with PTXdist version |ptxdistVendorVersion|. In order to +install PTXdist, `download the tarball <http://www.pengutronix.de/software/ptxdist/download/ptxdist-|ptxdistVendorVersion|.tar.bz2>`_ from the PTXdist Download Area. @@ -32,19 +49,19 @@ Go to the extracted directory and run $ ./configure && make && sudo make install Installing the Toolchain ------------------------- - -In order to build a BSP, you need a toolchain. The easiest way to get a -toolchain is to install the debian packages for OSELAS.Toolchain: +~~~~~~~~~~~~~~~~~~~~~~~~ - `<http://www.pengutronix.de/oselas/toolchain/>`_ +In order to build a BSP for a different architecture than your host system, +you need a toolchain. +DistroKit is configured for the OSELAS.Toolchain |oselasTCNVendorVersion|. +Depending on the platform you want to build, different toolchains are necessary – +see the sections about the :ref:`hardware-platforms`. -If you want to build the toolchain yourself, you can download the -toolchain sources from +Pre-built Debian packages of the toolchains are available from Pengutronix, +but you can also build the toolchain from source. +See the `OSELAS.Toolchain homepage <https://www.pengutronix.de/de/software/toolchain.html>`_ +for more information. - `<http://www.pengutronix.de/oselas/toolchain/download/>`_ - -and build them manually. Contributing ------------ @@ -64,6 +81,13 @@ using `git format-patch <https://git-scm.com/docs/git-format-patch>`_ on the DistroKit git repository (also see its man page for info on using mailers other than *git send-email*). +Mails sent to the DistroKit mailing list are archived on ``lore.distrokit.org``. +Patch series can be fetched with `b4 <https://pypi.org/project/b4/>`_ :: + + git config b4.midmask https://lore.distrokit.org/%s + git config b4.linkmask https://lore.distrokit.org/%s + b4 am https://lore.distrokit.org/$messageid # replace with link + DistroKit uses the `Developer’s Certificate of Origin <https://developercertificate.org/>`_:: By making a contribution to this project, I certify that: @@ -92,11 +116,30 @@ using your real name (sorry, no pseudonyms or anonymous contributions) to the end of your commit message, or if you use Git, make your commit with ``git commit --signoff``. +Maintenance scripts +~~~~~~~~~~~~~~~~~~~ + +Before sending your patch, you should run ``ptxdist lint`` and check its output. +Your patch should not add any new lint errors. + +For migrating PTXdist to a new version, there is the wrapper script +``scripts/p-all`` that runs PTXdist with the supplied arguments on all existing +platforms in DistroKit, for example:: + + $ ./scripts/p-all migrate + +The *mips* and *v7a* platforms use config diffs for kernel and/or barebox packages. +When touching their config files, you can use ``scripts/update-diffs-mips.sh`` and +``scripts/update-diffs-v7a.sh`` respectively to update the config diffs. + License ------- Copyright (C) 2020 Pengutronix and individual contributors DistroKit is licensed under the GNU General Public License, version 2.0. -See the file named LICENSE in the root directory of this project for the full -license terms, and the version control history for contributor information. +See the file named `LICENSE`_ in the root directory of this project for the full +license terms, and the `version control history`_ for contributor information. + +.. _LICENSE: https://git.pengutronix.de/cgit/DistroKit/tree/LICENSE +.. _version control history: https://git.pengutronix.de/cgit/DistroKit/log |