Commit Graph

36 Commits

Author SHA1 Message Date
Doug Gregor
e88f8995e1 [Diagnostics] Eliminate educational notes in favor of diagnostic groups
We've been converging the implementations of educational notes and
diagnostic groups, where both provide category information in
diagnostics (e.g., `[#StrictMemorySafety]`) and corresponding
short-form documentation files. The diagnostic group model is more
useful in a few ways:

* It provides warnings-as-errors control for warnings in the group
* It is easier to associate a diagnostic with a group with
GROUPED_ERROR/GROUPED_WARNING than it is to have a separate diagnostic
ID -> mapping.
* It is easier to see our progress on diagnostic-group coverage
* It provides an easy name to use for diagnostic purposes.

Collapse the educational-notes infrastructure into diagnostic groups,
migrating all of the existing educational notes into new groups.
Simplify the code paths that dealt with multiple educational notes to
have a single, possibly-missing "category documentation URL", which is
how we're treating this.
2025-03-29 15:40:35 -07:00
Anthony Latsis
cbe420c79d docs: Fully spell out the name of docs/ABI/CallConvSummary.rst
"Conv" is ambiguous. Perhaps "CallConv" is not, but the full name is
still more helpful for those of us browsing or searching for targeted
info.
2025-01-22 21:05:42 +00:00
NinjaLikesCheez
fc3c18b3b4 [doc] Fix links to SIL documentation in docs/README.md 2024-12-16 15:26:03 +01:00
Saleem Abdulrasool
6443619126 Remove swift-indent tool
This removes the implementation of the `swift-indent` tool, its
associated documentation, and utilities. This tool was never completed
and has much better alternatives with `swift-format` which is more
flexible and actually maintained.
2024-09-19 11:21:59 -07:00
LamTrinh.Dev
b6239b8cee [docs] Update links to repositories moved to https://github.com/swiftlang/ 2024-07-22 12:22:43 -07:00
Adrian Prantl
22afb55fb5 Add the beginning of a Debug Info guide for SIL pass authors.
This document describes how debug info works at the SIL level and how to
correctly update debug info in SIL optimization passes. This document is
inspired by its LLVM analog, "How to Update Debug Info: A Guide for LLVM Pass
Authors", which can be found at https://llvm.org/docs/HowToUpdateDebugInfo.html
2024-04-18 16:18:20 -07:00
Max Desiatov
9f637f0396 Update Modules.md link in docs/README.md 2023-04-17 15:01:32 +01:00
Alastair Houghton
24932f2ec1 [Backtracing][Docs] Add an explanation of the workings of the backtracer.
Add some discussion of how the new external backtracer works and what
options are available.

rdar://105394365
2023-03-04 08:00:09 +00:00
Max Desiatov
226c7c8eb9 docs: convert FailableInitializers.rst to Markdown (#62417)
Resolves partially https://github.com/apple/swift/issues/49997.
2022-12-08 07:47:43 +00:00
swift-ci
511d78b1aa Merge pull request #62318 from apple/maxd/docs-error-handling-rationale
docs: convert `ErrorHandlingRationale` from `.rst` to `.md`
2022-12-05 08:17:08 -08:00
AgranatMarkit
f3a461b42a move Generics.rst to archive folder 2022-11-30 23:18:45 +02:00
Max Desiatov
3ea7469415 docs: convert ErrorHandlingRationale from .rst to .md
Resolves partially #49997.
2022-11-30 16:13:24 +00:00
Max Desiatov
4296351ee7 docs/README.md: fix outdated links 2022-11-30 15:47:39 +00:00
Egor Zhdan
1124248416 [Docs] Fix dead link to the C++ Interop manifesto 2022-03-21 14:47:34 +00:00
Philip Turner
19b4492432 Add DifferentiableProgrammingImplementation.md to docs/README.md (#41123)
* Update README.md

* Update docs/README.md

Co-authored-by: Robert Widmann <devteam.codafi@gmail.com>

Co-authored-by: Robert Widmann <devteam.codafi@gmail.com>
2022-02-07 12:03:38 -08:00
Alex Lorenz
e106551028 [NFC][interop] rename the PrintAsObjC library to PrintAsClang
We're starting to support emission of C++ header interfaces, so a language-agnostic name makes more sense
2022-01-20 11:31:58 -08:00
Philip Turner
bdce80f5ac [docs] Add "currency type" to the lexicon (#40874)
* Unclear word

* Update Lexicon.md

* Update README.md

* Update docs/Lexicon.md

Co-authored-by: Robert Widmann <devteam.codafi@gmail.com>

* Update Lexicon.md

* Update docs/README.md

Co-authored-by: Robert Widmann <devteam.codafi@gmail.com>

* Update docs/README.md

Co-authored-by: Xiaodi Wu <13952+xwu@users.noreply.github.com>

Co-authored-by: Robert Widmann <devteam.codafi@gmail.com>
Co-authored-by: Xiaodi Wu <13952+xwu@users.noreply.github.com>
2022-01-18 10:37:58 -08:00
Andrew Trick
6079cbe27c AccessBase documentation
Split the SIL function convention and memory access documentation into
separate documents. Reference them from SIL.rst.
2021-09-21 19:54:24 -07:00
Varun Gandhi
f42bde346b [docs] Add documentation for underscored attributes. (#37854)
Fixes rdar://65258964.
2021-08-02 18:20:05 -07:00
Alastair Houghton
2dab086b1b [Docs] Added a calling convention summary document.
Added a summary of x86-64 and ARM64 calling conventions, with links.
2021-07-19 09:50:21 +01:00
Max Desiatov
65fa3742a7 docs: convert weak.rst document to Markdown (#37259)
Converts one of the doc files from reStructuredText to Markdown.

Continues work on SR-7454.
2021-05-05 11:54:48 +01:00
Max Desiatov
0f1d5e872e docs: convert AccessControl.rst to Markdown (#37217)
Converts one of the doc files from reStructuredText to Markdown.

Continues work on SR-7454.
2021-05-04 17:00:31 +01:00
Max Desiatov
e7e28cc9bd docs: Convert ARCOptimization.rst to markdown 2021-02-23 22:25:50 +00:00
Alex Hoppen
8ec8516893 Remove ByteTree serialization format
It was originally designed for faster trasmission of syntax trees from
C++ to SwiftSyntax, but superceded by the CLibParseActions. There's no
deserializer for it anymore, so let's just remove it.
2021-01-14 20:37:49 +01:00
Max Desiatov
8b452ac4b5 docs: convert Serialization.rst to Markdown (#34279)
Converts one more doc file from `.rst` to Markdown for consistency.
2020-10-13 17:16:15 +01:00
Ben Rimmington
ac061482c0 [Docs] Update the documentation contents and index (#34157)
* Update docs/README.md
* Update docs/contents.rst
2020-10-02 06:46:52 +01:00
Android Dev Notes
b137ddee12 Fix grammatical errors (#33940) 2020-09-15 22:22:51 +01:00
3405691582
a51db090fb [docs] Build instructions for OpenBSD. (#33934)
Swift now builds cleanly out of the box as of OpenBSD 6.8-beta.

While there are still more unit test tweaks to be made, document the
preparation and other quirk flags necessary to get a clean build on this
system.
2020-09-15 22:20:13 +01:00
Ben Rimmington
0c6129daf2 [docs] Fix broken links in the documentation index (#33829) 2020-09-15 19:39:05 +01:00
Varun Gandhi
3fe3500d98 [docs] Add First Pull Request guide and Getting Started guide.
This improves upon the existing documentation to provide a clearer end-to-end
workflow for new contributors and people who wish to build the toolchain
locally but do not intend to submit patches.

We also provide more directions for systematically utilizing our existing
documentation.
2020-09-08 20:28:11 -07:00
tbkka
4c684d7a76 DynamicCast Rework, Part 1: Specification (#33010)
A specification for Swift's dynamic casting operations.

This specification tries to reflect the _intent_ of the current implementation, defining a consistent behavior that reflects as far as possible the behavior of the current implementation.  Deviations from this specification will generally be treated as bugs in the current implementation.
2020-08-17 13:37:57 -07:00
Gabriel Igliozzi
ccd82a0589 [Gardening] Fixed 404 in SIL and SIL Optimizations -> HighLevelSILOptimizations.rst (#33384) 2020-08-10 16:31:48 +01:00
Gabriel Igliozzi
3ad98a504c [Docs] Fix broken url and filename (#33318) 2020-08-06 03:12:38 +01:00
Varun Gandhi
440cd0bcfc [docs] Add documentation describing external resources. (#32584) 2020-06-29 15:28:50 -07:00
Varun Gandhi
67791cceac [docs] Add a how-to guide on running IWYU on the Swift project. (#32151) 2020-06-04 14:40:05 -07:00
Varun Gandhi
df7cf799ba [docs] Add an index for the existing documentation. (#32008) 2020-05-28 16:32:31 -07:00