Skip to content

Fixed 404 Error: Updated Link to CONTRIBUTING.md in TemporaryGettingStarted.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 24, 2023
Merged

Fixed 404 Error: Updated Link to CONTRIBUTING.md in TemporaryGettingStarted.md #16

merged 1 commit into from
Sep 24, 2023

Conversation

@ojun9
Copy link
Contributor

@ojun9 ojun9 commented Sep 24, 2023

Fix broken link to CONTRIBUTING.md in TemporaryGettingStarted.md

Motivation:

The link to the CONTRIBUTING.md file in the TemporaryGettingStarted.md document is incorrect, which leads to a 404 Not Found error when attempted to access.

Modifications:

Updated the incorrect link from https://github.com/apple/swift-testing/CONTRIBUTING.md to https://github.com/apple/swift-testing/blob/main/CONTRIBUTING.md in the TemporaryGettingStarted.md document.

Result:

With this change, users will be directed to the correct CONTRIBUTING.md file when they click the link in TemporaryGettingStarted.md, ensuring they have access to the necessary contributing guidelines.

stmontgomery
stmontgomery approved these changes Sep 24, 2023
View reviewed changes
Copy link
Contributor

@stmontgomery stmontgomery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch

@stmontgomery stmontgomery merged commit bf42de1 into swiftlang:main Sep 24, 2023
@grynspan grynspan added the documentation 📚 Improvements or additions to documentation label Sep 25, 2023
grynspan added a commit that referenced this pull request Jun 11, 2025
@grynspan
Add an unreachable marker function.
39da1cc 
This PR adds a wrapper around `__builtin_unreachable()` (`Builtin.unreachable()`
when building the Swift standard library) that we can use in place of
`fatalError()`. The benefit is that the generated code size for unreachable
paths is significantly reduced. For example, given the following function
compiled with `-O`:

```swift
@available(*, unavailable) func f() {
  fatalError("Unreachable")
}
```

The compiler currently produces:

```asm
sub    sp, sp, #0x20
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    w8, #0x1                  ; =1
str    w8, [sp, #0x8]
mov    w8, #0xc                  ; =12
str    x8, [sp]
adrp   x0, 0
add    x0, x0, #0x6a8            ; "Fatal error"
adrp   x5, 0
add    x5, x5, #0x690            ; "UnreachableTest/S.swift"
mov    x3, #0x6e55               ; =28245
movk   x3, #0x6572, lsl #16
movk   x3, #0x6361, lsl #32
movk   x3, #0x6168, lsl #48
mov    x4, #0x6c62               ; =27746
movk   x4, #0x65, lsl #16
movk   x4, #0xeb00, lsl #48
mov    w1, #0xb                  ; =11
mov    w2, #0x2                  ; =2
mov    w6, #0x17                 ; =23
mov    w7, #0x2                  ; =2
bl     0x100000680               ; symbol stub for: Swift._assertionFailure(_: Swift.StaticString, _: Swift.String, file: Swift.StaticString, line: Swift.UInt, flags: Swift.UInt32) -> Swift.Never
brk    #0x1
```

But with this change:
```swift
@available(*, unavailable) func f() {
  swt_unreachable()
}
```

It instead compiles to simply:

```asm
brk    #0x1
```
grynspan added a commit that referenced this pull request Jun 11, 2025
@grynspan
Add an unreachable marker function.
fcd2cb7 
This PR adds a wrapper around `__builtin_unreachable()` (`Builtin.unreachable()`
when building the Swift standard library) that we can use in place of
`fatalError()`. The benefit is that the generated code size for unreachable
paths is significantly reduced. For example, given the following function
compiled with `-O`:

```swift
@available(*, unavailable) func f() {
  fatalError("Unreachable")
}
```

The compiler currently produces:

```asm
sub    sp, sp, #0x20
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    w8, #0x1                  ; =1
str    w8, [sp, #0x8]
mov    w8, #0xc                  ; =12
str    x8, [sp]
adrp   x0, 0
add    x0, x0, #0x6a8            ; "Fatal error"
adrp   x5, 0
add    x5, x5, #0x690            ; "UnreachableTest/S.swift"
mov    x3, #0x6e55               ; =28245
movk   x3, #0x6572, lsl #16
movk   x3, #0x6361, lsl #32
movk   x3, #0x6168, lsl #48
mov    x4, #0x6c62               ; =27746
movk   x4, #0x65, lsl #16
movk   x4, #0xeb00, lsl #48
mov    w1, #0xb                  ; =11
mov    w2, #0x2                  ; =2
mov    w6, #0x17                 ; =23
mov    w7, #0x2                  ; =2
bl     0x100000680               ; symbol stub for: Swift._assertionFailure(_: Swift.StaticString, _: Swift.String, file: Swift.StaticString, line: Swift.UInt, flags: Swift.UInt32) -> Swift.Never
brk    #0x1
```

But with this change:
```swift
@available(*, unavailable) func f() {
  swt_unreachable()
}
```

It instead compiles to simply:

```asm
brk    #0x1
```
grynspan added a commit that referenced this pull request Jun 12, 2025
@grynspan
Add an unreachable marker function. (#1150)
f66ef03 
This PR adds a wrapper around `__builtin_unreachable()`
(`Builtin.unreachable()` when building the Swift standard library) that
we can use in place of `fatalError()`. The benefit is that the generated
code size for unreachable paths is significantly reduced. For example,
given the following function compiled with `-O`:

```swift
@available(*, unavailable) func f() {
  fatalError("Unreachable")
}
```

The compiler currently produces:

```asm
sub    sp, sp, #0x20
stp    x29, x30, [sp, #0x10]
add    x29, sp, #0x10
mov    w8, #0x1                  ; =1
str    w8, [sp, #0x8]
mov    w8, #0xc                  ; =12
str    x8, [sp]
adrp   x0, 0
add    x0, x0, #0x6a8            ; "Fatal error"
adrp   x5, 0
add    x5, x5, #0x690            ; "UnreachableTest/S.swift"
mov    x3, #0x6e55               ; =28245
movk   x3, #0x6572, lsl #16
movk   x3, #0x6361, lsl #32
movk   x3, #0x6168, lsl #48
mov    x4, #0x6c62               ; =27746
movk   x4, #0x65, lsl #16
movk   x4, #0xeb00, lsl #48
mov    w1, #0xb                  ; =11
mov    w2, #0x2                  ; =2
mov    w6, #0x17                 ; =23
mov    w7, #0x2                  ; =2
bl     0x100000680               ; symbol stub for: Swift._assertionFailure(_: Swift.StaticString, _: Swift.String, file: Swift.StaticString, line: Swift.UInt, flags: Swift.UInt32) -> Swift.Never
brk    #0x1
```

But with this change:
```swift
@available(*, unavailable) func f() {
  swt_unreachable()
}
```

It instead compiles to simply:

```asm
brk    #0x1
```

### Checklist:

- [x] Code and documentation should follow the style of the [Style
Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md).
- [x] If public symbols are renamed or modified, DocC references should
be updated.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stmontgomery stmontgomery stmontgomery approved these changes

@grynspan grynspan Awaiting requested review from grynspan grynspan is a code owner

@dennisweissmann dennisweissmann Awaiting requested review from dennisweissmann

@briancroom briancroom Awaiting requested review from briancroom briancroom is a code owner

@SeanROlszewski SeanROlszewski Awaiting requested review from SeanROlszewski

@suzannaratcliff suzannaratcliff Awaiting requested review from suzannaratcliff

Assignees

No one assigned

Labels

documentation 📚 Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ojun9 @stmontgomery @grynspan