-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from JanneKiiskila/README-tweaks
Readme simplification
- Loading branch information
Showing
1 changed file
with
6 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,119 +1,12 @@ | ||
| Linux microPlatform Manifest | ||
| ============================ | ||
| Linux microPlatform Manifest for Pelion Edge | ||
| ============================================ | ||
|
|
||
| Foundries.io Linux microPlatform manifest. | ||
| Foundries.io Linux microPlatform manifest for [Pelion Edge](https://developer.pelion.com/docs/device-management-edge/latest/introduction/index.html). | ||
|
|
||
| This directory contains a Repo manifest and setup scripts for the | ||
| Linux microPlatform build system. If you want to modify, extend or port Linux | ||
| microPlatform to a new hardware platform, this is the manifest repository to | ||
| use. | ||
|
|
||
| The build system uses various components from the Yocto | ||
| Project, most importantly the OpenEmbedded build system, the bitbake | ||
| task executor and various application and BSP layers. | ||
|
|
||
| To configure the scripts and download the build metadata, do: | ||
|
|
||
| ``` | ||
| mkdir ~/bin | ||
| PATH=~/bin:$PATH | ||
| curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
| chmod a+x ~/bin/repo | ||
| ``` | ||
|
|
||
| Run `repo init` to bring down the latest stable version of Repo. You must | ||
| specify a URL for the manifest, which specifies the various repositories that | ||
| will be placed within your working directory. | ||
|
|
||
| To check out the latest LMP subscriber continuous release: | ||
|
|
||
| ``` | ||
| repo init -u https://github.com/foundriesio/lmp-manifest | ||
| ``` | ||
|
|
||
| A successful initialization will end with a message stating that Repo | ||
| is initialized in your working directory. Your client directory should | ||
| now contain a .repo directory where files such as the manifest will be | ||
| kept. | ||
|
|
||
| To pull down the metadata sources to your working directory from the | ||
| repositories as specified in the Linux microPlatform manifest, run: | ||
|
|
||
| ``` | ||
| repo sync | ||
| ``` | ||
|
|
||
| When downloading from behind a proxy (which is common in some | ||
| corporate environments), it might be necessary to explicitly specify | ||
| the proxy that is then used by repo: | ||
|
|
||
| ``` | ||
| export HTTP_PROXY=http://<proxy_user_id>:<proxy_password>@<proxy_server>:<proxy_port> | ||
| export HTTPS_PROXY=http://<proxy_user_id>:<proxy_password>@<proxy_server>:<proxy_port> | ||
| ``` | ||
|
|
||
| More rarely, Linux clients experience connectivity issues, getting | ||
| stuck in the middle of downloads (typically during "Receiving | ||
| objects"). It has been reported that tweaking the settings of the | ||
| TCP/IP stack and using non-parallel commands can improve the | ||
| situation. You need root access to modify the TCP setting: | ||
|
|
||
| ``` | ||
| sudo sysctl -w net.ipv4.tcp_window_scaling=0 | ||
| repo sync -j1 | ||
| ``` | ||
|
|
||
| Setup Environment | ||
| ----------------- | ||
|
|
||
| Supported **MACHINE** targets (officially tested by FIO): | ||
| * a5ds | ||
| * apalis-imx6 | ||
| * apalis-imx8 | ||
| * beaglebone-yocto | ||
| * colibri-imx7-emmc | ||
| * corstone700-fvp | ||
| * corstone700-mps3 | ||
| * freedom-u540 | ||
| * imx6ullevk | ||
| * imx7ulpea-ucom | ||
| * imx8mmevk | ||
| * intel-corei7-64 | ||
| * qemuarm | ||
| * qemuarm64 | ||
| * qemuriscv64 | ||
| * raspberrypi3-64 | ||
| * raspberrypi4-64 | ||
| * stm32mp1-disco | ||
| * uz3eg-iocc | ||
|
|
||
| Supported image targets: | ||
| * lmp-mini-image - minimal OSTree + OTA capable image | ||
| * lmp-base-console-image - mini-image + Docker container runtime | ||
| * lmp-gateway-image - base-console-image + edge gateway related utilities | ||
| * lmp-factory-image - default (and only available) at FoundriesFactory | ||
|
|
||
| The default distribution (DISTRO) variable is automatically set to `lmp`, | ||
| which is provided by the `meta-lmp` layer. | ||
|
|
||
| Setup the work environment by using the `setup-environment` script: | ||
|
|
||
| ``` | ||
| [MACHINE=<MACHINE>] source setup-environment [BUILDDIR] | ||
| ``` | ||
|
|
||
| If **MACHINE** is not provided, the script will list all possible machines and | ||
| force one to be selected. | ||
|
|
||
| To build the Linux microPlatform base console image: | ||
|
|
||
| ``` | ||
| bitbake lmp-base-console-image | ||
| ``` | ||
| This directory contains a Repo manifest and setup scripts for the Linux microPlatform build system. | ||
| Please follow the instructions in the [quick start](https://developer.pelion.com/docs/device-management-edge/latest/quick-start/lmp-quick-start.html) for setup, build and flashing instructions. | ||
|
|
||
| Issues and Support | ||
| ------------------ | ||
|
|
||
| Please report any bugs, issues or suggestions at | ||
| https://support.foundries.io. | ||
| Please report any bugs, issues or suggestions via [Pelion Device Management support](https://pelion.com/support/). |