Skip to content

Commit 7fdeba3

Browse files
committed
website: updates
1 parent cc98564 commit 7fdeba3

File tree

4 files changed

+66
-21
lines changed

4 files changed

+66
-21
lines changed

website/docs/install/index.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,15 +234,16 @@ mandatory to identify the package as an **xpm package**.
234234
### Install into the project
235235

236236
The next step is to install the
237-
**sed** package into the project:
237+
**sed** package into the project.
238+
239+
The command to install the **latest** available version of **sed** is:
238240

239241
<CodeBlock language="sh"> {
240242
`xpm install @xpack-dev-tools/sed@latest --verbose
241243
`} </CodeBlock>
242244

243-
This command will install the latest available version.
244245

245-
To install a specific version, mention it explicitly:
246+
To install a **specific version**, specify it explicitly:
246247

247248
<CodeBlock language="sh"> {
248249
`xpm install @xpack-dev-tools/sed@${customField('version')} --verbose

website/docs/maintainer/_common/_arm-toolchain-check-upstream-release.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ as below.
2222
- download the new _Source code_ archive (like
2323
<code>arm-gnu-toolchain-src-snapshot-{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}.tar.xz</code>) from
2424
[Arm GNU Toolchain Downloads](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads/)
25+
- unpack the archive
2526
- the GCC version is in `gcc/gcc/BASE-VER`
27+
- the binutils version is in `binutils-gdb/bfd/version.m4`
2628
- the GDB version is in `binutils-gdb--gdb/gdb/version.in`
2729
- the newlib version is in `newlib-cygwin/newlib/configure`, search for `VERSION=`
2830
- download the latest **macOS (x86_64) hosted cross toolchains** archive (like
@@ -31,6 +33,12 @@ as below.
3133
- create a folder <code>build-assets/extras/{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
3234
- copy the file with the configurations
3335
(<code>{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-darwin-x86_64--manifest.txt</code>) to the new folder in extras
34-
- download the ABE manifest with the individual source URLs
35-
(<code>arm-gnu-toolchain--abe-manifest.txt</code>)
36+
- download the manifest.txt with the individual source URLs
37+
(<code>arm-gnu-toolchain-src-snapshot-{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-manifest.txt</code>)
3638
- copy to the new folder in extras
39+
40+
:::info
41+
42+
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.
43+
44+
:::

website/docs/maintainer/_common/_arm-toolchain-update-version-specific.mdx

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ import versionMinor from '@site/src/libs/versionMinor';
1818
With a Git client:
1919

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

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

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

3942
With a Git client:
4043

4144
- checkout the branch mentioned in the release notes
4245
(like <code>ARM/arm-{versionMajor()}</code>)
43-
- identify the commit ID (filter by branch and search downwards)
44-
- create a branch like <code>arm-{customField('gdbVersionMajor')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
46+
- push it to origin with the same name
47+
- enable a filter on the current branch
48+
- identify the commit ID from release notes or manifest.txt (search back in time)
49+
- create a branch like <code>arm-{versionMajor()}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-xpack</code>
50+
- create a tag like <code>arm-{versionMajor()}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
51+
- push the tag to origin
52+
- check the tag at https://github.com/xpack-dev-tools/gcc/tags/
53+
- cherry pick the `system.h: do not define abort() on mingw` commit
54+
- push the *-xpack branch to origin
55+
- save as Patches into the helper `patches` folder
56+
- rename as <code>gcc-{customField('upstreamVersion')}-cross.git.patch</code>
57+
58+
### Update the local newlib-cygwin fork (optional, normally the archive is used)
59+
60+
With a Git client:
61+
62+
- pull from the `master` branch (none mentioned in the release notes)
63+
- push it to origin with the same name
64+
- enable a filter on the current branch
65+
- identify the commit ID from release notes or manifest.txt (search back in time)
66+
- create a tag like <code>newlib-{customField('newlibVersion')}--{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}</code>
67+
- push the tag to origin
68+
- check the tag at https://github.com/xpack-dev-tools/newlib-cygwin/tags/
4569

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

4872
Copy/paste a previous one; adjust if necessary.
4973

74+
### Update other dependencies versions
75+
76+
Check the release notes and updates the `libgmp`, `libisl`, `libmpfr`, `libmpc`, `libiconv` versions.
77+
5078
### Check configure options
5179

5280
Verify if the configure options used in
53-
the <code>arm-gnu-toolchain--abe-manifest.txt</code> file
81+
the <code>{versionMajor()}.{versionMinor()}.rel{customField('armSubRelease')}-darwin-x86_64--manifest.txt</code> file
5482
are used in the build scripts.

website/docs/maintainer/index.mdx

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,8 @@ and will be updated when the new release is out.
160160
Check the latest versions at https://github.com/xpack-dev-tools/ and
161161
update the dependencies in `build-assets/package.json`.
162162

163+
<CheckUpstreamRelease/>
164+
163165
### Increase the version and update it in the top `package.json`
164166

165167
- determine the version (like <code>{customField('xpackVersion')}</code>)
@@ -172,6 +174,10 @@ like <code>{customField('xpackVersion')}.{customField('npmSubversion')}.pre</cod
172174
If the project uses `customFields` in `build-assets/package.json`,
173175
update them.
174176

177+
### Update the website commons
178+
179+
Run the `website-generate-commons` actions from `build-assets`.
180+
175181
### Start the local web server
176182

177183
Execute the npm script `clean` then `start` in the website sub-project,
@@ -190,10 +196,8 @@ Determine the version (like <code>{customField('xpackVersion')}</code>)
190196
and update the `build-assets/scripts/VERSION` file; the format
191197
is <code>{customField('xpackVersion')}</code>.
192198
{isXpackSubversionDouble() ?
193-
'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' :
194-
'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'}.
195-
196-
<CheckUpstreamRelease/>
199+
'The fourth & fifth numbers are the xPack release number of this version. A sixth' :
200+
'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.
197201

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

@@ -396,13 +400,15 @@ caffeinate ssh xbbla32
396400
Copy the trees displayed at the end of the test builds and paste to
397401
**Folder hierarchy** section in the web file:
398402

399-
- `website/docs/install/_miscellaneous.mdx`
403+
- `website/docs/install/_folders-hierarchies-linux.mdx`
404+
- `website/docs/install/_folders-hierarchies-macos.mdx`
405+
- `website/docs/install/_folders-hierarchies-windows.mdx`
400406

401407
If present, replace the actual version
402-
(like **{customField('xpackVersion')}**) with the following expression:
408+
(like **{customField('upstreamVersion')}**) with the following expression:
403409

404410
```txt
405-
${customField('xpackVersion')}
411+
${customField('upstreamVersion')}
406412
```
407413

408414
:::tip
@@ -413,21 +419,23 @@ via HomeBrew, and make a link to `/usr/local/bin`.
413419

414420
:::
415421

422+
- commit with _**website: update folder hierarchies**_.
423+
416424
### Update the list of links in top package.json
417425

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

423-
Commit if necessary.
431+
Commit if necessary with _**package.json: update executables links**_
424432

425433
### Update the durations of the development builds
426434

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

430-
Commit if necessary.
438+
Commit if necessary with _**website: update development durations**_
431439

432440
### How to build a debug version
433441

0 commit comments

Comments
 (0)