Skip to content
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

[mono] Add old design docs from mono website. #99755

Merged
merged 3 commits into from
Mar 22, 2024
Merged

Conversation

vargaz
Copy link
Contributor

@vargaz vargaz commented Mar 14, 2024

The original location of these documents is:

https://github.com/mono/website/tree/gh-pages/docs/advanced/runtime/docs

Changes made:

  • renamed BITCODE.md -> bitcode.md
  • removed some documents like xdebug.md which are no longer relevant

@vargaz vargaz requested a review from lambdageek March 14, 2024 10:57
@vargaz vargaz added documentation Documentation bug or enhancement, does not impact product or test code and removed area-Meta labels Mar 14, 2024
@vargaz vargaz requested a review from steveisok March 14, 2024 11:05
@vargaz vargaz added the runtime-mono specific to the Mono runtime label Mar 14, 2024
@lambdageek
Copy link
Member

lambdageek commented Mar 14, 2024

@vargaz maybe put them in a subdirectory with a README.md that they came from the mono project website and are primarily describing the .NET Framework version of mono?

Update maybe it's ok to put them here. if we find anything that is inaccurate, we can just add a sentence or two at the top of individual docs to mention that the docs are historic. (or open PRs to fixup)

@vargaz vargaz force-pushed the docs2 branch 2 times, most recently from 5e992b9 to 6d543e6 Compare March 14, 2024 13:21
@vargaz vargaz force-pushed the docs2 branch 2 times, most recently from ac8051e to 3e5627f Compare March 14, 2024 14:20
Comment on lines 1 to 3
---
title: Runtime Cooperative Suspend
---
Copy link
Member

Choose a reason for hiding this comment

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

Some of this is also covered in
https://github.com/dotnet/runtime/blob/main/docs/design/mono/mono-thread-state-machine.md

but some of the info is only here (for example: MONO_REQ_GC_UNSAFE etc)

docs/design/mono/web/coop-suspend.md Outdated Show resolved Hide resolved
docs/design/mono/web/other.md Outdated Show resolved Hide resolved
docs/design/mono/web/soft-debugger.md Outdated Show resolved Hide resolved
The original location of these documents is:

https://github.com/mono/website/tree/gh-pages/docs/advanced/runtime/docs

Changes made:
- renamed BITCODE.md -> bitcode.md
- removed some documents like xdebug.md which are no longer relevant
docs/design/mono/web/coop-suspend.md Outdated Show resolved Hide resolved
docs/design/mono/web/other.md Show resolved Hide resolved
Co-authored-by: Aleksey Kliger (λgeek) <akliger@gmail.com>

## Introduction

Bitcode imposes the following major restrictions:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Bitcode imposes the following major restrictions:
Note: Bitcode target was used by watchOS in the past. It is no longer mantained.
Bitcode imposes the following major restrictions:

I assume that the bitcode support is no longer maintained and bitrotten.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The same backend is used for webassembly.

Copy link
Member

Choose a reason for hiding this comment

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

Good to know. It would be nice to capture it in this doc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

These are old docs which need a lot of updates.
The wasm backend is described in the new up-to-date doc:
#99699

@vargaz vargaz merged commit 6940c19 into dotnet:main Mar 22, 2024
12 checks passed
@vargaz vargaz deleted the docs2 branch March 22, 2024 20:10
@github-actions github-actions bot locked and limited conversation to collaborators Apr 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-VM-meta-mono documentation Documentation bug or enhancement, does not impact product or test code runtime-mono specific to the Mono runtime
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants