diff options
author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2023-10-18 23:27:56 -0500 |
---|---|---|
committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2023-10-18 23:27:56 -0500 |
commit | 926aeb7fe8f50e5f1243b88a63d305c7d9f85371 (patch) | |
tree | f552082ba4fba7700846de3cd0cd6343fa6dde39 | |
parent | 9c34632dc97bba7b6ba05ca32bf00c32b7221911 (diff) | |
download | horizon-926aeb7fe8f50e5f1243b88a63d305c7d9f85371.tar.gz horizon-926aeb7fe8f50e5f1243b88a63d305c7d9f85371.tar.bz2 horizon-926aeb7fe8f50e5f1243b88a63d305c7d9f85371.tar.xz horizon-926aeb7fe8f50e5f1243b88a63d305c7d9f85371.zip |
Documentation updates
-rw-r--r-- | CHANGELOG.rst | 123 | ||||
-rw-r--r-- | CONTRIBUTING.rst | 14 | ||||
-rw-r--r-- | README.rst | 12 |
3 files changed, 112 insertions, 37 deletions
diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 409dcc7..78a7177 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,63 +5,138 @@ * **A. Wilcox**, documentation writer * **Contributors**, code :Copyright: - © 2019-2022 Adélie Linux and contributors. + © 2019-2023 Adélie Linux and contributors. -0.9.7 (2022-09-04) +0.9.8 (2023-10-20) ================== -CI --- +Boot to Horizon +--------------- -* Make test environment more predictible +* AArch64 support is now available. +* The minimise button has been removed from the title bars, since there is no + UX to restore minimised windows. -hscript -------- -* Portability fixes for libc++ +Build system +------------ + +* CMake is now given the CWD to use for running tests, ensuring that project + specific ``.valgrindrc`` settings are used. -* Better, more portable net conf reading +* Support for ``std::filesystem`` has been removed. It doesn't work on many + platforms and is still not widely supported. ``Boost.Filesystem`` is now + used in both the Installation Environment and Runtime Environment. -Project -------- +Disk +---- + +* The ``diskid`` key now additionally probes the ``ID_MODEL_ENC`` udev property + of the block device, to allow for matching on human-reddable model names. -* Miscellaneous URL fixes, documentation updates + +HorizonScript Library +--------------------- + +* The ``inherit`` key can now be used more than once, to allow for multiple + inheritance and mixins. This is leveraged heavily in the rewrite of our + Live Image configurations. + +* The library now supports building with more recent GCC versions and conforms + to the C++2x standard. + + +Image Creation +-------------- + +* The ``libarchive`` backend (``tar``) now builds correctly and uses + ``Boost.Filesystem``. + +* The CD backend (``iso``) supports creating media for AArch64 systems. + +* All backends handle error conditions more reliably and probe for needed + tools before beginning. + +* CD backend generated GRUB configuration files are now readable on 64-bit + PowerPC systems utilising the Petitboot boot loader. Qt UI ----- -* Select 'docs' package for Standard/Mobile +* The location of the default APK repository signing keys has been updated. + +* The Standard software selection now allows the user to choose which desktop + environment they wish to install. In the Runtime Environment, Plasma is + still the default. In the Installation Environment, the system attempts to + default to the currently running environment. -* Offer SDDM as an option for Custom installs +* LibreOffice has been removed from the Qt UI entirely, since it is no longer + packaged. See adelie/packages@d7e5a71711. -* Use 'tain' instead of 'tain_t' +* DHCP failures will no longer cause the wizard to stop processing. -* Use alternative QProcess API +* Tools launched from the Introduction page are now spawned instead of being + run modally. This allows user interaction with System Installation while + the tools are still running. + +* Date/time settings are now easier to input. + +* The Qt script runner now uses the same high-DPI scaling setting used by the + rest of System Installation. + + + +0.9.7 (2022-09-04) +================== + +Build system +------------ + +* The GitLab CI test environment is more predictible. + + +HorizonScript Library +--------------------- + +* The library now builds with LLVM libc++. + +* Network configuration reading has been refactored to be more portable. + + +Documentation +------------- + +* Miscellaneous URL fixes, documentation updates + + +Qt UI +----- -* Use newer QPalette name +* The Standard and Mobile software selections now install the ``docs`` + metapackage, ensuring documentation is available on the installed system. -* Port to using heavier buttonClicked signal +* Graphical Login via SDDM has been added to the Custom install. -* Refactor mount dialog partition display +* The Qt UI has been ported to the latest version of ``skalibs``. -* Use correct SkipEmptyParts based on Qt SDK +* Multiple corrections and enhancements to build against Qt 5.15. -* Handle salt material correctly +* Password salt material is now handled correctly. Tests ----- -* Ensure Ruby is always in UTF-8 mode +* Ruby will now always be invoked in UTF-8 mode, to support running the tests + on different locales. -* Add an stdout check to the simulator check +* The simulator tests will now pass on Darwin / Macintosh systems. -* Fix, once and for all 0.9.6 (2020-11-07) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 14774d0..aac2b91 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -39,8 +39,8 @@ Handbook_. .. _Handbook: https://help.adelielinux.org/html/devel/ -GitLab Pull Requests -```````````````````` +GitLab Merge Requests +````````````````````` #. If you do not already have a GitLab account, you must create one. @@ -60,13 +60,17 @@ GitLab Pull Requests #. Visit your forked repository in a Web browser. -#. Choose the *Create Pull Request* button. +#. Choose the *Create Merge Request* button. #. Review your changes to ensure they are correct, and then submit the form. Mailing List ```````````` +.. warning:: There is no Horizon mailing list right now. We are working to + create a new mailing list. Until then, GitLab merge requests + are the only supported contribution method. We apologise for + the inconvenience. #. Clone the Horizon repository to your computer. @@ -87,6 +91,4 @@ Mailing List ``git format-patch HEAD^^^``. #. Email the resulting patch to the mailing list, using ``git send-email`` or - your mail client. Ensure you are subscribed_ first. - -.. _subscribed: https://lists.adelielinux.org/postorius/lists/horizon.lists.adelielinux.org/ + your mail client. Ensure you are subscribed first. @@ -11,7 +11,7 @@ :Status: Development :Copyright: - © 2015-2022 Adélie Linux and contributors. + © 2015-2023 Adélie Linux and contributors. Code: AGPL-3.0 license. Documentation: CC BY-NC-SA open source license. @@ -38,7 +38,8 @@ auditable, secure, and fast. :target: https://git.adelielinux.org/adelie/horizon/pipelines :alt: Click for build status -.. image:: https://git.adelielinux.org/adelie/horizon/badges/current/coverage.svg +.. + image:: https://git.adelielinux.org/adelie/horizon/badges/current/coverage.svg :target: https://horizon.adelielinux.org/coverage/ :alt: Click for code coverage report @@ -88,10 +89,7 @@ To build the entirety of Project Horizon, you will need: * cURL development files (curl-dev) -* Either a C++17 environment, or Boost.Filesystem (boost-dev) - - Horizon makes full use of the C++17 <filesystem> library if it is - available, but will fall back to requiring Boost if it isn't. +* Boost.Filesystem (boost-dev) To build the simulator and validator, you will additionally need: @@ -104,7 +102,7 @@ need: * libudev development files (eudev-dev) -* `BCNM`_ +* `BCNM`_ (bcnm-dev) * blkid and libfdisk development files (util-linux-dev) |