Skip to content

Commit 7e616b0

Browse files
Heeam-ShinHyunjae Shin
authored and
Hyunjae Shin
committed
README.md: Reorganize the document
:Release Notes: Update README.md for webOS OSE 2.20.0 :Detailed Notes: Reorganize document to improve readability Delete out-of-date descriptions Add instructions to download sources codes and license information :Testing Performed: No affect to images. :QA Notes: N/A :Issues Addressed: [WRP-8130] CCC: Update README.md on build-webos repository Change-Id: I19239993f2127730b4997017f009a394b3931347 Reviewed-on: http://gpro.lge.com/c/webosose/build-webos/+/344894 Reviewed-by: Commit Msg Checker <commit_msg@lge.com> Reviewed-by: Ban Word Checker <ban_word@lge.com> Reviewed-by: Hyunjae Shin <hyunjae92.shin@lgepartner.com> Tested-by: Hyunjae Shin <hyunjae92.shin@lgepartner.com>
1 parent d6ac27c commit 7e616b0

File tree

1 file changed

+42
-75
lines changed

1 file changed

+42
-75
lines changed

README.md

+42-75
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,65 @@
1-
build-webos
2-
===========
1+
# build-webos
32

4-
Summary
5-
-------
6-
Build webOS OSE (Open Source Edition) images
3+
This repository contains the top level code that aggregates the various [OpenEmbedded](http://openembedded.org) layers into a whole from which [webOS Open Source Edition (OSE)](https://www.webosose.org/) images can be built.
74

8-
Description
9-
-----------
10-
This repository contains the top level code that aggregates the various [OpenEmbedded](http://openembedded.org) layers into a whole from which webOS OSE images can be built.
5+
## Prerequisites
116

12-
Cloning
13-
=======
14-
Set up build-webos by cloning its Git repository:
7+
Before you begin, make sure that you prepare the target device and systems that meet the [System Requirements](https://www.webosose.org/docs/guides/setup/system-requirements/).
158

16-
git clone https://github.com/webosose/build-webos.git
9+
## How to Build a webOS OSE Image
1710

18-
Note: If you populate it by downloading an archive (zip or tar.gz file), then you will get the following error when you run mcf:
11+
To build a webOS OSE image, refer to [Building webOS OSE](https://www.webosose.org/docs/guides/setup/building-webos-ose/)
1912

20-
fatal: Not a git repository (or any parent up to mount parent).
21-
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYTEM not set).
13+
If you are already familiar with building webOS OSE, check the following quick summary:
2214

15+
``` bash
16+
# Download this repository
17+
$ git clone https://github.com/webosose/build-webos.git
18+
$ cd build-webos
19+
$ git checkout -t origin/<branch of the latest webOS OSE version>
2320

24-
Prerequisites
25-
=============
26-
Before you can build, you will need some tools. If you try to build without them, bitbake will fail a sanity check and tell you what's missing, but not really how to get the missing pieces. On Ubuntu, you can force all of the missing pieces to be installed by entering:
21+
# Install and configure the build
22+
$ sudo scripts/prerequisites.sh
23+
$ ./mcf -p 0 -b 0 raspberrypi4-64
2724

28-
$ cd build-webos
29-
$ sudo scripts/prerequisites.sh
25+
# Start to build
26+
$ source oe-init-build-env
27+
$ bitbake webos-image
28+
```
3029

31-
Also, the bitbake sanity check will issue a warning if you're not running under Ubuntu 18.04 64bit LTS.
30+
> **Note**: See also [Flashing webOS OSE](https://www.webosose.org/docs/guides/setup/flashing-webos-ose/).
3231
32+
## Copyright and License Information
3333

34-
Building
35-
========
36-
To configure the build for the raspberrypi4 and to fetch the sources:
37-
38-
$ ./mcf -p 0 -b 0 raspberrypi4
39-
40-
The `-p 0` and `-b 0` options set the make and bitbake parallelism values to the number of CPU cores found on your computer.
41-
42-
To kick off a full build of webOS OSE, make sure you have at least 100GB of disk space available and enter the following:
43-
44-
$ make webos-image
45-
46-
This may take in the neighborhood of two hours on a multi-core workstation with a fast disk subsystem and lots of memory, or many more hours on a laptop with less memory and slower disks or in a VM.
47-
48-
If you need more information about the build, please see the build guide on the webOS OSE website(webosose.org).
49-
50-
Images
51-
======
52-
The following images can be built:
53-
54-
- `webos-image`: The production webOS OSE image.
55-
- `webos-image-devel`: Adds various development tools to `webos-image`, including gdb and strace. See `packagegroup-core-tools-debug` and `packagegroup-core-tools-profile` in `oe-core` and `packagegroup-webos-test` in `meta-webos` for the complete list.
56-
57-
58-
Cleaning
59-
========
60-
To blow away the build artifacts and prepare to do clean build, you can remove the build directory and recreate it by typing:
61-
62-
$ rm -rf BUILD
63-
$ ./mcf.status
64-
65-
What this retains are the caches of downloaded source (under `./downloads`) and shared state (under `./sstate-cache`). These caches will save you a tremendous amount of time during development as they facilitate incremental builds, but can cause seemingly inexplicable behavior when corrupted. If you experience strangeness, use the command presented below to remove the shared state of suspicious components. In extreme cases, you may need to remove the entire shared state cache. See [here](https://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#shared-state-cache) for more information on it.
66-
67-
68-
Building Individual Components
69-
==============================
70-
To build an individual component, enter:
71-
72-
$ make <component-name>
34+
Unless otherwise specified, all content, including all source code files and documentation files in this repository are:
7335

74-
To clean a component's build artifacts under BUILD, enter:
36+
Copyright (c) 2008-2023 LG Electronics, Inc.
7537

76-
$ make clean-<component-name>
38+
All content, including all source code files and documentation files in this repository except otherwise noted are: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this content except in compliance with the License. You may obtain a copy of the License at
7739

78-
To remove the shared state for a component as well as its build artifacts to ensure it gets rebuilt afresh from its source, enter:
40+
http://www.apache.org/licenses/LICENSE-2.0
7941

80-
$ make cleanall-<component-name>
42+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
8143

82-
Adding new layers
83-
=================
84-
The script automates the process of adding new OE layers to the build environment. The information required for integrate new layer are; layer name, OE priority, repository, identification in the form branch, commit or tag ids. It is also possible to reference a layer from local storage area. The details are documented in weboslayers.py.
44+
SPDX-License-Identifier: Apache-2.0
8545

86-
Copyright and License Information
87-
=================================
88-
Unless otherwise specified, all content, including all source code files and documentation files in this repository are:
46+
## How to Download Source Codes and Licenses
8947

90-
Copyright (c) 2008-2019 LG Electronics, Inc.
48+
If you *ONLY* want to check the source codes and those license information, enter the following commands:
9149

92-
All content, including all source code files and documentation files in this repository except otherwise noted are: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this content except in compliance with the License. You may obtain a copy of the License at
50+
``` bash
51+
# Download this repository
52+
$ git clone https://github.com/webosose/build-webos.git
53+
$ cd build-webos
54+
$ git checkout -t origin/<branch of the latest webOS OSE version>
9355

94-
http://www.apache.org/licenses/LICENSE-2.0
56+
# Install and configure the build
57+
$ sudo scripts/prerequisites.sh
58+
$ ./mcf -p 0 -b 0 raspberrypi4-64
9559

96-
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
60+
# Download source codes and licenses
61+
$ source oe-init-build-env
62+
$ bitbake --runall=patch webos-image
63+
```
9764

98-
SPDX-License-Identifier: Apache-2.0
65+
You can check the source codes and licenses under the `BUILD/work` directory.

0 commit comments

Comments
 (0)