document llvmcall

Author: ihnorton

base/docs/basedocs.jl

@@ -501,6 +501,22 @@ keywords[:ccall] = doc"""
   in a call to `convert(ArgumentType, ArgumentValue)`.
   """
 
+keywords[:llvmcall] = doc"""
+      llvmcall(IR::String, ReturnType, (ArgumentType1, ...), ArgumentValue1, ...)
+
+   Call LLVM IR string in the first argument. Similar to an LLVM function ``define``
+   block, arguments are available as consecutive unnamed SSA variables (%0, %1, etc.).
+
+   Note that the argument type tuple must be a literal tuple, and not a tuple-valued variable or expression.
+
+   Each ``ArgumentValue`` to ``llvmcall`` will be converted to the corresponding ``ArgumentType``,
+   by automatic insertion of calls to ``unsafe_convert(ArgumentType, cconvert(ArgumentType, ArgumentValue))``.
+   (see also the documentation for each of these functions for further details).
+   In most cases, this simply results in a call to ``convert(ArgumentType, ArgumentValue)``.
+
+   See ``test/llvmcall.jl`` for usage examples.
+"""
+
 keywords[:begin] = doc"""
   `begin...end` denotes a block of code.
 

doc/stdlib/base.rst

@@ -899,7 +899,6 @@ System
 
    Get the IP address of the local machine.
 
-
 .. function:: getpid() -> Int32
 
    .. Docstring generated from Julia source

doc/stdlib/c.rst

@@ -248,3 +248,20 @@
 .. data:: Cdouble
 
    Equivalent to the native ``double`` c-type (Float64)
+
+****************
+ LLVM Interface
+****************
+
+.. function::   llvmcall(IR::String, ReturnType, (ArgumentType1, ...), ArgumentValue1, ...)
+
+   .. Docstring generated from Julia source
+
+   Call LLVM IR string in the first argument. Similar to an LLVM function ``define``    block, arguments are available as consecutive unnamed SSA variables (%0, %1, etc.).
+
+   Note that the argument type tuple must be a literal tuple, and not a tuple-valued variable or expression.
+
+   Each ``ArgumentValue`` to ``llvmcall`` will be converted to the corresponding ``ArgumentType``\ ,    by automatic insertion of calls to ``unsafe_convert(ArgumentType, cconvert(ArgumentType, ArgumentValue))``\ .    (see also the documentation for each of these functions for further details).    In most cases, this simply results in a call to ``convert(ArgumentType, ArgumentValue)``\ .
+
+   See ``test/llvmcall.jl`` for usage examples.
+

doc/stdlib/collections.rst

@@ -221,6 +221,12 @@ Iterable Collections
 
    Returns an array containing only the unique elements of the iterable ``itr``\ , in the order that the first of each set of equivalent elements originally appears. If ``dim`` is specified, returns unique regions of the array ``itr`` along ``dim``\ .
 
+   .. code-block:: julia
+
+       unique(f, itr)
+
+   Returns an array containing one value from ``itr`` for each unique value produced by ``f`` applied to elements of ``itr``\ .
+
 .. function:: reduce(op, v0, itr)
 
    .. Docstring generated from Julia source

doc/stdlib/io-network.rst

@@ -805,6 +805,8 @@ Network I/O
 
 .. function:: getsockname(sock::Union{TCPServer, TCPSocket}) -> (IPAddr,UInt16)
 
+   .. Docstring generated from Julia source
+
    Get the IP address and the port that the given TCP socket is connected to (or bound to, in the case of TCPServer).
 
 .. function:: parseip(addr)