README_HowToBuild.txt
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Sat, 06 Nov 2010 16:46:13 +0000
changeset 86 56b6ee983610
parent 82 a6fec624de6c
permissions -rw-r--r--
Minor fixes. * Fixed some static anaylsis warnings * Fixed armv5smp build re topsampler * Changed 'more' command to understand CTRL-C
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
82
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     1
Fshell must be built from the appropriate subdirectory of \sf\os\fshell\build. There is a separate set of build files for each platform that fshell supports. "Platform" in this context meaning the combination of baseline (eg S^3 PDK) and target device/board (eg planning to include fshell in the ROM you're building for a prototype development board).
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     2
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     3
Most app developers will probably be working on an S^3 PDK baseline, and targetting a production N8 device installing via Open Signed SIS file. In this case you'd want to use the s60\5th_edition platform:
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     4
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     5
    N:\fshell>cd build\s60\5th_edition
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     6
    N:\fshell\build\s60\5th_edition>sbs -c armv5_urel
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     7
    ...
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     8
    N:\fshell\build\s60\5th_edition>sbs -c winscw_udeb
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
     9
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    10
For more information see http://developer.symbian.org/wiki/Fshell/Getting_Started
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    11
Open Signing of SIS files is described here: http://developer.symbian.org/wiki/Fshell/Getting_Started#Installing_fshell_at_runtime
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    12
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    13
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    14
The platforms are (at time of writing):
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    15
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    16
s60\3rd_edition     For any S60 3rd edition phone. Builds an open signed SIS file. For more info see:
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    17
s60\5th_edition     For any S60 5th edition or later phone, including the N8. Builds an open signed SIS file.
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    18
s60\tb92            Internal Nokia platform. Either you know what it is or you shouldn't be using it.
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    19
ncp                 Internal Nokia platform. Either you know what it is or you shouldn't be using it.
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    20
sf\2                Full GUI build for any ROM build using S^2
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    21
sf\3                Full GUI build for any ROM build using S^3 or later, including beagle board and QEMU
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    22
sf\3tshell          Textshell-only build for S^3 or later, supports QEMU and beagleboard
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    23
sf\minigui          Supports the minigui S^3 configuration. For more information see:
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    24
                    http://developer.symbian.org/wiki/Fshell/Getting_Started#Getting_started_on_QEMU_with_S.5E3_minigui
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    25
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    26
symtb92              Legacy platform for pre-symbian foundation builds. Not maintained.
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    27
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    28
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    29
Choose the platform closest to what you're working on. Generally this will be one of the s60 or sf platforms unless you're actually on a project that has its own dedicated platform dir, like NCP. The main distinction between the platforms is the set of macros defining what the platform supports. These are given in \fshell\build\whatever\platform.mmh. Most of the macros are of the form FSHELL_XXX_SUPPORT or FSHELL_NO_XXX_SUPPORT. The full set of available macros is documented in \epoc32\documentation\fshell\internal\common_mmh.html (auto-generated from \fshell\documentation\common_mmh.pod when you build fshell).
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    30
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    31
If you get any build errors they can often be temporarily worked around by tweaking the platform.mmh to disable the offending code, eg to add a '#define FSHELL_NO_SQL_SUPPORT' or somesuch. Please raise a bug if you have problems building on any of the supported platforms mentioned above, using the following link: http://developer.symbian.org/bugs/enter_bug.cgi?product=fshell
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    32
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    33
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    34
- tomsci
a6fec624de6c Tweaks to s60\5th_edition build, added README_HowToBuild.txt
Tom Sutcliffe <thomas.sutcliffe@accenture.com>
parents:
diff changeset
    35
4-Nov-2010