Skip to content

Commit e351e82

Browse files
committed
[docs] Fix broken links in the documentation index
1 parent cc511c2 commit e351e82

File tree

1 file changed

+42
-13
lines changed

1 file changed

+42
-13
lines changed

docs/README.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ documentation, please create a thread on the Swift forums under the
6969
How to build Swift on Windows using Visual Studio.
7070
- [WindowsCrossCompile.md](/docs/WindowsCrossCompile.md):
7171
How to cross compile Swift for Windows on a non-Windows host OS.
72-
- [RunningIncludeWhatYouUse.md](/docs/RunningIncludeWhatYouUse.md):
72+
- [RunningIncludeWhatYouUse.md](/docs/HowToGuides/RunningIncludeWhatYouUse.md):
7373
Describes how to run [include-what-you-use](https://include-what-you-use.org)
7474
on the Swift project.
7575

@@ -78,6 +78,8 @@ documentation, please create a thread on the Swift forums under the
7878
- [ByteTree.md](/docs/ByteTree.md):
7979
Describes the ByteTree binary format used for serializing syntax trees
8080
in `libSyntax`.
81+
- [WebAssembly.md](/docs/WebAssembly.md):
82+
Explains some decisions that were made while implementing the WebAssembly target.
8183

8284
### Compiler and Runtime Subsystems
8385

@@ -130,10 +132,11 @@ documentation, please create a thread on the Swift forums under the
130132
### Language subsystems
131133

132134
- Swift's Object Model
133-
- [LogicalObjects.md]():
135+
- [LogicalObjects.md](/docs/LogicalObjects.md):
134136
Describes the differences between logical and physical objects and
135137
introduces materialization and writeback.
136-
- [MutationModel.rst]() <!--: NOTE: Outdated -->
138+
- [MutationModel.rst](/docs/MutationModel.rst): Outdated.
139+
<!-- NOTE: Outdated -->
137140
- [DocumentationComments.md](/docs/DocumentationComments.md):
138141
Describes the format of Swift's documentation markup, including
139142
specially-recognized sections.
@@ -166,6 +169,29 @@ documentation, please create a thread on the Swift forums under the
166169
<!-- NOTE: Outdated -->
167170
- [Lexicon.md](/docs/Lexicon.md):
168171
Canonical reference for terminology used throughout the project.
172+
173+
### ABI
174+
175+
- [GenericSignature.md](/docs/ABI/GenericSignature.md):
176+
Describes what generic signatures are and how they are used in the ABI,
177+
including the algorithms for minimization and canonicalization.
178+
- [KeyPaths.md](/docs/ABI/KeyPaths.md):
179+
Describes the layout of key path objects (instantiated by the runtime,
180+
and therefore not strictly ABI). \
181+
**TODO:** The layout of key path patterns (emitted by the compiler,
182+
to represent key path literals) isn't documented yet.
183+
- [Mangling.rst](/docs/ABI/Mangling.rst):
184+
Describes the stable mangling scheme, which produces unique symbols for
185+
ABI-public declarations.
186+
- [RegisterUsage.md](/docs/ABI/RegisterUsage.md):
187+
Summarizes the register allocation for ARM64 and x86_64 calling conventions,
188+
including the context register (self) and error return register.
189+
- [TypeLayout.rst](/docs/ABI/TypeLayout.rst):
190+
Describes the algorithms/strategies for fragile struct and tuple layout;
191+
class layout; fragile enum layout; and existential container layout.
192+
- [TypeMetadata.rst](/docs/ABI/TypeMetadata.rst):
193+
Describes the fields, values, and layout of metadata records, which can be
194+
used (by reflection and debugger tools) to discover information about types.
169195

170196
## Recommended Practices
171197

@@ -180,7 +206,7 @@ documentation, please create a thread on the Swift forums under the
180206
- [StdlibAPIGuidelines.rst](/docs/StdlibAPIGuidelines.rst):
181207
Provides guidelines for designing stdlib APIs.
182208
<!-- NOTE: Outdated -->
183-
- [StandardLibraryProgrammersManual](/docs/StandardLibraryProgrammersManual.md):
209+
- [StandardLibraryProgrammersManual.md](/docs/StandardLibraryProgrammersManual.md):
184210
Provides guidelines for working code in the stdlib.
185211
- [OptimizationTips.rst](/docs/OptimizationTips.rst):
186212
Provides guidelines for writing high-performance Swift code.
@@ -191,7 +217,7 @@ documentation, please create a thread on the Swift forums under the
191217

192218
- [Branches.md](/docs/Branches.md):
193219
Describes how different branches are setup and what the automerger does.
194-
- [ContinuousIntegration.md](ContinuousIntegration.md):
220+
- [ContinuousIntegration.md](/docs/ContinuousIntegration.md):
195221
Describes the continuous integration setup, including the `@swift_ci` bot.
196222

197223
## Evolution Documents
@@ -203,9 +229,9 @@ documentation, please create a thread on the Swift forums under the
203229
Describes the goals and design for ABI stability.
204230
- [LibraryEvolutionManifesto.md](/docs/LibraryEvolutionManifesto.md):
205231
Describes the goals and design for Library Evolution.
206-
- [BuildManifesto.md](BuildManifesto.md):
232+
- [BuildManifesto.md](/docs/BuildManifesto.md):
207233
Provides an outline for modularizing the build system for the Swift toolchain.
208-
- [CppInteroperabilityManifesto.md](CppInteroperabilityManifesto.md):
234+
- [CppInteroperabilityManifesto.md](/docs/CppInteroperabilityManifesto.md):
209235
Describes the motivation and design for first-class Swift-C++ interoperability.
210236
- [DifferentiableProgramming.md](/docs/DifferentiableProgramming.md):
211237
Outlines a vision and design for first-class differentiable programming in Swift.
@@ -224,10 +250,13 @@ More recent proposals are located in the [apple/swift-evolution][] repository.
224250
You can see the status of different proposals at
225251
<https://apple.github.io/swift-evolution/>.
226252

227-
[swift-evolution]: https://github.com/apple/swift-evolution
253+
[apple/swift-evolution]: https://github.com/apple/swift-evolution
228254

229255
### Surveys
230256

257+
- [CallingConvention.rst](/docs/ABI/CallingConvention.rst):
258+
This whitepaper discusses the Swift calling convention (high-level semantics;
259+
ownership transfer; physical representation; function signature lowering).
231260
- [ErrorHandlingRationale.rst](/docs/ErrorHandlingRationale.rst):
232261
Surveys error-handling in a variety of languages, and describes the rationale
233262
behind the design of error handling in Swift.
@@ -239,10 +268,10 @@ You can see the status of different proposals at
239268
### Archive
240269

241270
These documents are known to be out-of-date and are superseded by other
242-
documentation, primarily [The Swift Programming Language (TSPL)][].
271+
documentation, primarily [The Swift Programming Language][] (TSPL).
243272
They are preserved mostly for historical interest.
244273

245-
- [AccessControl.rst](/docs/AccessControl.swift)
274+
- [AccessControl.rst](/docs/AccessControl.rst)
246275
- [Arrays.rst](/docs/Arrays.rst)
247276
<!-- Has additional notes on bridging that may be of general interest? -->
248277
- [Generics.rst](/docs/Generics.rst)
@@ -254,7 +283,7 @@ They are preserved mostly for historical interest.
254283

255284
## External Resources
256285

257-
External resources are listed in [docs/ExternalResources.md](ExternalResources.md).
286+
External resources are listed in [ExternalResources.md](/docs/ExternalResources.md).
258287
These cover a variety of topics,
259288
such as the design of different aspects of the Swift compiler and runtime
260289
and contributing to the project more effectively.
@@ -315,9 +344,9 @@ provide greater clarity to contributors wanting to add new documentation.
315344
`@_hasMissingDesignatedInitializers`. Some of this is covered in
316345
[TSPL's initialization section][] but that doesn't include newly added
317346
attributes.
318-
- [Modules.rst](/docs/Module.rst): for Swift pre-1.0.
347+
- [Modules.rst](/docs/Modules.rst): for Swift pre-1.0.
319348
- [Swift3Compatibility.md](/docs/Swift3Compatibility.md):
320349
Discusses the Swift 3 -> Swift 4 migration.
321-
- [StoredAndComputedVariables.rst](): for Swift pre-1.0.
350+
- [StoredAndComputedVariables.rst](/docs/StoredAndComputedVariables.rst): for Swift pre-1.0.
322351

323352
[TSPL's initialization section]: https://docs.swift.org/swift-book/LanguageGuide/Initialization.html

0 commit comments

Comments
 (0)