Skip to content

docs: Convert ARCOptimization.rst to Markdown #35993

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.

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

Merged
merged 1 commit into from
Feb 24, 2021

Conversation

MaxDesiatov
Copy link
Contributor

@MaxDesiatov MaxDesiatov commented Feb 16, 2021

Currently docs are a mix of reStructuredText and Markdown and unifying them as Markdown would make more sense long term, as far as I understand. This converts ARCOptmization.rst, initially converted with Pandoc with manual cleanup added after the fact.

@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test

Comment on lines 19 to 29
- `strong_retain`
- `strong_release`
- `strong_retain_unowned`
- `unowned_retain`
- `unowned_release`
- `load_weak`
- `store_weak`
- `fix_lifetime`
- `mark_dependence`
- `is_unique`
- `copy_block`
Copy link
Contributor

Choose a reason for hiding this comment

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

You can remove the additional spacing between - and the backtick.

Comment on lines 311 to 318
> - Native object types are directly checked by reading the strong
> reference count: (Builtin.NativeObject, known native class
> reference)
> - Objective-C object types require an additional check that the
> dynamic object type uses native Swift reference counting: (unknown
> class reference, class existential)
> - Bridged object types allow the dynamic object type check to be
> bypassed based on the pointer encoding: (Builtin.BridgeObject)
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe this was accidentally marked as a quote? Seems a bit odd... It seems like it is stating the rules, and not quoting rules stated elsewhere.

@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test

@MaxDesiatov MaxDesiatov changed the title docs: Convert ARCOptmization.rst to Markdown docs: Convert ARCOptimization.rst to Markdown Feb 16, 2021
@benrimmington
Copy link
Contributor

There's also a link in docs/README.md.

@MaxDesiatov
Copy link
Contributor Author

Thanks, that's fixed now.

Copy link
Contributor

@benrimmington benrimmington left a comment

Choose a reason for hiding this comment

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

I did a quick side-by-side comparison.
The only thing I noticed was a missing table of contents.

@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test and merge

@MaxDesiatov
Copy link
Contributor Author

@swift-ci please smoke test

@benrimmington
Copy link
Contributor

@swift-ci Please smoke test Linux platform

@MaxDesiatov
Copy link
Contributor Author

@swift-ci please test Windows platform

@MaxDesiatov MaxDesiatov merged commit 6e0267f into swiftlang:main Feb 24, 2021
@MaxDesiatov MaxDesiatov deleted the arcoptimization-md branch February 24, 2021 10:31
@Teemperor
Copy link
Contributor

writing output... [ 98%] proposals/valref
writing output... [100%] weak


Warning, treated as error:
/Users/teemperor/swift/master2/swift/docs/SIL.rst:4247:undefined label: arcopts.is_unique
[264/1631][ 16%][26.504s] Building CXX object stdlib/public/runtime/CMakeFiles/swiftRuntime-macosx-arm64e.dir/Metadata.cpp.o
ninja: build stopped: subcommand failed.
ERROR: command terminated with a non-zero exit status 1, aborting

This breaks the doc compilation which in turns breaks the complete build. Please revert, thank you.

@benrimmington
Copy link
Contributor

This breaks the doc compilation which in turns breaks the complete build. Please revert, thank you.

@Teemperor Possible fix: #36131

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants