Skip to content

Latest commit

 

History

History
259 lines (183 loc) · 9.66 KB

README.md

File metadata and controls

259 lines (183 loc) · 9.66 KB

ph

The Phorepoc platform development kit: build Phorepoc from the Symbian source, and drive a test device through PhoneLab.

Generated from the command definitions (phe help -markdown <dir>); do not edit.

Source

The Symbian source and the include tree every build compiles against.

command what it does
phe source fetch Fetch the pinned Symbian source
phe source export Build the include tree from the packages' exports
phe source casefix Link the header spellings a case-sensitive file system misses
phe source mbg Generate the icon id headers (.mbg)
phe source status Show where the source, the OS tree, the adaptations and the build output are

Components

The registry's components: list them, build them.

command what it does
phe component list List the registered components
phe component info Show a component's registry entry
phe component build Build components into images
phe component resources Compile components' resources (.rsc) and their headers (.rsg)
phe component stale List images linked before a provider of theirs existed
phe component check Check that the registry's paths exist

Images

What goes onto a device: the ROM, its data, installable packages.

command what it does
phe image rom Build the ROM
phe image recipe Run an image recipe of the board's repositories
phe image release Make the board's release files
phe image skin Build the skin packages (the default skin and the Haze and Jing themes)
phe image icons Build every component's icon files (.mif)
phe image zdata Collect the Z: data the packages export
phe image sis Package components as an installable SIS file
phe image addon Pack built components as an add-on archive for an existing image build
phe image compare Byte-compare images with another build

Boards

The devices phe builds for, made of core plus adaptation repositories.

command what it does
phe board list List the boards phe builds for
phe board info Show a board's adaptation repositories

Packages

Installable items from the Phorepoc index and others: list, inspect, download.

command what it does
phe package list List the installable items of the indexes
phe package info Show an item: description, compatibility, approved releases
phe package fetch Download approved releases into the package cache
phe package install Install an item on a device through PhoneLab

Device

A device on the PhoneLab service: push images, read logs, take screenshots.

command what it does
phe device status Show the service's and the devices' health
phe device ops List the device's operations
phe device op Run any device operation
phe device push Install an image and boot it
phe device input Press keys, type, tap and swipe on the device
phe device shot Take a screenshot
phe device log Show stored log lines
phe device report Show how a boot went
phe device diff Show the log lines one boot has and another has not
phe device list List the service's devices
phe device boots List the device's recent boots
phe device events Show the structured events parsed from the log
phe device history Show the operations run on the device
phe device ls List a directory on the device
phe device pull Copy a file from the device
phe device put Copy a file to the device
phe device rm Delete a file on the device
phe device blobs List the service's stored blobs
phe device upload Store a file in the service's blob store
phe device pin Keep a boot or a blob past the retention period

Other

Everything else.

command what it does
phe shell Open a shell in the toolchain container
phe version Show phe's version
phe help Show the commands, a command's manual page, or a topic

Environment

phe finds its pieces through these variables ("phe source status" shows what they resolve to):

PHOREPOC_CORE The core checkout. Default: the core folder next to the pdk.

PHOREPOC_ADAPTATIONS The adaptation checkouts built with core, as a path list. Their os/ trees are laid over core's, their registries add their components. -b sets it for one command.

PHOREPOC_SYMBIAN The Symbian source: symbian-2010/ and symbian-rcl3/. Default: /symbian.

PHOREPOC_BUILD All generated files: a directory, or a Docker volume name. Default: /build.

PHOREPOC_OS_ROOT core's OS tree. Default: /os.

PHOREPOC_IMAGE The toolchain container image. Default: ghcr.io/phorepoc/base:latest.

PHONELAB_URL, PHONELAB_TOKEN The PhoneLab service the device commands talk to, and its bearer token.

Image-options

Given as -O name=value, as many as needed (phe image rom -b myboard -O net=1 -O fonts=dejavu):

net=0|1 The networking stack: ESOCK, TCP/IP, DNS, DHCP, the e1000 driver and SNTP.

net-test= The host the nettest component reaches at boot (RConnection, DNS, a TCP GET).

ntp-server= The SNTP server (default pool.ntp.org).

fonts=ubuntu|dejavu|gdr The UI font set (default ubuntu).

webfonts=0|1 The web fonts (CJK subset); 0 leaves them out.

themes=0|1 The extra 2010 themes (Haze, Jing); 0 leaves them out.

ui-renderer=classic|alfred|both The UI render path(s) (default: both on NGA boards, classic elsewhere).

shells=s3|s4|both The UI shell(s): Symbian^3, the Symbian^4 home screen (Qt 4.8 + Hb), or both.

nga=0|1 The NGA window server (composition through OpenWF-C).

nga-keep=,... Keep these non-NGA twins in an NGA image (bisecting).

phecomp=0|1|2 The phecomp render stage first in the NGA chain (core os/src/phecomp); 2 = compose (tiles).

alf= The Alfred (ALF) set at a bring-up stage.

phetty=on|off|exclude The developer terminal daemon (phettyd, pheshell, pheterm).

utc-offset= The home time zone, minutes from UTC (180 = UTC+3).

ssm-test= Start this test component at boot (as ssmtest.exe).

modem=0|1 Link the cellular modem power control (the board's modem back end) into the kernel.

modem-eg25=

The modem-eg25 checkout the modem back end is built from.

usb-host=0|1 Link the board's USB host stack (the pheusb layer) and its USB serial ports (COMM::8..) into the kernel.

rom-tail=,... Put these images last in the ROM (a delta push then sends only them).

rom-exclude=,... Leave these out of the ROM (they ship as SIS packages).

rom-data== ... Extra Z: files, dest relative to Z:.

addon=,... Add-on archives (phe image addon) whose files go into the ROM, as built for this architecture.

cenrep=/.txt ... Central repository files that override the built ones.

rom-heap-limits=0|1 The Phorepoc heap and stack table; 0 = each image's own values.

secondary= The first user process the kernel starts (default efile.exe).

s4=0|1 Build the Symbian^4 components in their own tree.

qt48=0|1 Register Qt 4.8 as installed (its ROM stub).

icons=0|1 Generate every component's icon files before the ROM (default 1).

iby-data=0|1 The data files the packages' .iby files list (default 1).

fast=0|1 Keep the core images (euser, efsrv, hal, efile, estart) from the last build.

prune=0|1 Drop images whose imports are not in the ROM instead of failing.

leave-trace=0|1 Log each User::Leave with its caller (diagnostic).

sched-trace=0|1 The active scheduler with a dispatch log (diagnostic).

trace= Kernel recipes: the kernel's trace mask (default 0x80000000: panics only).

screen=x Kernel recipes: the screen the display HAL reports (default 360x640).

scale=n Kernel recipes: show each screen pixel as an n x n block (default 2).

dbg=0|1 Kernel recipes: a debug kernel (default 1).

kclean=0|1 Kernel recipes: rebuild the kernel objects even when nothing changed.

x32-ld=bfd Force GNU ld for the x32 links.

x32-defs=:,... Extra defines for some components (diagnostic).

x32-include=:

,... Force-include a header in some components (diagnostic).

x32-fullerr=0|1 The whole compiler output of the first failure.