Merge pull request #17 from ryuichis/master

Update doc for 0.10.2 release

Author: Ryuichi Saito

_static/guide/xcode_screenshot_1.png

@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '0.10'
 # The full version, including alpha/beta/rc tags.
-release = '0.10.1'
+release = '0.10.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

_static/guide/xcode_screenshot_2.png

@@ -14,6 +14,10 @@ or
 
 * `Using OCLint with xctool <xctool.html>`_
 
+or
+
+* `Using OCLint with xcpretty <xcpretty.html>`_
+
 Background
 ----------
 
@@ -36,7 +40,9 @@ Setting up Target
 
 * In the script editor, we could enter the script which does the real work. We can also modify the script from this very `generic version <https://gist.github.com/gavrix/5054182>`_ and `its folks <https://gist.github.com/gavrix/5054182/forks>`_. We may need to change the ``xcodebuild`` options to use a particular scheme or target. In addition, based on the `discussions <xcodebuild.html#discussions>`_ we had, we can decide whether to use ``clean`` and ``dry run`` features.
 
-* For ``xctool`` users, the script can be largely simplified to something like `this <https://gist.github.com/lqi/5705477>`_
+* For ``xctool`` users, the script can be largely simplified to something like `this <https://gist.github.com/lqi/5705477>`_.
+
+* For ``xcpretty`` users, the script is also much simplier, check it out from `this gist <https://gist.github.com/ryuichis/755e6297aec13c900cdf>`_.
 
 .. image:: ../_static/guide/xcode_screenshot_4.png
 
@@ -48,9 +54,6 @@ Running Analysis
 .. image:: ../_static/guide/xcode_screenshot_6.png
 
 * Click to build, or use the shortcut ``Command+B``.
-
-.. image:: ../_static/guide/xcode_screenshot_7.png
-
 * When the progress bar scrolls to the very right, the analysis is done, then we can check out the analysis results same as compile warnings.
 
 .. image:: ../_static/guide/xcode_screenshot_8.png

_static/guide/xcode_screenshot_3.png

@@ -17,13 +17,13 @@ Running ``xcpretty`` is quite straight forward. For example, the command below w
 
 .. code-block:: bash
 
-  xcodebuild [flags] | xcpretty
+  xcodebuild [flags] | xcpretty -r json-compilation-database
 
 If you want to preserve the raw xcodebuild output, then you can do
 
 .. code-block:: bash
 
-  xcodebuild [flags] | tee xcodebuild.log | xcpretty
+  xcodebuild [flags] | tee xcodebuild.log | xcpretty -r json-compilation-database
 
 Running oclint-json-compilation-database
 ----------------------------------------

_static/guide/xcode_screenshot_4.png

@@ -44,21 +44,13 @@ XML Report (xml)
 
 XML reporter produces an XML report of the results.
 
-.. note::
-
-    This XML format is still being refined and is subject to change. 
-
 `Sample XML report <../_static/sample-reports/sample.xml>`_
 
 JSON Reporter (json)
 ^^^^^^^^^^^^^^^^^^^^
 
 JSON reporter produces an JSON report of the results.
 
-.. note::
-
-    This JSON format is still being refined and is subject to change.
-
 `Sample JSON report <../_static/sample-reports/sample.json>`_
 
 PMD Reporter (pmd)
@@ -68,6 +60,18 @@ Since `PMD <http://pmd.sourceforge.net/>`_  report is supported by many existing
 
 `Sample PMD report <../_static/sample-reports/sample-pmd.xml>`_
 
+Xcode Reporter (xcode)
+^^^^^^^^^^^^^^^^^^^^^^
+
+Xcode reporter can be used inside Xcode IDE.
+
+.. seealso::
+    Read `this document <../guide/xcode.html>`_ for using OCLint in Xcode.
+
+
+Details of using OCLint
+
+
 Configuration File
 ------------------
 
@@ -78,6 +82,6 @@ When a type of reporter is selected by the entire team, it's recommended to save
 
 
 .. seealso::
-    
+
     `Write Own Reporters <../devel/reporters.html>`_
         Documentation of writing own reporters to extend OCLint with more capabilities.

_static/guide/xcode_screenshot_5.png

@@ -21,6 +21,7 @@ Usage
   * `Bear <guide/bear.html>`_
   * `xctool <guide/xctool.html>`_
   * `xcodebuild <guide/xcodebuild.html>`_
+  * `xcpretty <guide/xcpretty>`_
   * `Xcode IDE <guide/xcode.html>`_
   * `Jenkins CI <guide/jenkins.html>`_