Merge remote-tracking branch 'origin/master' into swift-3-api-guidelines

Author: Max Moiseev

.dir-locals.el

@@ -2,7 +2,7 @@
 ;
 ; This source file is part of the Swift.org open source project
 ;
-; Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
+; Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
 ; Licensed under Apache License v2.0 with Runtime Library Exception
 ;
 ; See http://swift.org/LICENSE.txt for license information

CHANGELOG.md

@@ -9,7 +9,7 @@ Latest
   for operators that start with a dot (".").  The new rule is that an operator
   that starts with a dot may contain other dots in it, but operators that start
   with some other character may not contain dots.  For example:
- 
+
     ```
     x....foo   --> "x" "...." "foo"
     x&%^.foo   --> "x" "&%^"  ".foo"
@@ -91,6 +91,14 @@ Latest
   back-ticks. For more information, see
   [SE-0001](https://github.com/apple/swift-evolution/blob/master/proposals/0001-keywords-as-argument-labels.md).
 
+* Tuples (up to arity 6) whose elements are all `Comparable` or `Equatable` now
+  implement the full set of comparison/equality operators. The comparison
+  operators are defined in terms of [lexicographical order][]. See [SE-0015][]
+  for more information.
+
+[lexicographical order]: https://en.wikipedia.org/wiki/Lexicographical_order
+[SE-0015]: https://github.com/apple/swift-evolution/blob/master/proposals/0015-tuple-comparison-operators.md
+
 2015-09-17 [Xcode 7.1, Swift 2.1]
 ----------
 
@@ -3897,9 +3905,9 @@ Latest
   themselves.
 
   Overall, a property now may either be "stored" (the default), "computed"
-  (have a `get:` and optionally a `set:` specifier), or a observed
+  (have a `get:` and optionally a `set:` specifier), or an observed
   (`willSet`/`didSet`) property.  It is not possible to have a custom getter
-  or setter on a observed property, since they have storage.
+  or setter on an observed property, since they have storage.
 
   Two known-missing bits are:
   - **(rdar://problem/15920332) didSet/willSet variables need to allow initializers**

CMakeLists.txt

@@ -183,11 +183,7 @@ set(SWIFT_EXPERIMENTAL_EXTRA_REGEXP_FLAGS "" CACHE STRING
   "A list of [module_regexp1;flags1;module_regexp2;flags2,...] which can be used to apply specific flags to modules that match a cmake regexp. It always applies the first regexp that matches.")
 
 set(SWIFT_EXPERIMENTAL_EXTRA_NEGATIVE_REGEXP_FLAGS "" CACHE STRING
-    "A list of [module_regexp1;flags1;module_regexp2;flags2,...] which can be used to apply specific flags to modules that do not match a cmake regexp. It always applies the first regexp that does not matche. The reason this is necessary is that cmake does not provide negative matches in the regex. Instead you have to use NOT in the if statement requiring a separate variable.")
-
-option(SWIFT_RUNTIME_ENABLE_DTRACE
-  "Should the runtime be built with dtrace instrumentation enabled"
-  FALSE)
+    "A list of [module_regexp1;flags1;module_regexp2;flags2,...] which can be used to apply specific flags to modules that do not match a cmake regexp. It always applies the first regexp that does not match. The reason this is necessary is that cmake does not provide negative matches in the regex. Instead you have to use NOT in the if statement requiring a separate variable.")
 
 option(SWIFT_RUNTIME_ENABLE_LEAK_CHECKER
   "Should the runtime be built with support for non-thread-safe leak detecting entrypoints"

README.md

@@ -56,9 +56,9 @@ with version 2 shipped with Ubuntu.
 If you are building on Ubuntu 14.04 LTS, you'll need to upgrade your clang
 compiler for C++14 support and create a symlink:
 
-     sudo apt-get install clang-3.6
-     sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-3.6 100
-     sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-3.6 100
+    sudo apt-get install clang-3.6
+    sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-3.6 100
+    sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-3.6 100
 
 ### Getting Sources for Swift and Related Projects
 

docs/ARCOptimization.rst

@@ -228,3 +228,22 @@ These builtins perform an implicit cast to NativeObject before
 checking uniqueness. There’s no way at SIL level to cast the address
 of a reference, so we need to encapsulate this operation as part of
 the builtin.
+
+Semantic Tags
+=============
+
+ARC takes advantage of certain semantic tags. This section documents these
+semantics and their meanings.
+
+arc.programtermination_point
+----------------------------
+
+If this semantic tag is applied to a function, then we know that:
+
+- The function does not touch any reference counted objects.
+- After the function is executed, all reference counted objects are leaked
+  (most likely in preparation for program termination).
+
+This allows one, when performing ARC code motion, to ignore blocks that contain
+an apply to this function as long as the block does not have any other side
+effect having instructions.

docs/DebuggingTheCompiler.rst

@@ -136,7 +136,7 @@ and check for the function name in the breakpoint condition::
 
     (lldb) br set -c 'hasName("_TFC3nix1Xd")' -f SILFunction.cpp -l 91
 
-Sometimes you want to know which optimization does insert, remove or move a
+Sometimes you may want to know which optimization inserts, removes or moves a
 certain instruction. To find out, set a breakpoint in
 ``ilist_traits<SILInstruction>::addNodeToList`` or
 ``ilist_traits<SILInstruction>::removeNodeFromList``, which are defined in

docs/ErrorHandlingRationale.rst

@@ -389,7 +389,7 @@ options as a programmer:
   function called by your function.
 
 - You can carefully arrange your function so that there are no
-  critical sections where an universal error can leave things in an
+  critical sections where a universal error can leave things in an
   unwanted state.
 
 There are techniques for making the second more palatable.  Chiefly,
@@ -741,8 +741,8 @@ This approach is therefore relatively even-handed about the error
 vs. the non-error path, although it requires some care in order to
 minimize code-size penalties for parallel error paths.
 
-``setjmp`` / ``longmp``
-~~~~~~~~~~~~~~~~~~~~~~~
+``setjmp`` / ``longjmp``
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Another strategy to is to dynamically maintain a thread-local stack of
 interesting frames.  A function with an interesting frame must save

docs/Generics.rst

@@ -579,7 +579,7 @@ OrderedCollection>) are just sugar for a where clause.  For example, the
 above find() signature is equivalent to::
 
   func find<C where C : OrderedCollection, C.Element : Comparable>(
-         collection : C, value : C.Element)-> Int
+         collection : C, value : C.Element) -> Int
 
 Note that find<C> is shorthand for (and equivalent to) find<C : Any>, since
 every type conforms to the Any protocol composition.

docs/GitWorkflows.rst

@@ -114,7 +114,7 @@ By default when updating, Git will attempt to merge the remote changes and your
 local changes. Ignoring what that sentence means, this is not an SVN-esque
 model. Instead we want any local changes that we have to be applied on top of
 any new remote changes. The 'branch.autosetuprebase' flag causes this to be done
-automatically when ever one updates the local repository.
+automatically whenever one updates the local repository.
 
 Update
 ------
@@ -261,7 +261,7 @@ command::
 
   $ git log <REVISION>
 
-To see a oneline summary that includes just the title of the commit and its
+To see an oneline summary that includes just the title of the commit and its
 hash, pass the '--oneline' command::
 
   $ git log --oneline

docs/HighLevelSILOptimizations.rst

@@ -132,7 +132,7 @@ Array
 The following semantic tags describe Array operations. The operations
 are first described in terms of the Array "state". Relations between the
 operations are formally defined below. 'Array' refers to the standard library
-Array<T>, ContigousArray<T>, and ArraySlice<T> data-structures.
+Array<T>, ContiguousArray<T>, and ArraySlice<T> data-structures.
 
 We consider the array state to consist of a set of disjoint elements
 and a storage descriptor that encapsulates nonelement data such as the
@@ -262,7 +262,7 @@ check_subscript  guards          get_element, get_element_address
 make_mutable     interferes-with props.isCocoa/needsElementTypeCheck
 get_elt_addr     interferes-with get_element, get_element_address,
                                  props.isCocoa/needsElementTypeCheck
-mutate_unknown   itereferes-with get_element, check_subscript, get_length,
+mutate_unknown   interferes-with get_element, check_subscript, get_length,
                                  get_capacity, get_element_address,
                                  props.isCocoa/needsElementTypeCheck
 ================ =============== ==========================================

docs/Runtime.md

@@ -242,7 +242,6 @@ process start and the function returns.
 ## Debugging
 
 ```
-0000000000024040 T __swift_debug_verifyTypeLayoutAttribute
 0000000000027140 T _swift_willThrow
 ```
 
@@ -307,6 +306,9 @@ detail used to implement resilient per-type metadata accessor functions.
 0000000000028bc0 T _swift_getInitializedObjCClass
 ```
 
+**ABI TODO**: Fast entry points for `getExistential*TypeMetadata1-3`. Static
+metadata for `Any` and `AnyObject` is probably worth considering too.
+
 ## Type metadata initialization
 
 Calls to these entry points are emitted when instantiating type metadata at
@@ -325,26 +327,19 @@ runtime.
 0000000000028b60 T _swift_instantiateObjCClass
 ```
 
-## Objective-C Runtime Interop
-
-```
-0000000000023e60 T _swift_demangleSimpleClass
-0000000000028770 T _swift_objcRespondsToSelector
-```
-
 ## Metatypes
 
 ```
 0000000000000b60 T _swift_getDynamicType
 0000000000022fb0 T _swift_getObjectType
 00000000000006f0 T _swift_getTypeName
 00000000000040c0 T _swift_isClassType
-0000000000003f50 T _swift_isClassOrObjCExistential
+0000000000003f50 T _swift_isClassOrObjCExistentialType
 0000000000004130 T _swift_isOptionalType
-00000000000279f0 T __swift_usesNativeSwiftReferenceCounting_class
-000000000002b340 T __swift_class_getInstancePositiveExtentSize
-000000000002b350 T __swift_class_getInstancePositiveExtentSize_native
-0000000000004080 T __swift_getSuperclass_nonNull
+00000000000279f0 T _swift_objc_class_usesNativeSwiftReferenceCounting
+000000000002b340 T _swift_objc_class_unknownGetInstanceExtents
+000000000002b350 T _swift_class_getInstanceExtents
+0000000000004080 T _swift_class_getSuperclass
 ```
 
 **ABI TODO**: getTypeByName entry point.
@@ -354,9 +349,6 @@ constants to supersede `swift_is*Type`.
 
 **ABI TODO**: Rename class metadata queries with a consistent naming scheme.
 
-**ABI TODO**: `swift_isClassOrObjCExistential` should end in `-Type` for
-consistency.
-
 ## Protocol conformance lookup
 
 ```
@@ -375,7 +367,10 @@ consistency.
 
 The Swift runtime exports standard metadata objects for `Builtin` types
 as well as standard value witness tables that can be freely adopted by
-types with common layout attributes.
+types with common layout attributes. Note that, unlike public-facing types,
+the runtime does not guarantee a 1:1 mapping of Builtin types to metadata
+objects, and will reuse metadata objects to represent builtins with the same
+layout characteristics.
 
 ```
 000000000004faa8 S __TMBB
@@ -419,4 +414,6 @@ types with common layout attributes.
 
 - Unsynchronized retain/release
 
-- Decouple dynamic casting and reflection from the standard library
+- Nonnull retain/release
+
+- Decouple dynamic casting, bridging, and reflection from the standard library

docs/SIL.rst

@@ -1389,7 +1389,7 @@ gets lowered to SIL as::
 
   sil @inout : $(@inout Int) -> () {
   entry(%x : $*Int):
-    %1 = integer_literal 1 : $Int
+    %1 = integer_literal $Int, 1
     store %1 to %x
     return
   }
@@ -4049,7 +4049,7 @@ select_value
   sil-instruction ::= 'select_value' sil-operand sil-select-value-case*
                       (',' 'default' sil-value)?
                       ':' sil-type
-  sil-selct-value-case ::= 'case' sil-value ':' sil-value
+  sil-select-value-case ::= 'case' sil-value ':' sil-value
 
 
   %n = select_value %0 : $U, \
@@ -4130,7 +4130,7 @@ original enum value.  For example::
       case #Foo.TwoInts!enumelt.1: two_ints
 
   nothing:
-    %zero = integer_literal 0 : $Int
+    %zero = integer_literal $Int, 0
     return %zero : $Int
 
   one_int(%y : $Int):

docs/StdlibAPIGuidelines.rst

@@ -200,7 +200,7 @@ Acceptable Short or Non-Descriptive Names
 
     func map<U>(transformation: T->U) -> [U] // not this one
 
-    func forEach<S: SequenceType>(body: (S.Iterator.Element)->())
+    func forEach<S: SequenceType>(body: (S.Iterator.Element) -> ())
 
 Prefixes and Suffixes
 ---------------------

docs/StringDesign.rst

@@ -940,7 +940,7 @@ Searching
 
 :Swift:
   .. parsed-literal::
-       func **find**\ (match: (Character)->Bool) -> Range<String.IndexType>
+       func **find**\ (match: (Character) -> Bool) -> Range<String.IndexType>
 
   .. Admonition:: Usage Example
 
@@ -1100,7 +1100,7 @@ Capitalization
 
 :Swift:
   .. parsed-literal::
-       trim **trim**\ (match: (Character)->Bool) -> String
+       trim **trim**\ (match: (Character) -> Bool) -> String
 
   .. Admonition:: Usage Example
 

docs/Testing.rst

@@ -313,6 +313,8 @@ Other substitutions:
 * ``%platform-sdk-overlay-dir``: absolute path of the directory where the SDK
   overlay module files for the target platform are stored.
 
+* ``%{python}``: run the same Python interpreter that's being used to run the
+  current ``lit`` test.
 
 When writing a test where output (or IR, SIL) depends on the bitness of the
 target CPU, use this pattern::

docs/archive/LangRefNew.rst

@@ -1537,8 +1537,8 @@ Short Circuiting Logical Operators
 
 ::
 
-  func && (lhs: Bool, rhs: ()->Bool) -> Bool
-  func || (lhs: Bool, rhs: ()->Bool) -> Bool
+  func && (lhs: Bool, rhs: () -> Bool) -> Bool
+  func || (lhs: Bool, rhs: () -> Bool) -> Bool
 
 Swift has a simplified precedence levels when compared with C.  From highest to
 lowest:

docs/doxygen.cfg.in

@@ -1239,7 +1239,7 @@ SEARCHENGINE           = @enable_searchengine@
 # using Javascript. Doxygen will generate the search PHP script and index
 # file to put on the web server. The advantage of the server
 # based approach is that it scales better to large projects and allows
-# full text search. The disadvances is that it is more difficult to setup
+# full text search. The disadvantage is that it is more difficult to setup
 # and does not have live searching capabilities.
 
 SERVER_BASED_SEARCH    = @enable_server_based_search@

docs/proposals/ArrayBridge.rst

@@ -4,7 +4,7 @@
 ..
 .. This source file is part of the Swift.org open source project
 ..
-.. Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
+.. Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
 .. Licensed under Apache License v2.0 with Runtime Library Exception
 ..
 .. See http://swift.org/LICENSE.txt for license information