diff --git a/README.md b/README.md index e4e3793..f4db2b6 100644 --- a/README.md +++ b/README.md @@ -3,278 +3,21 @@ [![npm (scoped)](https://img.shields.io/npm/v/@xpack-dev-tools/riscv-none-elf-gcc.svg?color=blue)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/) [![license](https://img.shields.io/github/license/xpack-dev-tools/riscv-none-elf-gcc-xpack)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/blob/xpack/LICENSE) -## The xPack GNU RISC-V Embedded GCC +# The xPack GNU RISC-V Embedded GCC -A standalone cross-platform (Windows/macOS/Linux) **GNU RISC-V Embedded GCC** -binary distribution, intended for reproducible builds. +A standalone cross-platform (Windows, macOS, GNU/Linux) +binary distribution of GNU RISC-V Embedded GCC, +intended for reproducible builds. -In addition to the the binary archives and the package meta data, -this project also includes the build scripts. +## Project documentation -### Upgrade notice - -This project replaces the deprecated -[`xpack-dev-tools/riscv-none-embed-gcc-xpack`](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack) -project, which followed the SiFive releases; upgrade your projects to get further updates. - -## Overview - -This open source project is hosted on GitHub as -[`xpack-dev-tools/riscv-none-elf-gcc-xpack`](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack) -and provides the platform specific binaries for the -[xPack GNU RISC-V Embedded GCC](https://xpack.github.io/riscv-none-elf-gcc/). - -The binaries can be installed automatically as **binary xPacks** or manually as -**portable archives**. - -## Release schedule - -This distribution plans to follow the official -[GNU](https://gcc.gnu.org/releases.html) release schedule. -To save some time, the initial X.1 release will be skipped. -Updates for previous releases, -like (X-1).3, (X-2).4, (X-3).5, are also planned. - -## User info - -This section is intended as a shortcut for those who plan -to use the GNU RISC-V Embedded GCC binaries. For full details please read the -[xPack GNU RISC-V Embedded GCC](https://xpack.github.io/riscv-none-elf-gcc/) pages. - -### Easy install - -The easiest way to install GNU RISC-V Embedded GCC is using the **binary xPack**, available as -[`@xpack-dev-tools/riscv-none-elf-gcc`](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc) -from the [`npmjs.com`](https://www.npmjs.com) registry. - -#### Prerequisites - -A recent [xpm](https://xpack.github.io/xpm/), -which is a portable [Node.js](https://nodejs.org/) command line application -that complements [npm](https://docs.npmjs.com) -with several extra features specific to -**C/C++ projects**. - -It is recommended to install/update to the latest version with: - -```sh -npm install --location=global xpm@latest -``` - -For details please follow the instructions in the -[xPack install](https://xpack.github.io/install/) page. - -#### Install - -With the `xpm` tool available, installing -the latest version of the package and adding it as -a development dependency for a project is quite easy: - -```sh -cd my-project -xpm init # Add a package.json if not already present - -xpm install @xpack-dev-tools/riscv-none-elf-gcc@latest --verbose - -ls -l xpacks/.bin -``` - -This command will: - -- install the latest available version, -into the central xPacks store, if not already there -- add symbolic links to the central store -(or `.cmd` forwarders on Windows) into -the local `xpacks/.bin` folder. - -The central xPacks store is a platform dependent -location in the home folder; -check the output of the `xpm` command for the actual -folder used on your platform. -This location is configurable via the environment variable -`XPACKS_STORE_FOLDER`; for more details please check the -[xpm folders](https://xpack.github.io/xpm/folders/) page. - -For xPacks aware tools, like the **Eclipse Embedded C/C++ plug-ins**, -it is also possible to install GNU RISC-V Embedded GCC globally, in the user home folder: - -```sh -xpm install --global @xpack-dev-tools/riscv-none-elf-gcc@latest --verbose -``` - -Eclipse will automatically -identify binaries installed with -`xpm` and provide a convenient method to manage paths. - -After install, the package should create a structure like this (only the -first two depth levels are shown): - -```console -$ tree -L 2 /Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/14.1.0-1/.content/ -/Users/ilg/Library/xPacks/\@xpack-dev-tools/riscv-none-elf-gcc/14.1.0-1/.content/ -├── README.md -├── bin -│   ├── riscv-none-elf-addr2line -│   ├── riscv-none-elf-ar -│   ├── riscv-none-elf-as -│   ├── riscv-none-elf-c++ -│   ├── riscv-none-elf-c++filt -│   ├── riscv-none-elf-cpp -│   ├── riscv-none-elf-elfedit -│   ├── riscv-none-elf-g++ -│   ├── riscv-none-elf-gcc -│   ├── riscv-none-elf-gcc-14.1.0 -│   ├── riscv-none-elf-gcc-ar -│   ├── riscv-none-elf-gcc-nm -│   ├── riscv-none-elf-gcc-ranlib -│   ├── riscv-none-elf-gcov -│   ├── riscv-none-elf-gcov-dump -│   ├── riscv-none-elf-gcov-tool -│   ├── riscv-none-elf-gdb -│   ├── riscv-none-elf-gdb-add-index -│   ├── riscv-none-elf-gdb-add-index-py3 -│   ├── riscv-none-elf-gdb-py3 -│   ├── riscv-none-elf-gfortran -│   ├── riscv-none-elf-gprof -│   ├── riscv-none-elf-ld -│   ├── riscv-none-elf-ld.bfd -│   ├── riscv-none-elf-lto-dump -│   ├── riscv-none-elf-nm -│   ├── riscv-none-elf-objcopy -│   ├── riscv-none-elf-objdump -│   ├── riscv-none-elf-ranlib -│   ├── riscv-none-elf-readelf -│   ├── riscv-none-elf-size -│   ├── riscv-none-elf-strings -│   └── riscv-none-elf-strip -├── distro-info -│   └── licenses -├── include -│   └── gdb -├── lib -│   ├── bfd-plugins -│   ├── gcc -│   ├── libcc1.0.so -│   ├── libcc1.so -> libcc1.0.so -│   └── python3.11 -├── libexec -│   ├── gcc -│   ├── libbz2.1.0.8.dylib -│   ├── libcrypt.2.dylib -│   ├── libcrypto.1.1.dylib -│   ├── libexpat.1.8.10.dylib -│   ├── libexpat.1.dylib -> libexpat.1.8.10.dylib -│   ├── libffi.8.dylib -│   ├── libgmp.10.dylib -│   ├── libiconv.2.dylib -│   ├── libisl.23.dylib -│   ├── liblzma.5.dylib -│   ├── libmpc.3.dylib -│   ├── libmpfr.6.dylib -│   ├── libncurses.6.dylib -│   ├── libpanel.6.dylib -│   ├── libpython3.11.dylib -│   ├── libreadline.8.2.dylib -│   ├── libreadline.8.dylib -> libreadline.8.2.dylib -│   ├── libsqlite3.0.dylib -│   ├── libssl.1.1.dylib -│   ├── libz.1.2.13.dylib -│   ├── libz.1.dylib -> libz.1.2.13.dylib -│   └── libzstd.1.5.5.dylib -├── riscv-none-elf -│   ├── bin -│   ├── include -│   ├── lib -│   └── share -└── share - └── gcc-14.1.0 - -19 directories, 58 files -``` - -No other files are installed in any system folders or other locations. - -#### Uninstall - -To remove the links created by xpm in the current project: - -```sh -cd my-project - -xpm uninstall @xpack-dev-tools/riscv-none-elf-gcc -``` - -To completely remove the package from the central xPack store: - -```sh -xpm uninstall --global @xpack-dev-tools/riscv-none-elf-gcc -``` - -### Manual install - -For all platforms, the **xPack GNU RISC-V Embedded GCC** -binaries are released as portable -archives that can be installed in any location. - -The archives can be downloaded from the -GitHub [Releases](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/) -page. - -For more details please read the -[Install](https://xpack.github.io/riscv-none-elf-gcc/install/) page. - -### Versioning - -The version strings used by the GCC project are three number strings -like `14.1.0`; to this string the xPack distribution adds a four number, -but since semver allows only three numbers, all additional ones can -be added only as pre-release strings, separated by a dash, -like `14.1.0-1`. -When published as a npm package, the version gets -a fifth number, like `14.1.0-1.1`. - -Since adherence of third party packages to semver is not guaranteed, -it is recommended to use semver expressions like `^14.1.0` and `~14.1.0` -with caution, and prefer exact matches, like `14.1.0-1.1`. - -## Maintainer info - -For maintainer info, please see the -[README-MAINTAINER](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/blob/xpack/README-MAINTAINER.md). - -## Support - -The quick advice for getting support is to use the GitHub -[Discussions](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/discussions/). - -For more details please read the -[Support](https://xpack.github.io/riscv-none-elf-gcc/support/) page. +For information on how to install and use the tools provided by this project, +please refer to the +[project web site](https://xpack-dev-tools.github.io/riscv-none-elf-gcc-xpack/). ## License -Unless otherwise stated, the content is released under the terms of the +Unless otherwise stated, the original content is released under the terms of the [MIT License](https://opensource.org/licenses/mit/), with all rights reserved to [Liviu Ionescu](https://github.com/ilg-ul). - -The binary distributions include several open-source components; the -corresponding licenses are available in the installed -`distro-info/licenses` folder. - -## Download analytics - -- GitHub [`xpack-dev-tools/riscv-none-elf-gcc-xpack`](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/) repo - - latest xPack release -[![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/latest/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/) - - all xPack releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/) - - previous `riscv-none-elf-gcc` releases [![Github All Releases](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-elf-gcc-xpack/total.svg)](https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack/releases/) - - [individual file counters](https://somsubhra.github.io/github-release-stats/?username=xpack-dev-tools&repository=riscv-none-elf-gcc-xpack) (grouped per release) -- npmjs.com [`@xpack-dev-tools/riscv-none-elf-gcc`](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/) xPack - - latest release, per month -[![npm (scoped)](https://img.shields.io/npm/v/@xpack-dev-tools/riscv-none-elf-gcc.svg)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/) -[![npm](https://img.shields.io/npm/dm/@xpack-dev-tools/riscv-none-elf-gcc.svg)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/) - - all releases [![npm](https://img.shields.io/npm/dt/@xpack-dev-tools/riscv-none-elf-gcc.svg)](https://www.npmjs.com/package/@xpack-dev-tools/riscv-none-elf-gcc/) - -Credit to [Shields IO](https://shields.io) for the badges and to -[Somsubhra/github-release-stats](https://github.com/Somsubhra/github-release-stats) -for the individual file counters. diff --git a/website/docs/developer-info/_common/_platform-docker-section.mdx b/website/docs/developer-info/_common/_platform-docker-section.mdx index f6064a1..e4d499e 100644 --- a/website/docs/developer-info/_common/_platform-docker-section.mdx +++ b/website/docs/developer-info/_common/_platform-docker-section.mdx @@ -40,7 +40,8 @@ To prepare the docker build on { platforms[props.platform].machineName }: xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } -or, with the writable helper: +
+... or, with the writable helper ... { `xpm run install -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \\ @@ -49,16 +50,18 @@ xpm run docker-prepare --config ${ props.platform } -C ~/Work/xpack-dev-tools/ri xpm run docker-link-deps --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } +
+ To run the build: { `xpm run docker-build --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } -or, for more verbosity: +or, for more verbosity, invoke the development build: { -`xpm run docker-build-develop --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` +`xpm run docker-build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } { durations[ props.platform ] }, the output of the build script is a compressed @@ -70,6 +73,6 @@ archive and its SHA signature, created in the `deploy` folder: To rerun the build, invoke the deep-clean action and repeat from install: { -`xpm run deep-clean --config { props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` +`xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } diff --git a/website/docs/developer-info/_common/_platform-native-section.mdx b/website/docs/developer-info/_common/_platform-native-section.mdx index 7bcc84e..50138a3 100644 --- a/website/docs/developer-info/_common/_platform-native-section.mdx +++ b/website/docs/developer-info/_common/_platform-native-section.mdx @@ -30,7 +30,8 @@ To prepare the native build on { platforms[props.platform].machineName }: xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } -or, with the writable helper: +
+... or, with the writable helper ... { `xpm run install -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \\ @@ -38,16 +39,18 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \\ xpm install --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } +
+ To run the build: { `xpm run build --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } -or, for more verbosity: +or, for more verbosity, invoke the development build: { -`xpm run build-develop --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` +`xpm run build-development --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } { durations[ props.platform ] }, the output of the build script is a compressed @@ -59,6 +62,6 @@ archive and its SHA signature, created in the `deploy` folder: To rerun the build, invoke the deep-clean action and repeat from install: { -`xpm run deep-clean --config { props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` +`xpm run deep-clean --config ${ props.platform } -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git` } diff --git a/website/docs/developer-info/index.mdx b/website/docs/developer-info/index.mdx index ccd1839..8570669 100644 --- a/website/docs/developer-info/index.mdx +++ b/website/docs/developer-info/index.mdx @@ -26,7 +26,14 @@ This page is intended for those who want to build the **xPack GNU RISC-V Embedded GCC** binaries themselves. -## The xPack Build Box +:::note + +The content of this page is still work in progress and will be updated shortly. + +::: + +
+The xPack Build Box The build scripts in this project use the **xPack Build Box** (**XBB**) tools, which require the usual native development tools @@ -48,6 +55,132 @@ for inexperienced users. ::: +
+ +
+xPack build configurations + +The xPack framework supports projects with **multiple build configurations**. + +Build configurations are sets of **properties**, **actions** and **dependencies** +that apply to a specific build. Build configurations can inherit from +other build configurations. + +For simple projects, the typical use case is with two configurations, +**Debug** and **Release**. + +For building the xPack binary tools, there is one configuration +for each platform: + +- `darwin-x64` +- `darwin-arm64` +- `linux-x64` +- `win32-x64` +- `linux-arm64` +- `linux-arm` + +:::note + +In case you wonder where these names come +from, they are exactly the Node.js `process.platform` and `process.arch` +for each platform. + +::: + +The build configurations are defined in the `package.json` file, in the +`xpack` section. + + +```json +{ + "...":"...", + "xpack": { + "buildConfigurations": { + "...": { + }, + "win32-x64": { + "inherit": [ + "common-dependencies", + "common-actions", + "common-docker" + ], + "devDependencies": { + "@xpack-dev-tools/gcc": "13.2.0-2.1", + "@xpack-dev-tools/mingw-w64-gcc": "13.2.0-1.1", + "@xpack-dev-tools/wine": "8.0.2-1.1" + }, + "properties": { + "dockerImage": "ilegeul/ubuntu:amd64-18.04-xbb-v5.1.1" + }, + "actions": { + "build": "{{ properties.commandBashBuild }} --windows", + "build-development": "{{ properties.commandBashBuild }} --windows --develop", + "build-development-debug": "{{ properties.commandBashBuild }} --windows --develop --debug", + "build-development-tests-only": "{{ properties.commandBashBuild }} --windows --develop --tests-only" + } + } + } + } +} +``` + + +To ask **xpm** to perform a specific action on a given build configuration, +use the `--config ` option. + +For example: + +```sh +xpm install --config darwin-x64 +xpm run build --config darwin-x64 +``` + +
+ +
+xPack actions + +The xPack 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 . + +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. + +Actions can be defined for the entire project or for a specific build +configuration. + +The actions are defined in the `package.json` file, in the +`xpack` section, at the top or inside build configurations. + +:::tip + +For those who, for various reasons, can not use **xpm**, it is +perfectly possible to manually adjust the PATH and to invoke the +sequence of commands in order, just that it is more tedious, +since multiple substitutions must be performed to compose the +commands. + +::: + +
+ +
+Visual Studio Code integration + +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 +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) + +
+ ## Prerequisites The build scripts run on GNU/Linux and macOS. The Windows binaries are @@ -62,6 +195,22 @@ The project is hosted on GitHub: - https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +
+Branches + +Apart from the unused `master` branch, there are two active branches: + +- `xpack`, with the latest stable version (default) +- `xpack-develop`, with the current development version + +All development is done in the `xpack-develop` branch, and contributions via +Pull Requests should be directed to this branch. + +When new releases are published, the `xpack-develop` branch is merged +into `xpack`. + +
+ To clone the stable branch (`xpack`), run the following commands in a terminal (on Windows use the _Git Bash_ console): @@ -71,7 +220,8 @@ git clone https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack.git \ ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` -For development purposes, clone the `xpack-develop` branch: +
+For development purposes, clone the `xpack-develop` branch. ```sh rm -rf ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ @@ -82,7 +232,10 @@ git clone \ ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` -## Get helper sources (optional, for development purposes) +
+ +
+Get the helper sources (optional, for development purposes) The project has a dependency to a common **helper**, that is normally installed as a read-only dependency; **for development @@ -104,6 +257,8 @@ For more details the how a writable helper can be used via `xpm link`, please see the [XBB](https://xpack.github.io/xbb/#writable-helper-scripts) documentation. +
+ ## How to build @@ -118,26 +273,14 @@ Intel macOS and Apple Silicon macOS). git -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git pull ``` -and, if needed, the helper, when using a writable helper: +
+... and the helper (when using a writable helper) ... ```sh git -C ~/Work/xpack-dev-tools/xbb-helper-xpack.git pull ``` -### xPack actions - -The following instructions make use of xPack actions, which are a -an extension of npm scripts, i.e. sequences of commands executed -via `xpm run ` in an -environment where the PATH is adjusted to include the current project -dependencies. - -To see the commands associated with each action, see the `xpack.actions` -definitions in the `package.json` file. - -The [xPack C/C++ Managed Build Tools](https://marketplace.visualstudio.com/items?itemName=ilg-vscode.xpack) -Visual Studio Code extension -provides convenient upport to invoke xPack actions from the VS Code. +
### macOS builds @@ -161,8 +304,8 @@ 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-develop-debug` -and `docker-build-develop-debug`). +There are also xPack actions that use this option (`build-development-debug` +and `docker-build-development-debug`). ### Files cache diff --git a/website/docs/maintainer-info/index.mdx b/website/docs/maintainer-info/index.mdx index 3495114..111e34c 100644 --- a/website/docs/maintainer-info/index.mdx +++ b/website/docs/maintainer-info/index.mdx @@ -212,13 +212,13 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git xpm run deep-clean --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm install --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run build-develop --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run build-development --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` For a debug build: ```sh -xpm run build-develop-debug --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run build-development-debug --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` The build takes about 7 minutes. @@ -245,7 +245,7 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ \ xpm run deep-clean --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm install --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run build-develop --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run build-development --config darwin-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` Several minutes later, the output of the build script is a compressed @@ -276,7 +276,7 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ \ xpm run deep-clean --config darwin-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm install --config darwin-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run build-develop --config darwin-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run build-development --config darwin-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` Several minutes later, the output of the build script is a compressed @@ -309,7 +309,7 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run deep-clean --config linux-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-prepare --config linux-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-link-deps --config linux-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run docker-build-develop --config linux-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run docker-build-development --config linux-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` Several minutes later, the output of the build script is a compressed @@ -333,7 +333,7 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run deep-clean --config win32-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-prepare --config win32-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-link-deps --config win32-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run docker-build-develop --config win32-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run docker-build-development --config win32-x64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` Several minutes later, the output of the build script is a compressed @@ -364,7 +364,7 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run deep-clean --config linux-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-prepare --config linux-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-link-deps --config linux-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run docker-build-develop --config linux-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run docker-build-development --config linux-arm64 -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` About 10 minutes later (3 minutes on ampere), the output of the build script is a compressed @@ -395,7 +395,7 @@ xpm run link-deps -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run deep-clean --config linux-arm -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-prepare --config linux-arm -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ xpm run docker-link-deps --config linux-arm -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git && \ -xpm run docker-build-develop --config linux-arm -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git +xpm run docker-build-development --config linux-arm -C ~/Work/xpack-dev-tools/riscv-none-elf-gcc-xpack.git ``` About 10 minutes later, the output of the build script is a compressed @@ -422,8 +422,8 @@ 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-develop-debug` -and `docker-build-develop-debug`). +There are also xPack actions that use this option (`build-development-debug` +and `docker-build-development-debug`). ### Files cache diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 6547bbd..b4a55d4 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -143,7 +143,7 @@ const config: Config = { }, { type: 'dropdown', - label: 'Docs', + label: 'Documentation', to: 'docs/getting-started', position: 'left', items: [