michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: update for kbuild based build system

Browse source 
Change documentation for usage with kbuild based make system.

Change-Id: I4071d65c3eaf69a91b93e13e71d6f44a12edc317
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-05-26 23:35:55 -04:00
commit a4dc59243c
2 changed files with 21 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/installation/installation_linux_steps_optional.rst
View file

@ -132,7 +132,7 @@ Create the Needed Build Tools
.. code-block:: bash
$ cd $VXMICRO_BASE
$ cd $TIMO_BASE
#. Copy the toolchain configurations to the build directories by
typing the following commands in the console:
@ -264,7 +264,7 @@ Follow these steps to enable a customized build of QEMU:
.. code-block:: bash
$ git am $VXMICRO\_BASE/scripts/0001-armv7m-support-basepri-primask-interrupt-locking.patch
$ git am $TIMO_BASE/scripts/0001-armv7m-support-basepri-primask-interrupt-locking.patch
#. Update the submodules as needed, type:
@ -284,7 +284,7 @@ Follow these steps to enable a customized build of QEMU:
.. code-block:: bash
$ ./configure --prefix=$MY\_PREFERED\_INSTALL\_LOCATION && make
$ ./configure --prefix=$MY_PREFERED_INSTALL_LOCATION && make
* Install QEMU, type:
@ -412,9 +412,9 @@ In Fedora, type:
$ cd grub-core
$ ../grub-mkimage -O i386-efi -d . -o grub.efi -p "" part\_gpt part\_msdos
$ ../grub-mkimage -O i386-efi -d . -o grub.efi -p "" part_gpt part_msdos
fat ext2 normal chain boot configfile linux multiboot help serial terminal
elf efi\_gop efi\_uga terminfo
elf efi_gop efi_uga terminfo
#. Look for the binary at :file:`~/grub/grub-core/grub.efi`.

40
doc/installation/installation_linux_steps_required.rst
View file

@ -140,7 +140,7 @@ but can be summarized with the following steps:
.. code-block:: bash
$ source vxmicro-env.bash
$ source timo-env.bash
Building a Tiny Mountain Example
================================
@ -149,26 +149,18 @@ To build a Tiny Mountain example follow these steps:
#. Go to the root directory of your foss-rtos checkout
#. Set the paths properly in the :file:`$VXMICRO_BASE` directory,
#. Set the paths properly in the :file:`$TIMO_BASE` directory,
type:
.. code-block:: bash
$ source vxmicro-env.bash
$ source timo-env.bash
3. Go to the source directory and build the host tools
#. Build Tiny Mountain with the example project, type:
.. code-block:: bash
$ cd $VXMICRO_BASE/host/src
$ make pristine && make
4. Build with the example project.
.. code-block:: bash
$ cd $VXMICRO_BASE/samples/microkernel/apps/hello_world
$ cd $TIMO_BASE/samples/microkernel/apps/hello_world
$ make pristine && make
@ -179,14 +171,14 @@ To build a Tiny Mountain example follow these steps:
You can override the default BSP with the one you want by adding
:makevar:`BSP=` and the options you want to the make command, for example
:command:`make BSP=generic_pc`. The complete options available for the BSP
flag can be found at :file:`$VXMICRO_BASE/arch` under the
respective architecture, for example :file:`$VXMICRO_BASE/arc/x86/generic_pc`.
flag can be found at :file:`$TIMO_BASE/arch` under the
respective architecture, for example :file:`$TIMO_BASE/arch/x86/generic_pc`.
The sample projects for the microkernel are found
at:file:`$VXMICRO_BASE/samples/microkernel/apps` and the results are at
at:file:`$TIMO_BASE/samples/microkernel/apps` and the results are at
:file:`$SAMPLE_PROJECT/outdir/microkernel.{ bin | elf }`.
For sample projects in the :file:`$VXMICRO_BASE/samples/nanokernel/apps`
For sample projects in the :file:`$TIMO_BASE/samples/nanokernel/apps`
directory, the results can be found in
:file:`$SAMPLE_PROJECT/outdir/nanokernel.{ bin | elf }`.
@ -207,7 +199,7 @@ Another option is to add it to the make command, for example:
.. code-block:: bash
$ make QEMU_BIN_PATH=/usr/local/bin { microkernel | nanokernel }.qemu
$ make QEMU_BIN_PATH=/usr/local/bin qemu
Running a Microkernel Project
-----------------------------
@ -216,19 +208,19 @@ Run a microkernel project using the default BSP (generic_pc), type:
.. code-block:: bash
$ make pristine && make microkernel.qemu
$ make pristine && make qemu
Run a project using the quark BSP, type:
.. code-block:: bash
$ make pristine && make BSP=quark microkernel.qemu
$ make pristine && make BSP=quark qemu
Run a project using the ARM BSP, type:
.. code-block:: bash
$ make pristine && make BSP=ti_lm3s6965 microkernel.qemu
$ make pristine && make BSP=ti_lm3s6965 qemu
Running a Nanokernel Project
----------------------------
@ -238,16 +230,16 @@ following commands:
.. code-block:: bash
$ make pristine && make nanokernel.qemu
$ make pristine && make qemu
Run a project using the quark BSP use the following commands:
.. code-block:: bash
$ make pristine && make BSP=quark nanokernel.qemu
$ make pristine && make BSP=quark qemu
Run a project using the ARM BSP use the following commands:
.. code-block:: bash
$ make pristine && make BSP=ti_lm3s6965 nanokernel.qemu
$ make pristine && make BSP=ti_lm3s6965 qemu