forked from OSchip/llvm-project
[Docs] Modernize references to macOS
Summary: This updates all places in documentation that refer to "Mac OS X", "OS X", etc. to instead use the modern name "macOS" when no specific version number is mentioned. If a specific version is mentioned, this attempts to use the OS name at the time of that version: * Mac OS X for 10.0 - 10.7 * OS X for 10.8 - 10.11 * macOS for 10.12 - present Reviewers: JDevlieghere Subscribers: mgorny, christof, arphaman, cfe-commits, lldb-commits, libcxx-commits, llvm-commits Tags: #clang, #lldb, #libc, #llvm Differential Revision: https://reviews.llvm.org/D62654 llvm-svn: 362113
This commit is contained in:
J. Ryan Stinnett
parent
2e1807678d
commit
d45eaf9405
|
|
@ -119,7 +119,7 @@ force disabled by setting ``ASAN_OPTIONS=symbolize=0``):
|
|||
#1 0x7f7ddabcac4d in __libc_start_main ??:0
|
||||
...
|
||||
|
||||
Note that on OS X you may need to run ``dsymutil`` on your binary to have the
|
||||
Note that on macOS you may need to run ``dsymutil`` on your binary to have the
|
||||
file\:line info in the AddressSanitizer reports.
|
||||
|
||||
Additional Checks
|
||||
|
|
@ -134,14 +134,14 @@ globals defined in another translation unit. To enable this check at runtime,
|
|||
you should set environment variable
|
||||
``ASAN_OPTIONS=check_initialization_order=1``.
|
||||
|
||||
Note that this option is not supported on OS X.
|
||||
Note that this option is not supported on macOS.
|
||||
|
||||
Memory leak detection
|
||||
---------------------
|
||||
|
||||
For more information on leak detector in AddressSanitizer, see
|
||||
:doc:`LeakSanitizer`. The leak detection is turned on by default on Linux,
|
||||
and can be enabled using ``ASAN_OPTIONS=detect_leaks=1`` on OS X;
|
||||
and can be enabled using ``ASAN_OPTIONS=detect_leaks=1`` on macOS;
|
||||
however, it is not yet supported on other platforms.
|
||||
|
||||
Issue Suppression
|
||||
|
|
@ -273,7 +273,7 @@ Supported Platforms
|
|||
AddressSanitizer is supported on:
|
||||
|
||||
* Linux i386/x86\_64 (tested on Ubuntu 12.04)
|
||||
* OS X 10.7 - 10.11 (i386/x86\_64)
|
||||
* macOS 10.7 - 10.11 (i386/x86\_64)
|
||||
* iOS Simulator
|
||||
* Android ARM
|
||||
* NetBSD i386/x86\_64
|
||||
|
|
|
|||
|
|
@ -268,7 +268,7 @@ ARC's semantics and restrictions.
|
|||
* There must be reliable conventions for whether and when "ownership" is
|
||||
passed between caller and callee, for both arguments and return values.
|
||||
Objective-C methods follow such a convention very reliably, at least for
|
||||
system libraries on Mac OS X, and functions always pass objects at +0. The
|
||||
system libraries on macOS, and functions always pass objects at +0. The
|
||||
C-based APIs for Core Foundation objects, on the other hand, have much more
|
||||
varied transfer semantics.
|
||||
|
||||
|
|
|
|||
|
|
@ -2218,7 +2218,7 @@ Generate branches with extended addressability, usually via indirect jumps.
|
|||
|
||||
.. option:: -mmacosx-version-min=<arg>, -mmacos-version-min=<arg>
|
||||
|
||||
Set Mac OS X deployment target
|
||||
Set macOS deployment target
|
||||
|
||||
.. option:: -mmcu=<arg>
|
||||
|
||||
|
|
|
|||
|
|
@ -316,7 +316,7 @@ number of cross compilers, or may only support a native target.
|
|||
|
||||
.. option:: -mmacosx-version-min=<version>
|
||||
|
||||
When building for Mac OS X, specify the minimum version supported by your
|
||||
When building for macOS, specify the minimum version supported by your
|
||||
application.
|
||||
|
||||
.. option:: -miphoneos-version-min
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ detection phase.
|
|||
Usage
|
||||
=====
|
||||
|
||||
LeakSanitizer is supported on x86\_64 Linux and OS X. In order to use it,
|
||||
LeakSanitizer is supported on x86\_64 Linux and macOS. In order to use it,
|
||||
simply build your program with :doc:`AddressSanitizer`:
|
||||
|
||||
.. code-block:: console
|
||||
|
|
|
|||
|
|
@ -360,7 +360,7 @@ The *module-id* should consist of only a single *identifier*, which provides the
|
|||
|
||||
The ``explicit`` qualifier can only be applied to a submodule, i.e., a module that is nested within another module. The contents of explicit submodules are only made available when the submodule itself was explicitly named in an import declaration or was re-exported from an imported module.
|
||||
|
||||
The ``framework`` qualifier specifies that this module corresponds to a Darwin-style framework. A Darwin-style framework (used primarily on Mac OS X and iOS) is contained entirely in directory ``Name.framework``, where ``Name`` is the name of the framework (and, therefore, the name of the module). That directory has the following layout:
|
||||
The ``framework`` qualifier specifies that this module corresponds to a Darwin-style framework. A Darwin-style framework (used primarily on macOS and iOS) is contained entirely in directory ``Name.framework``, where ``Name`` is the name of the framework (and, therefore, the name of the module). That directory has the following layout:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@ and link command lines.
|
|||
Supported Platforms
|
||||
-------------------
|
||||
|
||||
SafeStack was tested on Linux, NetBSD, FreeBSD and MacOSX.
|
||||
SafeStack was tested on Linux, NetBSD, FreeBSD and macOS.
|
||||
|
||||
Low-level API
|
||||
-------------
|
||||
|
|
|
|||
|
|
@ -295,7 +295,7 @@ UndefinedBehaviorSanitizer is supported on the following operating systems:
|
|||
* NetBSD
|
||||
* FreeBSD
|
||||
* OpenBSD
|
||||
* OS X 10.6 onwards
|
||||
* macOS
|
||||
* Windows
|
||||
|
||||
The runtime library is relatively portable and platform independent. If the OS
|
||||
|
|
|
|||
|
|
@ -1006,7 +1006,7 @@ on-disk cache that contains the vital information necessary to reduce
|
|||
some of the work needed to process a corresponding header file. While
|
||||
details of precompiled headers vary between compilers, precompiled
|
||||
headers have been shown to be highly effective at speeding up program
|
||||
compilation on systems with very large system headers (e.g., Mac OS X).
|
||||
compilation on systems with very large system headers (e.g., macOS).
|
||||
|
||||
Generating a PCH File
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -2746,7 +2746,7 @@ X86
|
|||
^^^
|
||||
|
||||
The support for X86 (both 32-bit and 64-bit) is considered stable on
|
||||
Darwin (Mac OS X), Linux, FreeBSD, and Dragonfly BSD: it has been tested
|
||||
Darwin (macOS), Linux, FreeBSD, and Dragonfly BSD: it has been tested
|
||||
to correctly compile many large C, C++, Objective-C, and Objective-C++
|
||||
codebases.
|
||||
|
||||
|
|
@ -2801,8 +2801,8 @@ backend.
|
|||
Operating System Features and Limitations
|
||||
-----------------------------------------
|
||||
|
||||
Darwin (Mac OS X)
|
||||
^^^^^^^^^^^^^^^^^
|
||||
Darwin (macOS)
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Thread Sanitizer is not supported.
|
||||
|
||||
|
|
|
|||
|
|
@ -778,7 +778,7 @@ Check for null pointers being passed as arguments to C string functions:
|
|||
|
||||
osx
|
||||
^^^
|
||||
OS X checkers.
|
||||
macOS checkers.
|
||||
|
||||
osx.API (C)
|
||||
"""""""""""
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ General Analysis Dumpers
|
|||
|
||||
These checkers are used to dump the results of various infrastructural analyses
|
||||
to stderr. Some checkers also have "view" variants, which will display a graph
|
||||
using a 'dot' format viewer (such as Graphviz on OS X) instead.
|
||||
using a 'dot' format viewer (such as Graphviz on macOS) instead.
|
||||
|
||||
- debug.DumpCallGraph, debug.ViewCallGraph: Show the call graph generated for
|
||||
the current translation unit. This is used to determine the order in which to
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ The basic steps needed to build libc++ are:
|
|||
|
||||
.. warning::
|
||||
* Replacing your systems libc++ installation could render the system non-functional.
|
||||
* Mac OS X will not boot without a valid copy of ``libc++.1.dylib`` in ``/usr/lib``.
|
||||
* macOS will not boot without a valid copy of ``libc++.1.dylib`` in ``/usr/lib``.
|
||||
|
||||
|
||||
The instructions are for building libc++ on
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ If you already have libc++ installed you can use it with clang.
|
|||
$ clang++ -stdlib=libc++ test.cpp
|
||||
$ clang++ -std=c++11 -stdlib=libc++ test.cpp
|
||||
|
||||
On OS X and FreeBSD libc++ is the default standard library
|
||||
On macOS and FreeBSD libc++ is the default standard library
|
||||
and the ``-stdlib=libc++`` is not required.
|
||||
|
||||
.. _alternate libcxx:
|
||||
|
|
@ -34,7 +34,7 @@ can use the following options.
|
|||
The option ``-Wl,-rpath,<libcxx-install-prefix>/lib`` adds a runtime library
|
||||
search path. Meaning that the systems dynamic linker will look for libc++ in
|
||||
``<libcxx-install-prefix>/lib`` whenever the program is run. Alternatively the
|
||||
environment variable ``LD_LIBRARY_PATH`` (``DYLD_LIBRARY_PATH`` on OS X) can
|
||||
environment variable ``LD_LIBRARY_PATH`` (``DYLD_LIBRARY_PATH`` on macOS) can
|
||||
be used to change the dynamic linkers search paths after a program is compiled.
|
||||
|
||||
An example of using ``LD_LIBRARY_PATH``:
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ and GCC.
|
|||
============ ==================== ============ ========================
|
||||
OS Arch Compilers ABI Library
|
||||
============ ==================== ============ ========================
|
||||
Mac OS X i386, x86_64 Clang, GCC libc++abi
|
||||
macOS i386, x86_64 Clang, GCC libc++abi
|
||||
FreeBSD 10+ i386, x86_64, ARM Clang, GCC libcxxrt, libc++abi
|
||||
Linux i386, x86_64 Clang, GCC libc++abi
|
||||
============ ==================== ============ ========================
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ FreeBSD i386, x86_64, ARM64 Clang DWARF CFI
|
|||
iOS ARM Clang SjLj
|
||||
Linux ARM Clang, GCC EHABI
|
||||
Linux i386, x86_64, ARM64 Clang, GCC DWARF CFI
|
||||
Mac OS X i386, x86_64 Clang, GCC DWARF CFI
|
||||
macOS i386, x86_64 Clang, GCC DWARF CFI
|
||||
NetBSD x86_64 Clang, GCC DWARF CFI
|
||||
Windows i386, x86_64, ARM, ARM64 Clang DWARF CFI
|
||||
============ ======================== ============ ========================
|
||||
|
|
|
|||
|
|
@ -43,8 +43,8 @@ to install it using:
|
|||
Use your distribution's standard package management tool to install it,
|
||||
i.e., ``apt-get install easy_install`` or ``yum install easy_install``.
|
||||
|
||||
Mac OS X
|
||||
All modern Mac OS X systems come with ``easy_install`` as part of the base
|
||||
macOS
|
||||
All modern macOS systems come with ``easy_install`` as part of the base
|
||||
system.
|
||||
|
||||
Windows
|
||||
|
|
|
|||
|
|
@ -787,9 +787,9 @@ os_version: a version string that represents the current OS version (10.8.2)
|
|||
watchpoint_exceptions_received: one of "before" or "after" to specify if a watchpoint is triggered before or after the pc when it stops
|
||||
default_packet_timeout: an unsigned number that specifies the default timeout in seconds
|
||||
distribution_id: optional. For linux, specifies distribution id (e.g. ubuntu, fedora, etc.)
|
||||
osmajor: optional, specifies the major version number of the OS (e.g. for Mac OS X 10.11.2, it would be 10)
|
||||
osminor: optional, specifies the minor version number of the OS (e.g. for Mac OS X 10.11.2, it would be 11)
|
||||
ospatch: optional, specifies the patch level number of the OS (e.g. for Mac OS X 10.11.2, it would be 2)
|
||||
osmajor: optional, specifies the major version number of the OS (e.g. for macOS 10.12.2, it would be 10)
|
||||
osminor: optional, specifies the minor version number of the OS (e.g. for macOS 10.12.2, it would be 12)
|
||||
ospatch: optional, specifies the patch level number of the OS (e.g. for macOS 10.12.2, it would be 2)
|
||||
|
||||
//----------------------------------------------------------------------
|
||||
// "qGDBServerVersion"
|
||||
|
|
@ -1160,7 +1160,7 @@ for this region.
|
|||
// second form of this packet is used, otherwise the first form is
|
||||
// used. This packet is called prior to executing an expression, so
|
||||
// the remote GDB server should do anything it needs to in order to
|
||||
// ensure the registers that are saved are correct. On MacOSX this
|
||||
// ensure the registers that are saved are correct. On macOS this
|
||||
// involves calling "thread_abort_safely(mach_port_t thread)" to
|
||||
// ensure we get the correct registers for a thread in case it is
|
||||
// currently having code run on its behalf in the kernel.
|
||||
|
|
@ -1723,7 +1723,7 @@ for this region.
|
|||
// There are three ways this packet can be used. All three return a dictionary of
|
||||
// binary images formatted the same way.
|
||||
//
|
||||
// On MacOS X 10.11, iOS 9, tvOS 9, watchOS 2 and earlier, the packet is used like
|
||||
// On OS X 10.11, iOS 9, tvOS 9, watchOS 2 and earlier, the packet is used like
|
||||
// jGetLoadedDynamicLibrariesInfos:{"image_count":1,"image_list_address":140734800075128}
|
||||
// where the image_list_address is an array of {void* load_addr, void* mod_date, void* pathname}
|
||||
// in the inferior process memory (and image_count is the number of elements in this array).
|
||||
|
|
@ -1863,9 +1863,9 @@ server to expedite memory that the client is likely to use (e.g., areas around t
|
|||
stack pointer, which are needed for computing backtraces) and it reduces the packet
|
||||
count.
|
||||
|
||||
On MacOSX with debugserver, we expedite the frame pointer backchain for a thread
|
||||
On macOS with debugserver, we expedite the frame pointer backchain for a thread
|
||||
(up to 256 entries) by reading 2 pointers worth of bytes at the frame pointer (for
|
||||
the previous FP and PC), and follow the backchain. Most backtraces on MacOSX and
|
||||
the previous FP and PC), and follow the backchain. Most backtraces on macOS and
|
||||
iOS now don't require us to read any memory!
|
||||
|
||||
//----------------------------------------------------------------------
|
||||
|
|
|
|||
|
|
@ -117,8 +117,12 @@ There are two ways to build LLDB on macOS: Using Xcode and using CMake
|
|||
|
||||
**Preliminaries**
|
||||
|
||||
* Xcode 4.3 or newer requires the "Command Line Tools" component (XCode->Preferences->Downloads->Components).
|
||||
* Mac OS X Lion or newer requires installing `Swig <http://swig.org/>`_.
|
||||
In addition to any dependencies required by LLVM and Clang, LLDB needs a few
|
||||
development packages that may also need to be installed depending on your
|
||||
system. The current list of dependencies are:
|
||||
|
||||
* Xcode 4.3 or newer requires the "Command Line Tools" component (XCode->Preferences->Downloads->Components)
|
||||
* `Swig <http://swig.org/>`_
|
||||
|
||||
**Building LLDB with Xcode**
|
||||
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ advanced debugging operations, like copying files from/to the remote system and
|
|||
can be used to execute arbitrary shell commands on the remote system.
|
||||
|
||||
In order to reduce code complexity and improve remote debugging experience LLDB
|
||||
on Linux and OSX uses the remote debugging stub even when debugging a process
|
||||
on Linux and macOS uses the remote debugging stub even when debugging a process
|
||||
locally. This is achieved by spawning a remote stub process locally and
|
||||
communicating with it over the loopback interface. In the case of local
|
||||
debugging this whole process is transparent to the user. The platform binary is
|
||||
|
|
@ -44,7 +44,7 @@ gdb-remote stub. A single binary facilitates deployment and reduces code size,
|
|||
since the two functions share a lot of code. The lldb-server binary is also
|
||||
statically linked with the rest of LLDB (unlike lldb, which dynamically links
|
||||
to liblldb.so by default), so it does not have any dependencies on the rest of
|
||||
lldb. On Mac OSX and iOS, the remote-gdb functionality is implemented by the
|
||||
lldb. On macOS and iOS, the remote-gdb functionality is implemented by the
|
||||
debugserver binary, which you will need to deploy alongside lldb-server.
|
||||
|
||||
The binaries mentioned above need to be present on the remote system to enable
|
||||
|
|
|
|||
|
|
@ -533,7 +533,7 @@ LLVM-specific variables
|
|||
`share/doc/llvm/ocaml-html`.
|
||||
|
||||
**LLVM_CREATE_XCODE_TOOLCHAIN**:BOOL
|
||||
OS X Only: If enabled CMake will generate a target named
|
||||
macOS Only: If enabled CMake will generate a target named
|
||||
'install-xcode-toolchain'. This target will create a directory at
|
||||
$CMAKE_INSTALL_PREFIX/Toolchains containing an xctoolchain directory which can
|
||||
be used to override the default system tools.
|
||||
|
|
|
|||
|
|
@ -229,7 +229,7 @@ STANDARDS
|
|||
|
||||
The **llvm-ar** utility is intended to provide a superset of the IEEE Std 1003.2
|
||||
(POSIX.2) functionality for ``ar``. **llvm-ar** can read both SVR4 and BSD4.4 (or
|
||||
Mac OS X) archives. If the ``f`` modifier is given to the ``x`` or ``r`` operations
|
||||
macOS) archives. If the ``f`` modifier is given to the ``x`` or ``r`` operations
|
||||
then **llvm-ar** will write SVR4 compatible archives. Without this modifier,
|
||||
**llvm-ar** will write BSD4.4 compatible archives that have long names
|
||||
immediately after the header and indicated using the "#1/ddd" notation for the
|
||||
|
|
@ -240,7 +240,7 @@ FILE FORMAT
|
|||
-----------
|
||||
|
||||
|
||||
The file format for LLVM Archive files is similar to that of BSD 4.4 or Mac OSX
|
||||
The file format for LLVM Archive files is similar to that of BSD 4.4 or macOS
|
||||
archive files. In fact, except for the symbol table, the ``ar`` commands on those
|
||||
operating systems should be able to read LLVM archive files. The details of the
|
||||
file format follow.
|
||||
|
|
|
|||
|
|
@ -140,8 +140,8 @@ Linux
|
|||
* `ELF for the ARM 64-bit Architecture (AArch64) <http://infocenter.arm.com/help/topic/com.arm.doc.ihi0056a/IHI0056A_aaelf64.pdf>`_
|
||||
* `System z ELF ABI Supplement <http://legacy.redhat.com/pub/redhat/linux/7.1/es/os/s390x/doc/lzsabi0.pdf>`_
|
||||
|
||||
OS X
|
||||
----
|
||||
macOS
|
||||
-----
|
||||
|
||||
* `Mach-O Runtime Architecture <http://developer.apple.com/documentation/Darwin/RuntimeArchitecture-date.html>`_
|
||||
* `Notes on Mach-O ABI <http://www.unsanity.org/archives/000044.php>`_
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ GDB Version
|
|||
In order to debug code JIT-ed by LLVM, you need GDB 7.0 or newer, which is
|
||||
available on most modern distributions of Linux. The version of GDB that
|
||||
Apple ships with Xcode has been frozen at 6.3 for a while. LLDB may be a
|
||||
better option for debugging JIT-ed code on Mac OS X.
|
||||
better option for debugging JIT-ed code on macOS.
|
||||
|
||||
|
||||
Debugging MCJIT-ed code
|
||||
|
|
|
|||
|
|
@ -128,8 +128,8 @@ FreeBSD x86\ :sup:`1` GCC, Clang
|
|||
FreeBSD amd64 GCC, Clang
|
||||
NetBSD x86\ :sup:`1` GCC, Clang
|
||||
NetBSD amd64 GCC, Clang
|
||||
MacOS X\ :sup:`2` PowerPC GCC
|
||||
MacOS X x86 GCC, Clang
|
||||
macOS\ :sup:`2` PowerPC GCC
|
||||
macOS x86 GCC, Clang
|
||||
Cygwin/Win32 x86\ :sup:`1, 3` GCC
|
||||
Windows x86\ :sup:`1` Visual Studio
|
||||
Windows x64 x86-64 Visual Studio
|
||||
|
|
@ -272,7 +272,7 @@ newer version of Gold.
|
|||
Getting a Modern Host C++ Toolchain
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
This section mostly applies to Linux and older BSDs. On Mac OS X, you should
|
||||
This section mostly applies to Linux and older BSDs. On macOS, you should
|
||||
have a sufficiently modern Xcode, or you will likely need to upgrade until you
|
||||
do. Windows does not have a "system compiler", so you must install either Visual
|
||||
Studio 2015 or a recent version of mingw64. FreeBSD 10.0 and newer have a modern
|
||||
|
|
@ -711,7 +711,7 @@ define compiler flags and variables used during the CMake test operations.
|
|||
|
||||
The result of such a build is executables that are not runnable on the build
|
||||
host but can be executed on the target. As an example the following CMake
|
||||
invocation can generate build files targeting iOS. This will work on Mac OS X
|
||||
invocation can generate build files targeting iOS. This will work on macOS
|
||||
with the latest Xcode:
|
||||
|
||||
.. code-block:: console
|
||||
|
|
|
|||
|
|
@ -1372,8 +1372,8 @@ these functions in your code in places you want to debug.
|
|||
|
||||
Getting this to work requires a small amount of setup. On Unix systems
|
||||
with X11, install the `graphviz <http://www.graphviz.org>`_ toolkit, and make
|
||||
sure 'dot' and 'gv' are in your path. If you are running on Mac OS X, download
|
||||
and install the Mac OS X `Graphviz program
|
||||
sure 'dot' and 'gv' are in your path. If you are running on macOS, download
|
||||
and install the macOS `Graphviz program
|
||||
<http://www.pixelglow.com/graphviz/>`_ and add
|
||||
``/Applications/Graphviz.app/Contents/MacOS/`` (or wherever you install it) to
|
||||
your path. The programs need not be present when configuring, building or
|
||||
|
|
|
|||
|
|
@ -511,7 +511,7 @@ RUN lines:
|
|||
The suffix for the host platforms shared library files. This includes the
|
||||
period as the first character.
|
||||
|
||||
Example: ``.so`` (Linux), ``.dylib`` (OS X), ``.dll`` (Windows)
|
||||
Example: ``.so`` (Linux), ``.dylib`` (macOS), ``.dll`` (Windows)
|
||||
|
||||
``%exeext``
|
||||
The suffix for the host platforms executable files. This includes the
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ This build script specifies that ``Hello.cpp`` file in the current directory
|
|||
is to be compiled and linked into a shared object ``$(LEVEL)/lib/LLVMHello.so`` that
|
||||
can be dynamically loaded by the :program:`opt` tool via its :option:`-load`
|
||||
option. If your operating system uses a suffix other than ``.so`` (such as
|
||||
Windows or Mac OS X), the appropriate extension will be used.
|
||||
Windows or macOS), the appropriate extension will be used.
|
||||
|
||||
Now that we have the build scripts set up, we just need to write the code for
|
||||
the pass itself.
|
||||
|
|
|
|||
Loading…
Reference in New Issue