website: updates

xpack-dev-tools · Dec 4, 2024 · 66b0b60 · 66b0b60
1 parent 6b96358
commit 66b0b60
Show file tree

Hide file tree

Showing 33 changed files with 91 additions and 48 deletions.
diff --git a/website/blog/2021-10-21-clang-v12-0-1-1-released.mdx b/website/blog/2021-10-21-clang-v12-0-1-1-released.mdx
@@ -28,6 +28,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **12.0.1-1** is the first release of the **xPack LLVM clang** package.
 
 <!-- truncate -->

diff --git a/website/blog/2022-02-08-clang-v12-0-1-2-released.mdx b/website/blog/2022-02-08-clang-v12-0-1-2-released.mdx
@@ -28,6 +28,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **12.0.1-2** is a maintenance release; it updates to the latest build scripts and adds support for Apple Silicon.
 
 <!-- truncate -->

diff --git a/website/blog/2022-03-24-clang-v13-0-1-1-released.mdx b/website/blog/2022-03-24-clang-v13-0-1-1-released.mdx
@@ -28,6 +28,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **13.0.1-1** is a new release; it follows the upstream release.
 
 <!-- truncate -->

diff --git a/website/blog/2022-08-21-clang-v14-0-6-1-released.mdx b/website/blog/2022-08-21-clang-v14-0-6-1-released.mdx
@@ -28,6 +28,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **14.0.6-1** is a new release; it follows the upstream release.
 
 <!-- truncate -->

diff --git a/website/blog/2022-08-31-clang-v14-0-6-2-released.mdx b/website/blog/2022-08-31-clang-v14-0-6-2-released.mdx
@@ -30,6 +30,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **14.0.6-2** is a maintenance release; it includes a patch to fix a clangd issue.
 
 <!-- truncate -->

diff --git a/website/blog/2023-01-22-clang-v15-0-7-1-released.mdx b/website/blog/2023-01-22-clang-v15-0-7-1-released.mdx
@@ -30,6 +30,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **15.0.7-1** is a new release; it follows the upstream release.
 
 <!-- truncate -->

diff --git a/website/blog/2023-01-28-clang-v15-0-7-2-released.mdx b/website/blog/2023-01-28-clang-v15-0-7-2-released.mdx
@@ -30,6 +30,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **15.0.7-2** is a maintenance release; it fixes the missing run-time libraries in the macOS binaries.
 
 <!-- truncate -->

diff --git a/website/blog/2023-08-04-clang-v15-0-7-3-released.mdx b/website/blog/2023-08-04-clang-v15-0-7-3-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **15.0.7-3** is a maintenance release; it fixes the include path on macOS and reverts to the GNU/Linux libraries.
 
 <!-- truncate -->

diff --git a/website/blog/2023-08-05-clang-v15-0-7-4-released.mdx b/website/blog/2023-08-05-clang-v15-0-7-4-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **15.0.7-4** is a maintenance release; it fixes the wrong InstalledDir when clang is invoked via a link from a different folder.
 
 <!-- truncate -->

diff --git a/website/blog/2023-08-06-clang-v16-0-6-1-released.mdx b/website/blog/2023-08-06-clang-v16-0-6-1-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **16.0.6-1** is a new release; it follows the upstream release.
 
 <!-- truncate -->

diff --git a/website/blog/2023-12-04-clang-v17-0-6-1-released.mdx b/website/blog/2023-12-04-clang-v17-0-6-1-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **17.0.6-1** is a new release; it follows the upstream release.
 
 <!-- truncate -->

diff --git a/website/blog/2024-05-28-clang-v17-0-6-2-released.mdx b/website/blog/2024-05-28-clang-v17-0-6-2-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **17.0.6-2** is a maintenance release; it fixes the macOS build.
 
 <!-- truncate -->

diff --git a/website/blog/2024-06-21-clang-v17-0-6-3-released.mdx b/website/blog/2024-06-21-clang-v17-0-6-3-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **17.0.6-3** is a maintenance release; it fixes the arm 32-bit binaries.
 
 <!-- truncate -->

diff --git a/website/blog/2024-06-25-clang-v18-1-8-1-released.mdx b/website/blog/2024-06-25-clang-v18-1-8-1-released.mdx
@@ -31,6 +31,8 @@ import {PageMetadata} from '@docusaurus/theme-common';
 import Image from '@theme/IdealImage';
 import CodeBlock from '@theme/CodeBlock';
 
+{/* ------------------------------------------------------------------------ */}
+
 Version **18.1.8-1** is a new release; it follows the upstream release.
 
 <!-- truncate -->

diff --git 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
@@ -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
@@ -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 <code>buils-assets/build/{props.platform}/deploy</code> folder:
+the <code>build-assets/build/{props.platform}/deploy</code> folder:
 
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>

diff --git 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 <code>buils-assets/build/{props.platform}/deploy</code> folder:
+the <code>build-assets/build/{props.platform}/deploy</code> folder:
 
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>

diff --git a/website/docs/developer/index.mdx b/website/docs/developer/index.mdx
@@ -33,17 +33,17 @@ import More from './_more.mdx'
 
 [![license](https://img.shields.io/github/license/xpack-dev-tools/clang-xpack)](https://github.com/xpack-dev-tools/clang-xpack/blob/xpack/LICENSE)
 
-This page is intended for those who want to build the
+This page is designed for developers of the
 **xPack LLVM clang**
-binaries themselves.
+project and provides documentation on how to build and test the package.
 
 <details>
 <summary>The xPack Build Box</summary>
 
 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,17 +144,17 @@ xpm run build --config darwin-x64
 </details>
 
 <details>
-<summary>xPack actions</summary>
+<summary>xpm/xPack actions</summary>
 
-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 <name>` to perform specific
 operations.
 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.
 <details>
 <summary>Visual Studio Code integration</summary>
 
-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
@@ -95,20 +95,20 @@ 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
 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.
 </details>
 
 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
@@ -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 `<project>/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.
 
 </details>
 

diff --git 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/clang-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/clang-xpack.git/build-assets
+xpm run clear-all-projects-builds -C ~/Work/xpack-dev-tools/clang-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 <code>buils-assets/build/{props.platform}/deploy</code> folder:
+the <code>build-assets/build/{props.platform}/deploy</code> folder:
 
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}</code>
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.{props.platform === 'win32-x64' ? 'zip' : 'tar.gz'}.sha</code>

diff --git 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/clang-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/clang-xpack.git/build-assets
+xpm run clear-all-projects-builds -C ~/Work/xpack-dev-tools/clang-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/c
 
 {developmentDurations[ props.platform ]}, the output of the build script is a compressed
 archive and its SHA signature, created in
-the <code>buils-assets/build/{props.platform}/deploy</code> folder:
+the <code>build-assets/build/{props.platform}/deploy</code> folder:
 
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.tar.gz</code>
 * <code>xpack-clang-{customField('xpackVersion')}-{props.platform}.tar.gz.sha</code>