Skip to content

Commit 1f93003

Browse files
authored
Merge pull request #85186 from slavapestov/typechecker-docs
docs: Fresh coat of paint for TypeChecker.md
2 parents 3e834cc + efcb8c6 commit 1f93003

File tree

2 files changed

+280
-247
lines changed

2 files changed

+280
-247
lines changed

docs/README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ It is divided into the following sections:
88
while assuming minimal background knowledge.
99
- [How-To Guides](#how-to-guides)
1010
help you complete specific tasks in a step-by-step fashion.
11+
- [Long Reads](#long-reads)
12+
are regularly maintained documents that specify compiler subsystems in detail.
1113
- [Explanations](#explanations)
1214
discuss key subsystems and concepts, at a high level.
1315
They also provide background information and talk about design tradeoffs.
@@ -84,6 +86,16 @@ documentation, please create a thread on the Swift forums under the
8486
Describes how to run [include-what-you-use](https://include-what-you-use.org)
8587
on the Swift project.
8688

89+
## Long Reads
90+
91+
- [EmbeddedSwift/](/docs/EmbeddedSwift/):
92+
A guide to all things Embedded Swift.
93+
- [Generics/](/docs/Generics/): "Compiling Swift Generics", a book about
94+
the implementation of parameteric polymorphism in the Swift compiler.
95+
Also covers the compilation pipeline, request evaluator, and type system in
96+
general.
97+
- [SIL/](/docs/SIL/): Documentation about SIL, the Swift intermediate language.
98+
8799
## Explanations
88100

89101
- [WebAssembly.md](/docs/WebAssembly.md):
@@ -124,9 +136,7 @@ documentation, please create a thread on the Swift forums under the
124136
- [StableBitcode.md](/docs/StableBitcode.md):
125137
Describes how to maintain compatibility when changing the serialization
126138
format.
127-
- SIL and SIL Optimizations:
128-
- [SILFunctionConventions.md](/docs/SIL/SILFunctionConventions.md):
129-
- [SILMemoryAccess.md](/docs/SIL/SILMemoryAccess.md):
139+
- SIL Optimizations:
130140
- [OptimizerDesign.md](/docs/OptimizerDesign.md):
131141
Describes the design of the optimizer pipeline.
132142
- [HighLevelSILOptimizations.rst](/docs/HighLevelSILOptimizations.rst):
@@ -195,11 +205,6 @@ documentation, please create a thread on the Swift forums under the
195205
A concise summary of the calling conventions used for C/C++, Objective-C
196206
and Swift on Apple platforms. Contains references to source documents,
197207
where further detail is required.
198-
- [CallingConvention.rst](/docs/ABI/CallingConvention.rst):
199-
Describes in detail the Swift calling convention.
200-
- [GenericSignature.md](/docs/ABI/GenericSignature.md):
201-
Describes what generic signatures are and how they are used in the ABI,
202-
including the algorithms for minimization and canonicalization.
203208
- [KeyPaths.md](/docs/ABI/KeyPaths.md):
204209
Describes the layout of key path objects (instantiated by the runtime,
205210
and therefore not strictly ABI). \
@@ -233,8 +238,6 @@ documentation, please create a thread on the Swift forums under the
233238
- [OptimizationTips.rst](/docs/OptimizationTips.rst):
234239
Provides guidelines for writing high-performance Swift code.
235240

236-
### Diagnostics
237-
238241
## Project Information
239242

240243
- [Branches.md](/docs/Branches.md):
@@ -296,7 +299,10 @@ They are preserved mostly for historical interest.
296299
- [AccessControl.md](/docs/AccessControl.md)
297300
- [Arrays.md](/docs/Arrays.md)
298301
<!-- Has additional notes on bridging that may be of general interest? -->
299-
- [Generics.rst](/docs/archive/Generics.rst)
302+
- [Generics.rst](/docs/archive/Generics.rst):
303+
Superceded by **Compiling Swift Generics**, see [Long Reads](#long-reads).
304+
- [GenericSignature.md](/docs/ABI/GenericSignature.md):
305+
Superceded by **Compiling Swift Generics**, see [Long Reads](#long-reads).
300306
- [ErrorHandling.md](/docs/ErrorHandling.md)
301307
- [StringDesign.rst](/docs/StringDesign.rst)
302308
- [TextFormatting.rst](/docs/TextFormatting.rst)

0 commit comments

Comments
 (0)