Skip to content
This repository has been archived by the owner on Feb 28, 2023. It is now read-only.

Commit

Permalink
READMEs update for 8.3.0-2.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ilg-ul committed Oct 13, 2020
1 parent 4eec964 commit 792dabe
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 45 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Expand Up @@ -3,6 +3,10 @@

Releases in reverse chronological order.

### 2020-10-13

- v8.3.0-2.2 released

### 2020-10-11

- v8.3.0-2.2 prepared
Expand Down
50 changes: 25 additions & 25 deletions README-BUILD.md
Expand Up @@ -134,7 +134,7 @@ for new releases
### Identify the main GCC version

Determine the GCC version (like `8.3.0`) and update the `scripts/VERSION`
file; the format is `8.3.0-2.1`. The fourth digit is the number of the
file; the format is `8.3.0-2.2`. The fourth digit is the number of the
SiFive release of the same GCC version, and the fifth digit is the xPack
GNU RISC-V Embedded GCC release number of this version.

Expand Down Expand Up @@ -184,7 +184,7 @@ In both cases:

- push the two modified branches (like `sifive-binutils-2.32` and
`sifive-binutils-2.32-xpack`)
- add a tag with the current version (like `v8.3.0-2.1`), and push
- add a tag with the current version (like `v8.3.0-2.2`), and push
it to `origin`

- copy/paste the branch name and commit id tp common-versions-source.sh
Expand Down Expand Up @@ -229,7 +229,7 @@ In both cases:

- push the two modified branches (like `sifive-gcc-8.3.0` and
`sifive-gcc-8.3.0-xpack`)
- add a tag with the current version (like `v8.3.0-2.1`), and push
- add a tag with the current version (like `v8.3.0-2.2`), and push
it to `origin`.

### Update newlib
Expand Down Expand Up @@ -266,7 +266,7 @@ In both cases:

- push the two modified branches (like `sifive--master` and
`sifive--master-xpack`)
- add a tag with the current version (like `v8.3.0-2.1`), and push
- add a tag with the current version (like `v8.3.0-2.2`), and push
it to `origin`.

### Update gdb
Expand All @@ -281,13 +281,13 @@ For GDB, it is a bit tricky, since it must identify the GNU code in line
with what was used by SiFive; create a branch like `sifive-gdb-8.3`

- branch it into `sifive-gdb-8.3-xpack` and edit the prefix code
- add a tag like `v8.3.0-2.1-gdb`
- add a tag like `v8.3.0-2.2-gdb`

### Update container-build.sh

- add a new set of definitions in the `scripts/container-build.sh`, with
the versions of various components;
- update `GH_RELEASE` to the new version (like `8.3.0-2.1`, without `v`)
- update `GH_RELEASE` to the new version (like `8.3.0-2.2`, without `v`)
- in [SiFive Releases](https://github.com/sifive/freedom-tools/releases)
for new releases
- identify the tag of the latest release (like `v2019.08.0`)
Expand Down Expand Up @@ -398,14 +398,14 @@ their SHA signatures, created in the `deploy` folder:
```console
$ ls -l ~/Work/riscv-none-embed-gcc-*/deploy
total 1346668
-rw-rw-r-- 1 ilg ilg 347985751 Oct 10 14:22 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-x32.tar.gz
-rw-rw-r-- 1 ilg ilg 120 Oct 10 14:22 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-x32.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 343458303 Oct 10 11:55 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-x64.tar.gz
-rw-rw-r-- 1 ilg ilg 120 Oct 10 11:55 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-x64.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 337016277 Oct 10 14:58 xpack-riscv-none-embed-gcc-8.3.0-2.1-win32-x32.zip
-rw-rw-r-- 1 ilg ilg 117 Oct 10 14:58 xpack-riscv-none-embed-gcc-8.3.0-2.1-win32-x32.zip.sha
-rw-rw-r-- 1 ilg ilg 350502092 Oct 10 12:28 xpack-riscv-none-embed-gcc-8.3.0-2.1-win32-x64.zip
-rw-rw-r-- 1 ilg ilg 117 Oct 10 12:28 xpack-riscv-none-embed-gcc-8.3.0-2.1-win32-x64.zip.sha
-rw-rw-r-- 1 ilg ilg 347985751 Oct 10 14:22 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-x32.tar.gz
-rw-rw-r-- 1 ilg ilg 120 Oct 10 14:22 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-x32.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 343458303 Oct 10 11:55 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-x64.tar.gz
-rw-rw-r-- 1 ilg ilg 120 Oct 10 11:55 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-x64.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 337016277 Oct 10 14:58 xpack-riscv-none-embed-gcc-8.3.0-2.2-win32-x32.zip
-rw-rw-r-- 1 ilg ilg 117 Oct 10 14:58 xpack-riscv-none-embed-gcc-8.3.0-2.2-win32-x32.zip.sha
-rw-rw-r-- 1 ilg ilg 350502092 Oct 10 12:28 xpack-riscv-none-embed-gcc-8.3.0-2.2-win32-x64.zip
-rw-rw-r-- 1 ilg ilg 117 Oct 10 12:28 xpack-riscv-none-embed-gcc-8.3.0-2.2-win32-x64.zip.sha
```

To copy the files from the build machine to the current development
Expand Down Expand Up @@ -485,10 +485,10 @@ archives and their SHA signatures, created in the `deploy` folder:
```console
$ ls -l ~/Work/riscv-none-embed-gcc-*/deploy
total 667980
-rw-rw-r-- 1 ilg ilg 343409720 Oct 10 14:55 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-arm64.tar.gz
-rw-rw-r-- 1 ilg ilg 122 Oct 10 14:55 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-arm64.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 340579759 Oct 10 22:10 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-arm.tar.gz
-rw-rw-r-- 1 ilg ilg 120 Oct 10 22:10 xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-arm.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 343409720 Oct 10 14:55 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-arm64.tar.gz
-rw-rw-r-- 1 ilg ilg 122 Oct 10 14:55 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-arm64.tar.gz.sha
-rw-rw-r-- 1 ilg ilg 340579759 Oct 10 22:10 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-arm.tar.gz
-rw-rw-r-- 1 ilg ilg 120 Oct 10 22:10 xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-arm.tar.gz.sha
```

To copy the files from the build machine to the current development
Expand Down Expand Up @@ -538,8 +538,8 @@ and its SHA signature, created in the `deploy` folder:
```console
$ ls -l ~/Work/riscv-none-embed-gcc-*/deploy
total 666560
-rw-r--r-- 1 ilg staff 341272214 Oct 10 14:23 xpack-riscv-none-embed-gcc-8.3.0-2.1-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 121 Oct 10 14:23 xpack-riscv-none-embed-gcc-8.3.0-2.1-darwin-x64.tar.gz.sha
-rw-r--r-- 1 ilg staff 341272214 Oct 10 14:23 xpack-riscv-none-embed-gcc-8.3.0-2.2-darwin-x64.tar.gz
-rw-r--r-- 1 ilg staff 121 Oct 10 14:23 xpack-riscv-none-embed-gcc-8.3.0-2.2-darwin-x64.tar.gz.sha
```

To copy the files from the build machine to the current development
Expand Down Expand Up @@ -649,7 +649,7 @@ program from there. For example on macOS the output should
look like:

```console
$ /Users/ilg/Downloads/xPacks/riscv-none-embed-gcc/8.3.0-2.1/bin/riscv-none-embed-gcc --version
$ /Users/ilg/Downloads/xPacks/riscv-none-embed-gcc/8.3.0-2.2/bin/riscv-none-embed-gcc --version
riscv-none-embed-gcc (xPack RISC-V Embedded GCC, 64-bit) 8.3.0
```

Expand All @@ -666,8 +666,8 @@ After install, the package should create a structure like this (only the
first two depth levels are shown):

```console
$ tree -L 2 /Users/ilg/opt/xPacks/riscv-none-embed-gcc/8.3.0-2.1
/Users/ilg/opt/gnu-mcu-eclipse/riscv-none-embed-gcc/8.3.0-2.1
$ tree -L 2 /Users/ilg/opt/xPacks/riscv-none-embed-gcc/8.3.0-2.2
/Users/ilg/opt/gnu-mcu-eclipse/riscv-none-embed-gcc/8.3.0-2.2
├── README.md
├── riscv-none-embed
│   ├── bin
Expand All @@ -693,8 +693,8 @@ $ tree -L 2 /Users/ilg/opt/xPacks/riscv-none-embed-gcc/8.3.0-2.1
│   ├── riscv-none-embed-gcov-tool
│   ├── riscv-none-embed-gdb
│   ├── riscv-none-embed-gdb-add-index
│   ├── riscv-none-embed-gdb-add-index-py
│   ├── riscv-none-embed-gdb-py
│   ├── riscv-none-embed-gdb-add-index-py3
│   ├── riscv-none-embed-gdb-py3
│   ├── riscv-none-embed-gprof
│   ├── riscv-none-embed-ld
│   ├── riscv-none-embed-ld.bfd
Expand Down
40 changes: 20 additions & 20 deletions README-PUBLISH.md
Expand Up @@ -19,9 +19,9 @@ Be sure everything is committed and pushed

### Check tags

The names should look like `v8.3.0-2.1`.
The names should look like `v8.3.0-2.2`.

For the binutils-gdb repo, a separate tag like `v8.3.0-2.1-gdb` should be
For the binutils-gdb repo, a separate tag like `v8.3.0-2.2-gdb` should be
present, for the gdb build.

### Check the `CHANGELOG.md` file
Expand Down Expand Up @@ -96,12 +96,12 @@ $ git clone --recurse-submodules https://github.com/xpack-dev-tools/riscv-none-e
- commit and push the repo
- go to the [GitHub Releases](https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases) page
- click **Draft a new release**
- name the tag like **v8.3.0-2.1** (mind the dash in the middle!)
- name the tag like **v8.3.0-2.2** (mind the dash in the middle!)
- select the target branch (like sifive-gcc-8.3.0-gme)
- name the release like **xPack GNU RISC-V Embedded GCC v8.3.0-2.1**
- name the release like **xPack GNU RISC-V Embedded GCC v8.3.0-2.2**
(mind the dash and the space)
- as description
- add a downloads badge like `![Github Releases (by Release)](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/v8.3.0-2.1/total.svg)`; use empty URL for now
- add a downloads badge like `![Github Releases (by Release)](https://img.shields.io/github/downloads/xpack-dev-tools/riscv-none-embed-gcc-xpack/v8.3.0-2.2/total.svg)`; use empty URL for now
- draft a short paragraph explaining what are the main changes
- **attach binaries** and SHA (drag and drop from the archives folder will do it)
- **enable** the **pre-release** button
Expand All @@ -126,9 +126,9 @@ In the `xpack.github.io` web Git:

- add a new file to `_posts/releases/riscv-none-embed-gcc`
- name the file like `2020-10-10-riscv-none-embed-gcc-v8-3-0-2-1-released.md`
- name the post like: **xPack GNU RISC-V Embedded GCC v8.3.0-2.1 released**.
- name the post like: **xPack GNU RISC-V Embedded GCC v8.3.0-2.2 released**.
- as `download_url` use the tagged URL like
`https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/tag/v8.3.0-2.1/`
`https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/tag/v8.3.0-2.2/`
- update the `date:` field with the current date
- copy the list of commit IDs from the `README-<version>.sh` file
- generate the list of multilibs and copy/paste
Expand All @@ -147,25 +147,25 @@ Copy/paste the build report at the end of the post as:
The SHA-256 hashes for the files are:

2009f256e59291e1025cc099e4300d7662dda040b304fe3462b4cb7c35c71378
xpack-riscv-none-embed-gcc-8.3.0-2.1-darwin-x64.tar.gz
xpack-riscv-none-embed-gcc-8.3.0-2.2-darwin-x64.tar.gz

751f28a28148ddaec8cfcbf7eb794a70d24ee6650dc29da91e6aa672b9deae52
xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-arm64.tar.gz
xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-arm64.tar.gz

63f232cbeddbe968130f4c8386cca24c5e1410cc2551738d071b279a94cd8b75
xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-arm.tar.gz
xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-arm.tar.gz

1d99730d6e1e5d3a60fa0ccfbbcf0276e77dd83d58b6d8d1543cef40a1dd96ca
xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-x32.tar.gz
xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-x32.tar.gz

079a88d7f7c18cfd735a9ed1f0eefa28ab28d3007b5f7591920ab25225c89248
xpack-riscv-none-embed-gcc-8.3.0-2.1-linux-x64.tar.gz
xpack-riscv-none-embed-gcc-8.3.0-2.2-linux-x64.tar.gz

8e7e98117900f3eed717b20555b346c2473dcbb9090e05c456412008f39fb62d
xpack-riscv-none-embed-gcc-8.3.0-2.1-win32-x32.zip
xpack-riscv-none-embed-gcc-8.3.0-2.2-win32-x32.zip

5b7a4e3a2bb22566fed951972d726d10ff43bc35db17f9287eed52766e80ecee
xpack-riscv-none-embed-gcc-8.3.0-2.1-win32-x64.zip
xpack-riscv-none-embed-gcc-8.3.0-2.2-win32-x64.zip
```

If you missed this, `cat` the content of the `.sha` files:
Expand All @@ -178,7 +178,7 @@ $ cat *.sha
## Update the Web

- commit the `xpack.github.io` web Git; use a message
like **xPack GNU RISC-V Embedded GCC v8.3.0-2.1 released**
like **xPack GNU RISC-V Embedded GCC v8.3.0-2.2 released**
- adjust timestamps
- wait for the GitHub Pages build to complete
- remember the post URL, since it must be updated in the release page
Expand All @@ -190,11 +190,11 @@ $ cat *.sha
- update the `baseUrl:` with the file URLs (including the tag/version)
- from the release, copy the SHA & file names
- check the executable names
- commit all changes, use a message like `package.json: update urls for 8.3.0-2.1 release` (without `v`)
- commit all changes, use a message like `package.json: update urls for 8.3.0-2.2 release` (without `v`)
- check the latest commits `npm run git-log`
- update `CHANGELOG.md`; commit with a message like
_CHANGELOG: prepare npm v8.3.0-2.1.1_
- `npm version 8.3.0-2.1.1`; the first 5 numbers are the same as the
_CHANGELOG: prepare npm v8.3.0-2.2.1_
- `npm version 8.3.0-2.2.1`; the first 5 numbers are the same as the
GitHub release; the sixth number is the npm specific version
- `npm pack` and check the content of the archive
- push all changes to GitHub
Expand All @@ -216,7 +216,7 @@ $ xpm install --global @xpack-dev-tools/riscv-none-embed-gcc@next
When the release is considered stable, promote it as `latest`:

- `npm dist-tag ls @xpack-dev-tools/riscv-none-embed-gcc`
- `npm dist-tag add @xpack-dev-tools/riscv-none-embed-gcc@8.3.0-2.1.1 latest`
- `npm dist-tag add @xpack-dev-tools/riscv-none-embed-gcc@8.3.0-2.2.1 latest`
- `npm dist-tag ls @xpack-dev-tools/riscv-none-embed-gcc`

## Create a final GitHub release
Expand All @@ -231,7 +231,7 @@ When the release is considered stable, promote it as `latest`:

- in a separate browser windows, open [TweetDeck](https://tweetdeck.twitter.com/)
- using the `@xpack_project` account
- paste the release name like **xPack GNU RISC-V Embedded GCC v8.3.0-2.1 released**
- paste the release name like **xPack GNU RISC-V Embedded GCC v8.3.0-2.2 released**
- paste the link to the Web Page release
- click the **Tweet** button

Expand Down

0 comments on commit 792dabe

Please sign in to comment.