OpenCores
URL https://opencores.org/ocsvn/c0or1k/c0or1k/trunk

Subversion Repositories c0or1k

[/] [c0or1k/] [trunk/] [scripts/] [baremetal/] [files/] [build.readme.in] - Blame information for rev 2

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 drasko
                Codezero Buildsystem For This Container
2
 
3
                   Autogenerated by the Build system
4
 
5
 
6
This is an autogenerated file that is meant to walk you through the build
7
process. It is meant to be the most simple to get on with, therefore if
8
you feel any complications, please reach us on our l4dev.org mailing list
9
on %s
10
 
11
You have created a new container called `%s'.
12
 
13
The parameters you have supplied are described in the "%s" file
14
placed at the top-level directory. Note, that this is only an informative
15
file for your reference, and it can be optionally removed.
16
 
17
 
18
                        1. Directory Structure:
19
 
20
1.1) Directory tree:
21
.
22
|-- SConstruct
23
|-- build.readme
24
|-- .container
25
|-- include
26
|   `-- linker.lds.example
27
|-- main.c
28
`-- src
29
    |-- test.c
30
 
31
In the above directory tree:
32
 
33
1.2) |-- SConstruct
34
 
35
This is the top-level build file, that will build your project in its current
36
state. You may freely reorganize directories, but must reflect changes in this
37
file. For more, please see the SCons build tool at http://www.scons.org/
38
 
39
The build system will search for this file, and execute it by the:
40
 
41
`scons'
42
 
43
command at the root of the directory. You may issue the same command manually
44
for building and testing your build. If you choose to use another build tool
45
such as make, you may freely replace scons, and the build system will search
46
and call your custom build command.
47
 
48
1.3) |--include
49
     `--src
50
 
51
These are the directories that include your header files and sources. You may
52
freely change and reorganize these, but make sure to have a valid build file
53
that reflects those changes at the top-level directory.
54
 
55
1.4) |-- include
56
     |   `-- linker.lds.example
57
 
58
This is an example linker script for your project. Using this as your default
59
linker script is often useful, since it has been autogenerated to contain all
60
the parameters you need for the memory regions of your application defined at
61
configuration time. You may freely replace it, but make sure to edit the
62
top-level build script accordingly.
63
 
64
 
65
                        2. Build Process
66
 
67
2.1) Build overview
68
 
69
The complete Codezero system will be built from a top-level `%s' script by
70
that resides in the top-level directory of Codezero sources.
71
 
72
The Codezero system build script will build this container at a certain stage
73
during the build, by referring to build script file named such as `SConstruct'
74
or `Makefile' that resides in this container's top-level directory.
75
 
76
Once the executables are built, it will search for all files with a .elf
77
extension in any of the subdirectories, and recognize those as loadable
78
executables. There may be more than one of these files present after the build.
79
 
80
In the future this behaviour may change such that the loadable executable files
81
are also specified in the configuration.
82
 
83
Finally, executables of all containers will be picked up and built into the
84
final.elf file, which is a self-loading elf executable.
85
 
86
 
87
                        3. Reconfiguring this container
88
 
89
If you want to reconfigure the container with new parameters, you may do so by
90
executing the `%s' script at the top-level Codezero directory by:
91
 
92
'./%s'
93
 
94
This will populate only brand new container directories with new files. It will
95
update it's existing internal configuration for existing containers (such as
96
container memory regions) but it won't touch any files that exist under an
97
already-defined container.
98
 
99
If you want to start from scratch, specify a new directory name, if you want
100
to reconfigure existing container parameters, run this on an existing directory,
101
and it will only update its internal records for this container, but not touch
102
the directory.
103
 
104
 
105
                        4. Example source files
106
 
107
Example source files populated by the configuration contain valid examples
108
of how the generic libl4 userspace library can be used. Each test contains a
109
valid example from the available API, and may be modified, changed and removed
110
freely.
111
 
112
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.