From 4e24a5be593560130e68ef99a329504c5ec22d22 Mon Sep 17 00:00:00 2001 From: Liviu Ionescu Date: Wed, 4 Dec 2024 20:01:30 +0200 Subject: [PATCH] website: updates --- ...022-05-04-qemu-riscv-v7-0-0-1-released.mdx | 2 ++ ...022-09-06-qemu-riscv-v7-1-0-1-released.mdx | 2 ++ ...023-01-31-qemu-riscv-v7-2-0-1-released.mdx | 2 ++ ...023-09-03-qemu-riscv-v7-2-5-1-released.mdx | 2 ++ ...024-04-02-qemu-riscv-v8-2-2-1-released.mdx | 2 ++ .../docs/about/_common/_history-xbb-v5.mdx | 4 +-- .../_common/_website-docusaurus-template.mdx | 2 +- .../_common/_platform-docker-section.mdx | 2 +- .../_common/_platform-native-section.mdx | 2 +- website/docs/developer/index.mdx | 18 ++++++------ website/docs/getting-started/index.mdx | 12 ++++---- website/docs/install/index.mdx | 7 +++-- .../_common/_platform-docker-build.mdx | 4 +-- .../_common/_platform-native-build.mdx | 4 +-- website/docs/maintainer/index.mdx | 27 +++++++++++------- .../_common/_arm-toolchain-versioning.mdx | 2 +- .../user/_common/_libraries-and-rpath.mdx | 2 +- website/docusaurus.config.ts | 8 ++---- website/sidebars.ts | 2 ++ .../HomepageFeatures/styles.module.css | 6 +++- website/src/css/custom.css | 4 +++ website/src/pages/index.module.css | 2 +- website/src/pages/index.tsx | 3 ++ website/static/img/favicon.ico | Bin 1150 -> 15086 bytes 24 files changed, 73 insertions(+), 48 deletions(-) diff --git a/website/blog/2022-05-04-qemu-riscv-v7-0-0-1-released.mdx b/website/blog/2022-05-04-qemu-riscv-v7-0-0-1-released.mdx index b79d549..8c55398 100644 --- a/website/blog/2022-05-04-qemu-riscv-v7-0-0-1-released.mdx +++ b/website/blog/2022-05-04-qemu-riscv-v7-0-0-1-released.mdx @@ -28,6 +28,8 @@ import {PageMetadata} from '@docusaurus/theme-common'; import Image from '@theme/IdealImage'; import CodeBlock from '@theme/CodeBlock'; +{/* ------------------------------------------------------------------------ */} + Version **7.0.0-1** is a new release. diff --git a/website/blog/2022-09-06-qemu-riscv-v7-1-0-1-released.mdx b/website/blog/2022-09-06-qemu-riscv-v7-1-0-1-released.mdx index f266286..d8c1b22 100644 --- a/website/blog/2022-09-06-qemu-riscv-v7-1-0-1-released.mdx +++ b/website/blog/2022-09-06-qemu-riscv-v7-1-0-1-released.mdx @@ -32,6 +32,8 @@ import {PageMetadata} from '@docusaurus/theme-common'; import Image from '@theme/IdealImage'; import CodeBlock from '@theme/CodeBlock'; +{/* ------------------------------------------------------------------------ */} + Version **7.1.0-1** is a new release; it follows the upstream QEMU release. diff --git a/website/blog/2023-01-31-qemu-riscv-v7-2-0-1-released.mdx b/website/blog/2023-01-31-qemu-riscv-v7-2-0-1-released.mdx index 32583c9..544ffd5 100644 --- a/website/blog/2023-01-31-qemu-riscv-v7-2-0-1-released.mdx +++ b/website/blog/2023-01-31-qemu-riscv-v7-2-0-1-released.mdx @@ -32,6 +32,8 @@ import {PageMetadata} from '@docusaurus/theme-common'; import Image from '@theme/IdealImage'; import CodeBlock from '@theme/CodeBlock'; +{/* ------------------------------------------------------------------------ */} + Version **7.2.0-1** is a new release; it follows the upstream QEMU release. diff --git a/website/blog/2023-09-03-qemu-riscv-v7-2-5-1-released.mdx b/website/blog/2023-09-03-qemu-riscv-v7-2-5-1-released.mdx index 30e718a..7e914f1 100644 --- a/website/blog/2023-09-03-qemu-riscv-v7-2-5-1-released.mdx +++ b/website/blog/2023-09-03-qemu-riscv-v7-2-5-1-released.mdx @@ -33,6 +33,8 @@ import {PageMetadata} from '@docusaurus/theme-common'; import Image from '@theme/IdealImage'; import CodeBlock from '@theme/CodeBlock'; +{/* ------------------------------------------------------------------------ */} + Version **7.2.5-1** is a new release; it follows the upstream QEMU release. diff --git a/website/blog/2024-04-02-qemu-riscv-v8-2-2-1-released.mdx b/website/blog/2024-04-02-qemu-riscv-v8-2-2-1-released.mdx index 02ebfe8..6936536 100644 --- a/website/blog/2024-04-02-qemu-riscv-v8-2-2-1-released.mdx +++ b/website/blog/2024-04-02-qemu-riscv-v8-2-2-1-released.mdx @@ -33,6 +33,8 @@ import {PageMetadata} from '@docusaurus/theme-common'; import Image from '@theme/IdealImage'; import CodeBlock from '@theme/CodeBlock'; +{/* ------------------------------------------------------------------------ */} + Version **8.2.2-1** is a new release; it follows the upstream QEMU release. diff --git a/website/docs/about/_common/_history-xbb-v5.mdx b/website/docs/about/_common/_history-xbb-v5.mdx index a8139cd..1c5a2e3 100644 --- a/website/docs/about/_common/_history-xbb-v5.mdx +++ b/website/docs/about/_common/_history-xbb-v5.mdx @@ -5,9 +5,9 @@ The project received a significant update by transitioning the build scripts from the cumbersome monolithic XBB Docker images to the more -flexible and modular xPacks. XBB version +flexible and modular **xpm** packages. XBB version [5.0.0](https://xpack.github.io/blog/2023/02/07/xbb-v5.0.0-released/) marked a major milestone for the xPack project, as it was the first self-sustained release. This version enabled the creation of new -binary xPacks using existing binary xPacks, eliminating the need for +binary packages using existing binary packages, eliminating the need for custom Docker images or other compiled tools. diff --git a/website/docs/about/_common/_website-docusaurus-template.mdx b/website/docs/about/_common/_website-docusaurus-template.mdx index a6a74e9..abd8f6d 100644 --- a/website/docs/about/_common/_website-docusaurus-template.mdx +++ b/website/docs/about/_common/_website-docusaurus-template.mdx @@ -3,7 +3,7 @@ {/* ------------------------------------------------------------------------ */} -In **{props.date}** the website content was added in the `website` folder, +In **{props.date || 'DATE'}** the website content was added in the `website` folder, as an instance of the Docusaurus template. Additionally a GitHub Action was added to automatically publish the site upon any pushes to the `website` Git branch. diff --git a/website/docs/developer/_common/_platform-docker-section.mdx b/website/docs/developer/_common/_platform-docker-section.mdx index 9bbb8d4..ef9fd94 100644 --- a/website/docs/developer/_common/_platform-docker-section.mdx +++ b/website/docs/developer/_common/_platform-docker-section.mdx @@ -45,7 +45,7 @@ or, for more verbosity, run the similar development build: {developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{props.platform}/deploy folder: +the build-assets/build/{props.platform}/deploy folder: * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.tar.gz * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.tar.gz.sha diff --git a/website/docs/developer/_common/_platform-native-section.mdx b/website/docs/developer/_common/_platform-native-section.mdx index a2f29f4..448af0a 100644 --- a/website/docs/developer/_common/_platform-native-section.mdx +++ b/website/docs/developer/_common/_platform-native-section.mdx @@ -42,7 +42,7 @@ or, for more verbosity, run the similar development build: {developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{props.platform}/deploy folder: +the build-assets/build/{props.platform}/deploy folder: * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.tar.gz * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.tar.gz.sha diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx index 3fcac33..433e8ed 100644 --- a/website/docs/developer/index.mdx +++ b/website/docs/developer/index.mdx @@ -33,9 +33,9 @@ import More from './_more.mdx' [![license](https://img.shields.io/github/license/xpack-dev-tools/qemu-riscv-xpack)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/blob/xpack/LICENSE) -This page is intended for those who want to build the +This page is designed for developers of the **xPack QEMU RISC-V** -binaries themselves. +project and provides documentation on how to build and test the package.
The xPack Build Box @@ -43,7 +43,7 @@ binaries themselves. The build scripts in this project use the **xPack Build Box** (**XBB**) tools, which require the usual native development tools (packed as a Docker image for GNU/Linux builds), complemented with -several binary xPacks, installed with `xpm` as development dependencies. +several binary packages, installed with `xpm` as development dependencies. For those interested in understanding how things work, a good starting point would be to read the [XBB](https://xpack.github.io/xbb/) page. @@ -144,9 +144,9 @@ xpm run build --config darwin-x64
-xPack actions +xpm/xPack actions -The xPack actions are extensions of npm scripts, i.e. named sequences +The xpm actions are extensions of npm scripts, i.e. named sequences of commands that are invoked via `xpm run ` to perform specific operations. together in a sub-shell . @@ -154,7 +154,7 @@ together in a sub-shell . The commands are invoked in a sub-shell with an adjusted PATH, having the `xpacks/.bin` folder prepended. This ensures the locally installed tools are -prefered to the system tools. +preferred to the system tools. Actions can be defined for the entire project or for a specific build configuration. @@ -177,10 +177,10 @@ commands.
Visual Studio Code integration -xPack actions and build configurations are supported in Visual Studio via the +xpm/xPack actions and build configurations are supported in Visual Studio via the [xPack C/C++ Managed Build Tools](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack) extension. -With this extension installed, xPack actions can be very conveniently +With this extension installed, xpm/xPack actions can be very conveniently invoked via a single mouse click, for example: ![xPack actions](https://github.com/xpack/vscode-xpack-extension-ts/raw/master/assets/docs-images/xpack-actions.png) @@ -328,7 +328,7 @@ In some cases it is necessary to run a debug session with the binaries. For these cases, the build script accepts the `--debug` options. -There are also xPack actions that use this option (`build-development-debug` +There are also xpm actions that use this option (`build-development-debug` and `docker-build-development-debug`). ### Use a local cache diff --git a/website/docs/getting-started/index.mdx b/website/docs/getting-started/index.mdx index 33b87fc..399d7c5 100644 --- a/website/docs/getting-started/index.mdx +++ b/website/docs/getting-started/index.mdx @@ -95,12 +95,12 @@ same repositories as **npm**, whether public or private. The packages (usually regular archives, but also git repositories), are extracted into separate folders within the project. -Based on the content, there are two types of packets: +Based on the content, there are two types of packages: -- **source xPacks** (that install source files, usually libraries) and -- **binary xPacks** (that install executables/binary files, usually tools). +- **source packages** (that install source files, usually libraries) and +- **binary packages** (that install executables/binary files, usually tools). -The binary xPacks include references to archives with the platform specific +Binary packages include references to archives with the platform specific binaries (such as `.tar.gz` for Unix or `.zip` for Windows). These archives are also expanded along the package metadata. Since they @@ -108,7 +108,7 @@ include executables, links/forwarders to these executables are created in a `.bin` folder, eliminating the need to add multiple folders to the `PATH`. -Given that some binary xPacks, such as toolchains, can have very large +Given that some binary packages, such as toolchains, can have very large archives, the packages are extracted only once into a user global location to conserve space. In projects, instead of duplicating the content of these archives, symbolic links are created. @@ -139,7 +139,7 @@ feasible.
Similarly to [flatpacks](https://flatpak.org) or [snap](https://snapcraft.io), -but significantly simpler, xPacks include all dependent shared libraries +but significantly simpler, xpm packages include all dependent shared libraries within the distributed archives, making the binaries independent of any similar libraries installed on the system. This ensures they can run on any system without needing specific libraries to be diff --git a/website/docs/install/index.mdx b/website/docs/install/index.mdx index 40beb4d..4ff1882 100644 --- a/website/docs/install/index.mdx +++ b/website/docs/install/index.mdx @@ -69,7 +69,8 @@ They use **the same format as npm packages**, which is a collection of files/folders and a `package.json` file with the package metadata. -Binary xPacks also include references to regular archives with the platform +**xpm** can install source and binary packages. +Binary xPacks include references to regular archives with the platform specific binaries (such as `.tar.gz` for Unix or `.zip` for Windows). These archives are unpacked and links/forwarders to the executables are created in a `.bin` folder. @@ -155,8 +156,8 @@ Similarly, **xpm** adds links/forwarders into a separate `/xpacks/.bin` folder. With this setup, the project needs to prepend only this `.bin` folder -to the `PATH`, and all the required tools are accesible -and prefered to possible system tools. +to the `PATH`, and all the required tools are accessible +and preferred to possible system tools.
diff --git a/website/docs/maintainer/_common/_platform-docker-build.mdx b/website/docs/maintainer/_common/_platform-docker-build.mdx index 5833099..ce3ebd1 100644 --- a/website/docs/maintainer/_common/_platform-docker-build.mdx +++ b/website/docs/maintainer/_common/_platform-docker-build.mdx @@ -18,7 +18,7 @@ xpm run check-space -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets To free the space used by all previous builds of all `xpack-dev-tools` packages: ```sh -xpm run clear-all-project-builds -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets +xpm run clear-all-projects-builds -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets ``` To update the build scripts and build the development binaries: @@ -39,7 +39,7 @@ xpm run docker-build-development --config ${props.platform} -C ~/Work/xpack-dev- {developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{props.platform}/deploy folder: +the build-assets/build/{props.platform}/deploy folder: * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'} * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha diff --git a/website/docs/maintainer/_common/_platform-native-build.mdx b/website/docs/maintainer/_common/_platform-native-build.mdx index ef93025..a554b1c 100644 --- a/website/docs/maintainer/_common/_platform-native-build.mdx +++ b/website/docs/maintainer/_common/_platform-native-build.mdx @@ -18,7 +18,7 @@ xpm run check-space -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets To free the space used by all previous builds of all `xpack-dev-tools` packages: ```sh -xpm run clear-all-project-builds -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets +xpm run clear-all-projects-builds -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets ``` To update the build scripts and build the development binaries: @@ -38,7 +38,7 @@ xpm run build-development --config ${props.platform} -C ~/Work/xpack-dev-tools/q {developmentDurations[ props.platform ]}, the output of the build script is a compressed archive and its SHA signature, created in -the buils-assets/build/{props.platform}/deploy folder: +the build-assets/build/{props.platform}/deploy folder: * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.tar.gz * xpack-qemu-riscv-{customField('xpackVersion')}-{props.platform}.tar.gz.sha diff --git a/website/docs/maintainer/index.mdx b/website/docs/maintainer/index.mdx index b1cc88c..f585ffb 100644 --- a/website/docs/maintainer/index.mdx +++ b/website/docs/maintainer/index.mdx @@ -48,9 +48,9 @@ import PlatformDockerBuild from './_common/_platform-docker-build.mdx' [![GitHub issues](https://img.shields.io/github/issues/xpack-dev-tools/qemu-riscv-xpack.svg)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/issues/) [![GitHub pulls](https://img.shields.io/github/issues-pr/xpack-dev-tools/qemu-riscv-xpack.svg)](https://github.com/xpack-dev-tools/qemu-riscv-xpack/pulls) -This page is intended for those who maintain the +This page is designed for maintainers of the **xPack QEMU RISC-V** -project and documents how to make new releases. +project and provides documentation on how to create new releases. ## Prerequisites @@ -141,6 +141,7 @@ In the `xpack-dev-tools/qemu-riscv-xpack` Git repo: - switch to the `xpack-development` branch - pull new changes +- if necessary, merge the `xpack` branch - if necessary, merge the `website` branch :::caution @@ -179,7 +180,7 @@ or run the following in a terminal: ``` Navigate to the **Maintainer Info** page, -the **Update the version specific code** section. +the **Increase the version and update VERSION** section. ### Increase the version and update VERSION @@ -205,7 +206,8 @@ If the project uses `customFields` in `build-assets/package.json` Check GitHub issues and pull requests: -- https://github.com/xpack-dev-tools/qemu-riscv-xpack/issues/ +- https://github.com/xpack-dev-tools/qemu-riscv-xpack/issues +- https://github.com/xpack-dev-tools/qemu-riscv-xpack/pulls and fix them; assign them to a milestone (like {customField('xpackVersion')}). @@ -270,7 +272,7 @@ Before the real build, run test/development builds on all platforms. ### Visual Studio Code extension -All actions are defined as **xPack actions** and can be conveniently +All actions are defined as **xpm/xPack actions** and can be conveniently triggered via the VS Code graphical interface, using the [xPack C/C++ Managed Build Tools extension](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack). @@ -441,7 +443,7 @@ In some cases it is necessary to run a debug session with the binaries. For these cases, the build script accepts the `--debug` options. -There are also xPack actions that use this option (`build-development-debug` +There are also xpm actions that use this option (`build-development-debug` and `docker-build-development-debug`). ### Files cache @@ -560,7 +562,7 @@ df -BG -H / To free the space used by all previous builds of all `xpack-dev-tools` packages: ```sh -xpm run clear-all-project-builds -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets +xpm run clear-all-projects-builds -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets ``` This is equivalent to running a wide `rm` to remove the `build` folders: @@ -587,7 +589,7 @@ xpm run generate-workflows -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build- ### Manually trigger the build GitHub Actions -To trigger the GitHub Actions builds, use the xPack actions: +To trigger the GitHub Actions builds, use the xpm actions: - **trigger-workflow-build-darwin-x64** - **trigger-workflow-build-darwin-arm64** @@ -606,7 +608,7 @@ xpm run trigger-workflow-build-linux-arm64 -C ~/Work/xpack-dev-tools/qemu-riscv- xpm run trigger-workflow-build-linux-arm -C ~/Work/xpack-dev-tools/qemu-riscv-xpack.git/build-assets ``` -The scripts behind these actions require the `GITHUB_API_DISPATCH_TOKEN` +The scripts behind these actions require the `XPACK_DEV_TOOLS_FG_DISPATCH_TOKEN` variable to be present in the environment, and the organization `PUBLISH_TOKEN` to be visible in the Settings → Action → @@ -634,7 +636,7 @@ The resulting binaries are available for testing from The automation is provided by GitHub Actions. -To trigger the GitHub Actions tests, run the xPack actions: +To trigger the GitHub Actions tests, run the xpm actions: