Skip to content

Commit

Permalink
website: updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Dec 30, 2024
1 parent 3cc197a commit ef22fa9
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 21 deletions.
7 changes: 4 additions & 3 deletions website/docs/install/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,15 +234,16 @@ mandatory to identify the package as an **xpm package**.
### Install into the project

The next step is to install the
**riscv-none-elf-gcc** package into the project:
**riscv-none-elf-gcc** package into the project.

The command to install the **latest** available version of **riscv-none-elf-gcc** is:

<CodeBlock language="sh"> {
`xpm install @xpack-dev-tools/riscv-none-elf-gcc@latest --verbose
`} </CodeBlock>

This command will install the latest available version.

To install a specific version, mention it explicitly:
To install a **specific version**, specify it explicitly:

<CodeBlock language="sh"> {
`xpm install @xpack-dev-tools/riscv-none-elf-gcc@${customField('version')} --verbose
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ as below.
- download the new _Source code_ archive (like
<code>arm-gnu-toolchain-src-snapshot-{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}.tar.xz</code>) from
[Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads/)
- unpack the archive
- the GCC version is in `gcc/gcc/BASE-VER`
- the binutils version is in `binutils-gdb/bfd/version.m4`
- the GDB version is in `binutils-gdb--gdb/gdb/version.in`
- the newlib version is in `newlib-cygwin/newlib/configure`, search for `VERSION=`
- download the latest **macOS (x86_64) hosted cross toolchains** archive (like
Expand All @@ -31,6 +33,12 @@ as below.
- create a folder <code>build-assets/extras/{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
- copy the file with the configurations
(<code>{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-darwin-x86_64--manifest.txt</code>) to the new folder in extras
- download the ABE manifest with the individual source URLs
(<code>arm-gnu-toolchain--abe-manifest.txt</code>)
- download the manifest.txt with the individual source URLs
(<code>arm-gnu-toolchain-src-snapshot-{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-manifest.txt</code>)
- copy to the new folder in extras

:::info

Starting with 14.2.Rel1 there is a link to a [README](https://gitlab.arm.com/tooling/gnu-devtools-for-arm/-/blob/main/README.md) explaining the new build scripts.

:::
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ import versionMinor from '@site/src/libs/versionMinor';
With a Git client:

- checkout the branch mentioned in the release notes
(like <code>binutils-{customField('binutilsVersionMajor')}_{customField('binutilsVersionMinor')}-branch</code>)
(like <code>users/ARM/binutils-{customField('binutilsVersionMajor')}_{customField('binutilsVersionMinor')}-branch</code>)
- push it to origin with the same name
- identify the commit ID (search back in time)
- enable a filter on the current branch
- identify the commit ID from release notes or manifest.txt (search back in time)
- add a tag like <code>binutils-{customField('binutilsVersionMajor')}.{customField('binutilsVersionMinor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
- push the tag to origin
- check the tag at https://github.com/xpack-dev-tools/binutils-gdb/tags/
Expand All @@ -29,26 +30,53 @@ Similarly for GDB:

- checkout the branch mentioned in the release notes
(like <code>gdb-{customField('gdbVersionMajor')}-branch</code>)
- identify the commit ID (search back in time)
- push it to origin with the same name
- enable a filter on the current branch
- identify the commit ID from release notes or manifest.txt (search back in time)
- add a tag like <code>gdb-{customField('gdbVersionMajor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
- push the tag to origin
- check the tag at https://github.com/xpack-dev-tools/binutils-gdb/tags/

### Update the local gcc fork (if the commit ID present in manifest.txt)
### Update the local gcc fork (optional, normally the archive is used)

With a Git client:

- checkout the branch mentioned in the release notes
(like <code>ARM/arm-{versionMajor()}</code>)
- identify the commit ID (filter by branch and search downwards)
- create a branch like <code>arm-{customField('gdbVersionMajor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
- push it to origin with the same name
- enable a filter on the current branch
- identify the commit ID from release notes or manifest.txt (search back in time)
- create a branch like <code>arm-{versionMajor()}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-xpack</code>
- create a tag like <code>arm-{versionMajor()}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
- push the tag to origin
- check the tag at https://github.com/xpack-dev-tools/gcc/tags/
- cherry pick the `system.h: do not define abort() on mingw` commit
- push the *-xpack branch to origin
- save as Patches into the helper `patches` folder
- rename as <code>gcc-{customField('upstreamVersion')}-cross.git.patch</code>

### Update the local newlib-cygwin fork (optional, normally the archive is used)

With a Git client:

- pull from the `master` branch (none mentioned in the release notes)
- push it to origin with the same name
- enable a filter on the current branch
- identify the commit ID from release notes or manifest.txt (search back in time)
- create a tag like <code>newlib-{customField('newlibVersion')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
- push the tag to origin
- check the tag at https://github.com/xpack-dev-tools/newlib-cygwin/tags/

### Update the gdb-*-cross.git.patch in helper

Copy/paste a previous one; adjust if necessary.

### Update other dependencies versions

Check the release notes and updates the `libgmp`, `libisl`, `libmpfr`, `libmpc`, `libiconv` versions.

### Check configure options

Verify if the configure options used in
the <code>arm-gnu-toolchain--abe-manifest.txt</code> file
the <code>{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-darwin-x86_64--manifest.txt</code> file
are used in the build scripts.
26 changes: 17 additions & 9 deletions website/docs/maintainer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,8 @@ and will be updated when the new release is out.
Check the latest versions at https://github.com/xpack-dev-tools/ and
update the dependencies in `build-assets/package.json`.

<CheckUpstreamRelease/>

### Increase the version and update it in the top `package.json`

- determine the version (like <code>{customField('xpackVersion')}</code>)
Expand All @@ -173,6 +175,10 @@ like <code>{customField('xpackVersion')}.{customField('npmSubversion')}.pre</cod
If the project uses `customFields` in `build-assets/package.json`,
update them.

### Update the website commons

Run the `website-generate-commons` actions from `build-assets`.

### Start the local web server

Execute the npm script `clean` then `start` in the website sub-project,
Expand All @@ -191,10 +197,8 @@ Determine the version (like <code>{customField('xpackVersion')}</code>)
and update the `build-assets/scripts/VERSION` file; the format
is <code>{customField('xpackVersion')}</code>.
{isXpackSubversionDouble() ?
'The fourth & fifth numbers are the xPack release number of this version. A sixth number will be added to the version in `package.json` when the package is published to the `npm` server' :
'The fourth number is the xPack release number of this version. A fifth number will be added to the version in `package.json` when the package is published to the `npm` server'}.

<CheckUpstreamRelease/>
'The fourth & fifth numbers are the xPack release number of this version. A sixth' :
'The fourth number is the xPack release number of this version. A fifth'} number will be added to the version in `package.json` when the package is published to the `npm` server.

### Update the `customFields` (if necessary)

Expand Down Expand Up @@ -407,13 +411,15 @@ caffeinate ssh xbbla32
Copy the trees displayed at the end of the test builds and paste to
**Folder hierarchy** section in the web file:

- `website/docs/install/_miscellaneous.mdx`
- `website/docs/install/_folders-hierarchies-linux.mdx`
- `website/docs/install/_folders-hierarchies-macos.mdx`
- `website/docs/install/_folders-hierarchies-windows.mdx`

If present, replace the actual version
(like **{customField('xpackVersion')}**) with the following expression:
(like **{customField('upstreamVersion')}**) with the following expression:

```txt
${customField('xpackVersion')}
${customField('upstreamVersion')}
```

:::tip
Expand All @@ -424,21 +430,23 @@ via HomeBrew, and make a link to `/usr/local/bin`.

:::

- commit with _**website: update folder hierarchies**_.

### Update the list of links in top package.json

Copy/paste the full list of links displayed at the end of the build, in
sequence, for each platform (Windows, macOS, GNU/Linux),
and check the
differences compared to the repository.

Commit if necessary.
Commit if necessary with _**package.json: update executables links**_

### Update the durations of the development builds

In `website/docs/maintainer/_development-durations.mdx`, update
the durations of the builds.

Commit if necessary.
Commit if necessary with _**website: update development durations**_

### How to build a debug version

Expand Down

0 comments on commit ef22fa9

Please sign in to comment.