diff options
Diffstat (limited to 'src/porting/1_intro.xml')
| -rw-r--r-- | src/porting/1_intro.xml | 38 |
1 files changed, 8 insertions, 30 deletions
diff --git a/src/porting/1_intro.xml b/src/porting/1_intro.xml index 2c59bc7..7b20fe6 100644 --- a/src/porting/1_intro.xml +++ b/src/porting/1_intro.xml @@ -1,38 +1,18 @@ <?xml version="1.0" encoding="utf-8"?> <chapter label="1" id="intro"> <title>Introduction to Porting</title> - <para>Welcome to the Adélie Linux New Port Guide. - This guide will provide everything you need to know to bootstrap a new platform to run Adélie Linux. - It is organised into three main parts: this Introduction, the Bootstrapping phase, and the Native Hardware phase.</para> + <highlights><para>Welcome to the Adélie Linux Porting Handbook. This handbook will provide everything you need to know to bootstrap a new platform to run Adélie Linux. It is organised into three main parts: this Introduction, the Bootstrapping phase, and the Native Hardware phase.</para></highlights> <section> <title>Before You Begin</title> - <para>There are a few things you need to be aware of before you begin. - First of all, bootstrapping a new platform can be difficult at times. Don't get discouraged if it doesn't work the first time. - Build issues and instability are common at the beginning. - If you need help, you can ask the maintainers of the software you are building, or you can contact the Adélie Linux Platform Group. - They are the group assigned to maintaining cross-platform compatibility and accepting new ports to the main Adélie Linux distribution.</para> + <para>There are a few things you need to be aware of before you begin. First of all, bootstrapping a new platform can be difficult at times. Don't get discouraged if your build doesn't work perfectly the first time. Build issues and instability are common at the beginning of every port. If you need help, you can ask the maintainers of the software you are building, or you can contact the Adélie Linux Platform Group. They are the group assigned to maintaining cross-platform compatibility and accepting new ports to the main Adélie Linux distribution.</para> </section> <section> <title>Requirements</title> - <para>You will need two computers. - The first one, which we will term the "host", must be a computer that is already running a Linux; - it is recommended that the host is already running Adélie Linux. - It will also need a decent CPU and disk, - because it will need to compile two full toolchains (compiler and other build tools).</para> - <warning> - <para>While it is theoretically possible to bootstrap from any POSIX system that supports GCC or Clang, - it is unsupported to use a non-Linux environment to bootstrap Adélie.</para> - </warning> - <para>You may need Internet access on the host to download packages. - If you do not have Internet access on the host, you will need to obtain the Adélie Linux Platform Group Resource Disc, - which contains the packages and source code you will need to bootstrap your new platform.</para> - <para>On the computer you will run Adélie Linux on, which we will term the "target", - you will need a computer platform supported by the Linux kernel and one of its compilers (at the time of this writing, GCC or Clang). - The Linux kernel, as of version 4.3, supports over 30 CPU architectures, so odds are good that your computer will be supported. - Nonetheless, you should still ensure that the Linux kernel and a recent toolchain have been ported and tested on your hardware before proceeding.</para> - <para>You will also need a way to boot Linux on your target. The specifics of this are beyond the scope of this guide. - Usually most embedded systems support booting off flash media which is easily obtained and writable by most host computers; - they may alternatively support booting from a network.</para> + <para>You will need two computers. The first one, which we will term the "host", must be a computer that is already running a Linux distribution; it is recommended that the host is already running Adélie Linux. It will also need a performant CPU and adequate disk space, because it will need to compile two full toolchains (compiler and other build tools).</para> + <warning><title>Warning</title><para>While it is theoretically possible to bootstrap from any POSIX system that supports GCC or Clang, it is unsupported to use a non-Linux environment to bootstrap Adélie.</para></warning> + <para>You may need Internet access on the host to download packages. If you do not have Internet access on the host, you will need to obtain the Adélie Linux Platform Group Resource Disc, which contains the packages and source code you will need to bootstrap your new platform.</para> + <para>On the computer you will run Adélie Linux on, which we will term the "target", you will need a computer platform supported by the Linux kernel and one of its compilers (at the time of this writing, GCC or Clang). The Linux kernel, as of version 4.3, supports over 30 CPU architectures, so odds are good that your computer will be supported. Nonetheless, you should still ensure that the Linux kernel and a recent toolchain have been ported and tested on your hardware before proceeding.</para> + <para>You will also need a way to boot Linux on your target. The specifics of this are beyond the scope of this guide. Usually most embedded systems support booting off flash media which is easily obtained and writable by most host computers; they may alternatively support booting from a network.</para> <section> <title>Host Requirements</title> <itemizedlist> @@ -60,8 +40,6 @@ <listitem><para>Build essential libraries and system software for your target using the cross-compiler on the host;</para></listitem> <listitem><para>Re-build these essential libraries on your target.</para></listitem> </itemizedlist> - <para>Once these goals have been completed, you will have a functional Adélie Linux system on your target. - After you have tested it and are satisfied with the stability and functionality of the port, - you may also wish to contact the Adélie Linux Platform Group for consideration on including the new port in the distribution.</para> + <para>Once these goals have been completed, you will have a functional Adélie Linux system on your target. After you have tested it and are satisfied with the stability and functionality of the port, you may also wish to contact the Adélie Linux Platform Group to consider including the new port in the official distribution.</para> </section> </chapter> |