Skip to content

Commit

Permalink
docs: Fix typos and links in 0.5.x release notes (#3873)
Browse files Browse the repository at this point in the history
  • Loading branch information
WojciechMazur committed Apr 15, 2024
1 parent cb745e4 commit d83e5fa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/changelog/0.5.x/0.5.0-RC1.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Check out the documentation at
Scala Native now allows to use system threads based on `java.lang.Thread` implementation, along with all the necessary primitives to work with concurrency:
* `synchronized` blocks are now using object monitors following partially JVM semantics - these might be less performant when compared to JVM, but are going to achive improvements in the followup patch releases.
* JVM compliant support for `@volatile` annotations
* Configurable mostly JVM-compliant support for final fields semantics, see [multithreading guide](../user/lang.rst#Multithreading)
* Configurable mostly JVM-compliant support for final fields semantics, see [multithreading guide](../../user/lang.md/#multithreading)
* Thread safe implementation of most `java.util.concurrent` types and methods, including atomics, thread pools, etc. See list of currently implemented primitives in our [meta-issue on GitHub](https://github.com/scala-native/scala-native/issues/3165). Be aware that our Java Standard Library implementation might still contain thread-unsafe implementations of types not listed in the tracker.
* Support for most of `scala.concurrent` and `scala.collection.concurrent` types.
* Multithreading-aware implemenation of all garbage collections.
Expand All @@ -65,7 +65,7 @@ Be aware that both Scala Native optimizer and LLVM optimizers can remove some of
.withMode(scalanative.build.Mode.debug) // compile using LLVM without optimizations
}
```
See our [debugging guide](../user/testing.md#source-level-debugging) for more informations.
See our [debugging guide](../../user/testing.md#source-level-debugging) for more informations.

### SIP-51 support: Drop forward binary compatibility of the Scala 2.13 standard library
We're chaning how the Scala standard library artifacts are published. Previously each Scala Native version shipped with 1 artifact for Scala standard library based on latest version of Scala. However this approach was insufficient to fully cover changes in Scala 3 standard library and it's 2 lines of releases: Scala LTS and Scala Next.
Expand All @@ -78,7 +78,7 @@ Now when referring to not implemented Java standard library method, or a type fr
### JVM service providers supports
We're introducing a user configured support for Java Service Providers.
Similarry to it's JVM variant these would allow you to introduce implementations of Service Provider Interfaces however due to Ahead-of-time compilation constraint and to limit ammount of introduced dependencies only explicitly enabled implementations would be linked in the final binary.
For more details refer to [our guide](../lib/javalib.rst#Support-for-discovering-service-providers)
For more details refer to [our guide](../../lib/javalib.md#Support-for-discovering-service-providers)

### User build settings
You can now specify the `basename` of your executable or library.. Typically it will default to the project's module name.
Expand All @@ -100,7 +100,7 @@ Scala Native 0.5.0 breaks backward binary compatibility with previous releases o
Libraries published using version 0.4.x or older must be republished for Scala Native 0.5.x.

### Scala Native Runtime
* `scala.scalanative.unsafe.Zone.apply` by default uses a context function argument. For Scala 2 cross-compilation see [Memory managment section](../user/interop.rst#Memory-management)
* `scala.scalanative.unsafe.Zone.apply` by default uses a context function argument. For Scala 2 cross-compilation see [Memory managment section](../../user/interop.md#memory-management)
* The idiomatic alternative for C `void*` is now `Ptr[?]`(Scala 3) / `Ptr[_]` (Scala 2). Use `unsafe.CVoidPtr` for alias when defining bindings.

### Java Standard Library
Expand Down Expand Up @@ -226,7 +226,7 @@ are used on all GCs. The last one works on Boehm and Commix.
* GC_MAXIMUM_HEAP_SIZE (was SCALANATIVE_MAX_HEAP_SIZE)
* GC_NPROCS (was SCALANATIVE_GC_THREADS)
* GC_TIME_RATIO (was SCALANATIVE_TIME_RATIO)
* GC_FREE_RATION (was SCALANATIVE_FREE_RATIO)
* GC_FREE_RATIO (was SCALANATIVE_FREE_RATIO)
* GC_STATS_FILE (was SCALANATIVE_STATS_FILE)


Expand Down
10 changes: 5 additions & 5 deletions docs/changelog/0.5.x/0.5.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Check out the documentation at
Scala Native now allows to use system threads based on `java.lang.Thread` implementation, along with all the necessary primitives to work with concurrency:
* `synchronized` blocks are now using object monitors following partially JVM semantics - these might be less performant when compared to JVM, but are going to achive improvements in the followup patch releases.
* JVM compliant support for `@volatile` annotations
* Configurable mostly JVM-compliant support for final fields semantics, see [multithreading guide](../user/lang.rst#Multithreading)
* Configurable mostly JVM-compliant support for final fields semantics, see [multithreading guide](../../user/lang.md/#multithreading)
* Thread safe implementation of most `java.util.concurrent` types and methods, including atomics, thread pools, etc. See list of currently implemented primitives in our [meta-issue on GitHub](https://github.com/scala-native/scala-native/issues/3165). Be aware that our Java Standard Library implementation might still contain thread-unsafe implementations of types not listed in the tracker.
* Support for most of `scala.concurrent` and `scala.collection.concurrent` types.
* Multithreading-aware implemenation of all garbage collections.
Expand All @@ -65,7 +65,7 @@ Be aware that both Scala Native optimizer and LLVM optimizers can remove some of
.withMode(scalanative.build.Mode.debug) // compile using LLVM without optimizations
}
```
See our [debugging guide](../user/testing.md#source-level-debugging) for more informations.
See our [debugging guide](../../user/testing.md#source-level-debugging) for more informations.

### SIP-51 support: Drop forward binary compatibility of the Scala 2.13 standard library
We're chaning how the Scala standard library artifacts are published. Previously each Scala Native version shipped with 1 artifact for Scala standard library based on latest version of Scala. However this approach was insufficient to fully cover changes in Scala 3 standard library and it's 2 lines of releases: Scala LTS and Scala Next.
Expand All @@ -78,7 +78,7 @@ Now when referring to not implemented Java standard library method, or a type fr
### JVM service providers supports
We're introducing a user configured support for Java Service Providers.
Similarry to it's JVM variant these would allow you to introduce implementations of Service Provider Interfaces however due to Ahead-of-time compilation constraint and to limit ammount of introduced dependencies only explicitly enabled implementations would be linked in the final binary.
For more details refer to [our guide](../lib/javalib.rst#Support-for-discovering-service-providers)
For more details refer to [our guide](../../lib/javalib.md#Support-for-discovering-service-providers)

### User build settings
You can now specify the `basename` of your executable or library.. Typically it will default to the project's module name.
Expand All @@ -100,7 +100,7 @@ Scala Native 0.5.0 breaks backward binary compatibility with previous releases o
Libraries published using version 0.4.x or older must be republished for Scala Native 0.5.x.

### Scala Native Runtime
* `scala.scalanative.unsafe.Zone.apply` by default uses a context function argument. For Scala 2 cross-compilation see [Memory managment section](../user/interop.rst#Memory-management)
* `scala.scalanative.unsafe.Zone.apply` by default uses a context function argument. For Scala 2 cross-compilation see [Memory managment section](../../user/interop.md#memory-management)
* The idiomatic alternative for C `void*` is now `Ptr[?]`(Scala 3) / `Ptr[_]` (Scala 2). Use `unsafe.CVoidPtr` for alias when defining bindings.

### Java Standard Library
Expand Down Expand Up @@ -226,7 +226,7 @@ are used on all GCs. The last one works on Boehm and Commix.
* GC_MAXIMUM_HEAP_SIZE (was SCALANATIVE_MAX_HEAP_SIZE)
* GC_NPROCS (was SCALANATIVE_GC_THREADS)
* GC_TIME_RATIO (was SCALANATIVE_TIME_RATIO)
* GC_FREE_RATION (was SCALANATIVE_FREE_RATIO)
* GC_FREE_RATIO (was SCALANATIVE_FREE_RATIO)
* GC_STATS_FILE (was SCALANATIVE_STATS_FILE)


Expand Down

0 comments on commit d83e5fa

Please sign in to comment.