This is an automated email from the ASF dual-hosted git repository.
wesm pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new a967068 ARROW-5632: [Doc] Basic instructions for using Xcode with
Arrow
a967068 is described below
commit a967068c486bd01056e8d5222a7c63275c1a2f5c
Author: Hatem Helal <hhe...@mathworks.com>
AuthorDate: Thu Jun 20 18:20:34 2019 -0700
ARROW-5632: [Doc] Basic instructions for using Xcode with Arrow
Added a new section on debugging with Xcode on macOS. I am a bit wary of
doing a step-by-step tutorial with screenshots as those tend to get quickly out
of date as the Xcode app evolves, and I think there will always be better
sources elsewhere for helping users ramp up on how to use Xcode. The goal is
to add enough to help someone familiar with C++ development in Xcode to get
started working on Arrow.
cc: @nealrichardson or @xhochy: I recall you both have macs, could you try
these instructions out and let me know if you run into any trouble? Any advice
on clarity, readability, etc would also be very welcome. I'm not sure if I
found the right location to add this so let me know if this fits in ok with the
rest of the overall cpp doc.
Author: Hatem Helal <hhe...@mathworks.com>
Closes #4596 from hatemhelal/arrow-5632 and squashes the following commits:
8cf81edf7 <Hatem Helal> Basic instructions for using Xcode with Arrow
---
docs/source/developers/cpp.rst | 21 +++++++++++++++++++++
1 file changed, 21 insertions(+)
diff --git a/docs/source/developers/cpp.rst b/docs/source/developers/cpp.rst
index e29583b..1244040 100644
--- a/docs/source/developers/cpp.rst
+++ b/docs/source/developers/cpp.rst
@@ -638,6 +638,27 @@ The report is then generated in
``compat_reports/libarrow`` as a HTML.
.. _developers-cpp-windows:
+Debugging with Xcode on macOS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Xcode is the IDE provided with macOS and can be use to develop and debug Arrow
+by generating an Xcode project:
+
+.. code-block:: shell
+
+ cd cpp
+ mkdir xcode-build
+ cd xcode-build
+ cmake .. -G Xcode ^
+ -DARROW_BUILD_TESTS=ON
+ open arrow.xcodeproj
+
+This will generate a project and open it in the Xcode app. As an alternative,
+the command ``xcodebuild`` will perform a command-line build using the
+generated project. It is recommended to use the "Automatically Create Schemes"
+option when first launching the project. Selecting an auto-generated scheme
+will allow you to build and run a unittest with breakpoints enabled.
+
Developing on Windows
=====================
