Commit Graph

22 Commits

Author SHA1 Message Date
practicalswift
5d24d87d81 [gardening] Use consistent naming of .rst files in docs/ ("CamelCase.rst")
Fix some cases where "Camel Case.rst" is used instead of "CamelCase.rst".

File counts:
* Files in repo: 10 242
* Files in repo with spaces in file name: 10
* Files in repo with .rst suffix: 74
* Files in repo with .rst suffix and spaces in file name: 10

In addition to the consistency argument: spaces in file names create unnecessary
gotchas when it comes to bash scripting - see below.

Before this commit:

```
$ find . -name "*.rst" | xargs ls -dl > /dev/null
ls: cannot access ./docs/Dependency: No such file or directory
ls: cannot access Analysis.rst: No such file or directory
ls: cannot access ./docs/proposals/ObjC: No such file or directory
ls: cannot access Interoperation.rst: No such file or directory
ls: cannot access ./docs/proposals/C: No such file or directory
ls: cannot access Pointer: No such file or directory
ls: cannot access Argument: No such file or directory
ls: cannot access Interop.rst: No such file or directory
ls: cannot access ./docs/proposals/archive/Memory: No such file or directory
ls: cannot access and: No such file or directory
ls: cannot access Concurrency: No such file or directory
ls: cannot access Model.rst: No such file or directory
ls: cannot access ./docs/proposals/C: No such file or directory
ls: cannot access Pointer: No such file or directory
ls: cannot access Interop: No such file or directory
ls: cannot access Language: No such file or directory
ls: cannot access Model.rst: No such file or directory
ls: cannot access ./docs/proposals/rejected/Bridging: No such file or directory
ls: cannot access Container: No such file or directory
ls: cannot access Protocols: No such file or directory
ls: cannot access to: No such file or directory
ls: cannot access Class: No such file or directory
ls: cannot access Clusters.rst: No such file or directory
ls: cannot access ./docs/archive/Namespace: No such file or directory
ls: cannot access Level: No such file or directory
ls: cannot access Vars: No such file or directory
ls: cannot access and: No such file or directory
ls: cannot access Top: No such file or directory
ls: cannot access Level: No such file or directory
ls: cannot access Code.rst: No such file or directory
ls: cannot access ./docs/archive/Objective-C: No such file or directory
ls: cannot access Interoperability.rst: No such file or directory
ls: cannot access ./docs/Pattern: No such file or directory
ls: cannot access Matching.rst: No such file or directory
ls: cannot access ./docs/Failable: No such file or directory
ls: cannot access Initializers.rst: No such file or directory
$
```

After this commit:

```
$ find . -name "*.rst" | xargs ls -dl > /dev/null
$
```
2016-02-18 10:46:53 +01:00
Jordan Rose
9f9780c6e6 [docs] Delete several docs that don't even really have historical interest.
...and that do not describe or even actively contradict the way things are
today.

A few of these aren't quite so problematic, but simply have no owner or no
significant content. I'm happy to resurrect any that may still be useful.
2015-11-05 08:52:51 -08:00
Jordan Rose
de15f8a3b5 [docs] Move several historical-interest-only docs to an archive/ subfolder. 2015-11-05 08:52:51 -08:00
Erik Eckstein
bbd503545c Add a document which contains some tips and tricks on how to debug the swift compiler.
This could be useful for people who start working with the swift compiler.

Please feel free to correct/enhance/extend etc.



Swift SVN r29383
2015-06-15 11:26:17 +00:00
John McCall
229df4d230 Add the error-handling proposal to the repository.
Swift SVN r27619
2015-04-23 00:56:48 +00:00
Dmitri Hrybenko
ab5fa3f3d1 stdlib: add a document describing index invalidation rules
rdar://18037897

Swift SVN r21597
2014-08-30 00:11:56 +00:00
Connor Wakamo
34af354265 Added a document describing the design of the driver's parseable output format.
Part of <rdar://problem/15958329>.

Swift SVN r20871
2014-08-01 01:15:40 +00:00
Jordan Rose
38d3a9c9cf Move Access Control plan of record to docs/.
Also, sort the table of contents alphabetically...except that "Various
Design Decisions" and LangRefNew stay at the top.

Swift SVN r19445
2014-07-02 01:07:26 +00:00
Doug Gregor
c854d9bb89 Incomplete draft discussion of Swift's object initialization.
Swift SVN r15222
2014-03-19 05:28:30 +00:00
Greg Parker
726c6c75ce Fix docs build after r14116.
Swift SVN r14122
2014-02-20 01:39:08 +00:00
Dave Abrahams
27f1b0917d [styleguide] Commit last draft seen outside DevPubs
We don't know when we're going to get edits from DevPubs; this
represents the last draft that Dave Addey and I discussed.

Swift SVN r14101
2014-02-19 21:41:19 +00:00
Dmitri Hrybenko
0b97b32f92 Start converting LangRef to ReST
Swift SVN r13972
2014-02-17 00:29:19 +00:00
Connor Wakamo
ed2038585f Initial set of changes to add a new 'swift_driver' executable.
- Added a couple of new targets:
  - libswiftDriver, which contains most of the driver implementation
  - swift_driver, which produces the actual executable

- Added centralized version information into libswiftBasic.

- Added a new "Driver Design & Internals" document, which currently describes
  the high-level design of the Swift driver.

- Implemented an early version of the functionality of the driver, including
  versions of the Parse, Pipeline, Bind, Translate, and Execute driver stages.
  Parse, Pipeline, and Bind are largely implemented; Translate and Execute are
  early placeholders. (Translate produces "swift_driver --version" and "ld -v"
  commands, while Execute performs all subtasks sequentially, rather than in
  parallel.)

This is just the starting point for the Swift driver. Tests for the existing
behavior are forthcoming.

Swift SVN r10933
2013-12-06 21:23:01 +00:00
Jordan Rose
9993fa86c5 [docs] Add a description of stored and computed variables.
This is the proposal discussed on the mailing list and at Tuesday's
design meeting, in a more declarative form.

Swift SVN r8675
2013-09-25 23:39:59 +00:00
Dave Abrahams
be2152494e [docs] Silence warnings by removing non-existent documents from the toctree
Swift SVN r8026
2013-09-07 02:57:05 +00:00
Dave Abrahams
27cbda9290 docs/contents.rst: Fix broken toctree reference
Swift SVN r6654
2013-07-26 21:39:10 +00:00
Dave Abrahams
7dae6b6a75 Rename a .rst file so regular Unix make won't barf on it
LitRe testing revealed this problem.  Before now, sphinx was the only
tool that had to process these file names.

Swift SVN r4547
2013-03-29 23:47:01 +00:00
Dave Abrahams
30d9e8821f *.rst: Use litre.TestsAreMissing exceptions
to avoid long processing times and reams of error messages for as-yet-untested files

Swift SVN r4508
2013-03-28 13:45:11 +00:00
Chris Lattner
c4a573f78b add SIL.rst and Error Handling to the TOC, several other dox are dangling references still though.
Swift SVN r3350
2012-12-04 19:46:52 +00:00
Doug Gregor
e748c5f09f Start documenting the constraint-based type checker. There is still
quite a bit to right, but there's almost enough here to understand
constraint generation and the simpler parts of constraint solving.


Swift SVN r2941
2012-10-05 01:23:24 +00:00
Chris Lattner
9ee5f9022b add a place to dump outcomes of random design discussions.
Swift SVN r2542
2012-08-03 20:41:00 +00:00
Daniel Dunbar
1eeecdd874 Change Swift docs to use Sphinx.
- I've converted every document except the LangRef, which is more trouble to
   convert because of the use of styling to embed notes.
 - 'make html' with sphinx-build in your path to build the docs.

Now back to my regularly scheduled breaking things. :)

Swift SVN r2410
2012-07-23 18:50:00 +00:00