From 2a8713004a38fe38f1cb4721cda6b7ec833bba1d Mon Sep 17 00:00:00 2001 From: Andrei Gherzan <andrei.gherzan@huawei.com> Date: Mon, 21 Nov 2022 11:55:52 +0000 Subject: [PATCH] Add 2.0.0 release notes Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com> --- releases/2.0/2.0.0/release_notes.rst | 202 +++++++++++++++++++++++++++ releases/index.rst | 1 + 2 files changed, 203 insertions(+) create mode 100644 releases/2.0/2.0.0/release_notes.rst diff --git a/releases/2.0/2.0.0/release_notes.rst b/releases/2.0/2.0.0/release_notes.rst new file mode 100644 index 0000000..9f0bfc5 --- /dev/null +++ b/releases/2.0/2.0.0/release_notes.rst @@ -0,0 +1,202 @@ +.. SPDX-FileCopyrightText: Huawei Inc. +.. +.. SPDX-License-Identifier: CC-BY-4.0 + +.. include:: ../../../definitions.rst + +2.0.0 +##### + +About +***** + +The objective of this document is to provide basic introductory information +about included functionalities, known issues and instructions guidance for the +2.0.0 release of the |main_project_name| project. + +The |main_project_name| project serves as a solid base foundation for products. +It is not a standalone product itself but rather a platform that aims at +accelerating the development and maintenance of other projects and products. + +During this release, the project's code and most of its infrastructure moved to +Eclipse Foundation as one of the top-level projects. This follows the fact that +|main_project_name| became a member project of Eclipse Foundation during a +preview release iteration. + +Scope +***** + +**Release version**: 2.0.0 + +**Release timeframe**: 2022-03-07 .. 2022-11-22 + +The Objectives of the Release +----------------------------- + +The objective of the *2.0.0* release is to deal with the Eclipse Foundation +onboarding while including new features as well. That includes, but is not +limited to: + +- Migration of code to Eclipse Foundation +- Work towards migration of the project's infrastructure to Eclipse Foundation + (eg. CI, pipelines, etc.) +- Hardware & Software roadmap expansion +- IP compliance & policies deployment +- Security and maintenance featuring CVE fixes, LEDGE support, etc. + +The List of Software Features Included +-------------------------------------- + +- Linux Kernel LTS version supported for all ARM and X86 targets +- Zephyr kernel 3.1 supported for all ARM and X86 targets +- Over-the-Air system update, including integration with hawkbit and SysOTA + backends +- Toolchain package upgrades including LLVM, GCC, musl, etc. +- Matter 1.0 and Thread 1.2 support +- Modbus support with RTU (over RS485) and TCP modes +- New hardware supported: Raspberry Pi 3, SECO (SBC-C61, SBC-B68, SBC-D23), + QEMU ARM 32/64bit, Arduino Nano 33 BLE +- Development and integration of functional testing suites +- Integration of standard test toolkits (eg. LTP) +- More LAVA support development including new LAVA nodes +- Security OS features targeting runtime and build-time (:ref:`SecurityGuide`) +- Development for security-oriented features for Oniro upgrades and CVE fixes +- Upstream contributions in terms of fixes, backports and CVE issues + +Supported Hardware Platforms +---------------------------- + ++---------------------------------+-------------------+---------------------------------------+ +| Board (chipset) | Supported kernels | Board documentation | ++=================================+===================+=======================================+ +| QEMU X86 | Linux & Zephyr | :ref:`SupportedVBoardQemuX86` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU X86-64 | Linux | :ref:`SupportedVBoardQemuX86-64` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU ARM (EFI) | Linux | :ref:`SupportedVBoardQemuARM` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU ARM64 (EFI) | Linux | :ref:`SupportedVBoardQemuARM64` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU Cortex M3 | Zephyr | :ref:`Zephyr_Kernel` | ++---------------------------------+-------------------+---------------------------------------+ +| SECO SBC-B68 | Linux | :ref:`SupportedBoardSecoB68` | ++---------------------------------+-------------------+---------------------------------------+ +| SECO SBC-C61 | Linux | :ref:`SupportedBoardSecoC61` | ++---------------------------------+-------------------+---------------------------------------+ +| SECO SBC-D23 | Linux | :ref:`SupportedBoardSecoD23` | ++---------------------------------+-------------------+---------------------------------------+ +| Raspberry Pi 4 B (BCM2711) | Linux | :ref:`raspberrypi` | ++---------------------------------+-------------------+---------------------------------------+ +| Raspberry Pi 3 B+ (BCM2837B0) | Linux | :ref:`raspberrypi` | ++---------------------------------+-------------------+---------------------------------------+ +| Arduino Nano 33 BLE | Zephyr | :ref:`SupportedBoardArduinoNano33BLE` | ++---------------------------------+-------------------+---------------------------------------+ + +Test Report +----------- + +TODO + +Installation +************ + +:ref:`Quick Build <OniroQuickBuild>` provides an example of how to build the +|main_project_name| project for an example target. Visit the :ref:`Hardware +Support <HardwareSupport>` section for instructions on how to build for other +supported targets. + +Visit :ref:`setting up a repo workspace <RepoWorkspace>` for instructions how +to prepare the workspace for development. Since |main_project_name| uses `repo` +tool for its development, you can use the release tag for the `repo init` +commands as follows: + +.. code-block:: console + + repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b v2.0.0 + +Known Issues +------------ + ++-------------------------+-------------------+--------------------------------------------------------------------+ +| Description | Board involved | GitLab link | ++=========================+===================+====================================================================+ +| Clang build fails | QEMU Cortex M3 | <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/835> | ++-------------------------+-------------------+--------------------------------------------------------------------+ +| Clang build fails | QEMU X86 | <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/836> | ++-------------------------+-------------------+--------------------------------------------------------------------+ +| Clang build fails | Arduino Nano BLE | <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/845> | ++-------------------------+-------------------+--------------------------------------------------------------------+ +| Clang build fails | SECO SBC-C61 | <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/846> | ++-------------------------+-------------------+--------------------------------------------------------------------+ +| Cam module doesn't work | Raspberry Pi 4 B | <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/847> | ++-------------------------+-------------------+--------------------------------------------------------------------+ + +Source Code +----------- + +For more details on our repo structure, see `OniroProject's GitLab +<https://gitlab.eclipse.org/eclipse/oniro-core>`__ project group. + +DevOps Infrastructure +********************* + +To learn more about our approach to CI (Continuous Integration) strategy used +for this release, please see: + +:doc:`/ci/index` document. + +Testing +------- + +Details can be found in: + +:doc:`/ci/device-testing` document. + +Out of Scope +************ + +|main_project_name| bundles components from multiple upstream sources. These +upstream sources come with features that the project might not explicitly +mention as part of its supportability policy. Similarly, |main_project_name| +includes supported features that are explicitly marked as 'experimental'. All +these cases, mainly driven by the community, will imply basic support from the +project. + +|main_project_name| exercises an upstream-first support policy, so even for +cases that are not strictly in the supportability scope of the project, +|main_project_name| will provide guidance and traceability while facilitating +the upstream effort. + +Contributions +************* + +If you are a developer eager to know more details about |main_project_name| or +just an enthusiast with a patch proposal, you are welcome to participate in our +|main_project_name| ecosystem development. To do so, please sign-up using the +process described below: + +:doc:`/contributing/index` document. + +License +******* + +Project manifest, project-specific meta-layers, recipes, and software packages +are published under the MIT license unless specified otherwise. The whole +operating system built by users from the project manifest is an aggregate +comprised of many third-party components or component groups, each subject to +its license conditions. + +Official project release includes only the project manifest as well as +project-specific meta-layers, and recipes. Any reference binary image, build +cache, and other build artefacts are distributed only as a convenience and are +not part of the release itself. + +.. note:: + + "supported" `referred to a board` means that a board is officially targeted + as a potential platform where an Oniro image can be installed for any + purposes; when `referred to an image`, means that the imagine targeting a + supported board receives thorough testing and specific attention during the + development. It does NOT mean that both will receive support services nor + that any member of the Oniro Working Group or of the Eclipse Foundation will + provide any warranty whatsoever. diff --git a/releases/index.rst b/releases/index.rst index 986aab9..d062de3 100644 --- a/releases/index.rst +++ b/releases/index.rst @@ -14,3 +14,4 @@ This section contains information related to releases of |main_project_name|. aladeen/0.1.0/release_notes jasmine/1.0.0/release_notes + 2.0/2.0.0/release_notes -- GitLab