diff --git a/docs/Guide-Installation-Setup-template.md b/docs/Guide-Installation-Setup-template.md index a6e9357a15..9bd09678bf 100644 --- a/docs/Guide-Installation-Setup-template.md +++ b/docs/Guide-Installation-Setup-template.md @@ -5,10 +5,19 @@ It is possible to install HockeySDK either using a [binary framework distributio This document contains the following sections: +- [Prerequisites](#prerequisites) - [Installation with binary framework distribution](#framework) - [Installation as subproject](#subproject) - [Setup HockeySDK](#setup) + +## Prerequisites + +1. Before you integrate HockeySDK into your own app, you should add the app to HockeyApp if you haven't already. Read [this how-to](http://support.hockeyapp.net/kb/how-tos/how-to-create-a-new-app) on how to do it. +2. We also assume that you already have a project in Xcode and that this project is opened in Xcode 4. +3. The SDK supports iOS 4.0 or newer. +4. Make sure any other crash reporting framework or exception handler is **disabled**! +5. Make sure previous versions of `PLCrashReporter` is removed! Search for `CrashReporter.framework` in your Project navigator. ## Installation with binary framework distribution @@ -46,7 +55,19 @@ This document contains the following sections: ![XcodeOtherLinkerFlags.png](XcodeOtherLinkerFlags_normal.png) 14. Hit `Done`. -15. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries: +16. Search for `preprocessor macros` + + ![XcodeMacros1.png](XcodeMacros1_normal.png) + +17. Select the top-most line and double-click the value field. +18. Click the + button. +19. Enter the following string into the input field and finish with "Done".
CONFIGURATION_$(CONFIGURATION)
+ + ![XcodeMacros2.png](XcodeMacros2_normal.png) + + Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of **YOUR** build configuration. + +20. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries: * [JSONKit](https://github.com/johnezang/JSONKit) * [SBJSON](https://github.com/stig/json-framework) * [YAJL](https://github.com/gabriel/yajl-objc) @@ -108,7 +129,18 @@ This document contains the following sections: ![XcodeOtherLinkerFlags.png](XcodeOtherLinkerFlags_normal.png) 19. Hit `Done`. -20. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries: +20. Search for `preprocessor macros` + + ![XcodeMacros1.png](XcodeMacros1_normal.png) + +21. Select the top-most line and double-click the value field. +22. Click the + button. +23. Enter the following string into the input field and finish with "Done".
CONFIGURATION_$(CONFIGURATION)
+ + ![XcodeMacros2.png](XcodeMacros2_normal.png) + + Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of **YOUR** build configuration. +24. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries: * [JSONKit](https://github.com/johnezang/JSONKit) * [SBJSON](https://github.com/stig/json-framework) * [YAJL](https://github.com/gabriel/yajl-objc) diff --git a/docs/HowTo-Configuration-Based-Setup-template.md b/docs/HowTo-Configuration-Based-Setup-template.md deleted file mode 100644 index 797be2a2d7..0000000000 --- a/docs/HowTo-Configuration-Based-Setup-template.md +++ /dev/null @@ -1,41 +0,0 @@ -## Introduction - -It can be useful to use a different setup depending on your Xcode build configuration, e.g. disable Beta Update checks in Debug builds. - -To do that, we recommend to define a preprocessor macro for all configurations and use compiler directives to setup the SDK depending on the currently used build configuration. - -**Note:** Beta Update checks is automatically disable when the SDK detects it is running in an App Store build. So you don't have to do anything in that scenario! - -## HowTo - -1. Select your project in the Project Navigator. -2. Select your target. -3. Select the tab "Build Settings". -4. Enter "preprocessor macros" into the search field. - - ![XcodeMacros1.png](XcodeMacros1_normal.png) - -5. Select the top-most line and double-click the value field. -6. Click the + button. -7. Enter the following string into the input field and finish with "Done".
CONFIGURATION_$(CONFIGURATION)
- - ![XcodeMacros2.png](XcodeMacros2_normal.png) - -Now you can use `#if defined (CONFIGURATION_ABCDEF)` directives in your code, where `ABCDEF` is the actual name of your build configuration. - -**Note:** Make sure to use build configuration names without spaces! - -## Example - - #if defined (CONFIGURATION_Debug) - [[BITHockeyManager sharedHockeyManager] configureWithIdentifier:@"<>" - delegate:nil]; - [[BITHockeyManager sharedHockeyManager] setDisableUpdateManager:YES]; - #else - [[BITHockeyManager sharedHockeyManager] configureWithBetaIdentifier:@"<>" - liveIdentifier:@"<>" - delegate:nil]; - #endif - - [[BITHockeyManager sharedHockeyManager] startManager]; - diff --git a/docs/Troubleshooting-Crashes-Dont-Appear-template.md b/docs/Troubleshooting-Crashes-Dont-Appear-template.md index d2785dfa05..04ac29fcb2 100644 --- a/docs/Troubleshooting-Crashes-Dont-Appear-template.md +++ b/docs/Troubleshooting-Crashes-Dont-Appear-template.md @@ -2,9 +2,13 @@ This is a checklist to help find the issue if crashes do not appear in HockeyApp: + 1. Check if the `BETA_IDENTIFIER` or `LIVE_IDENTIFIER` matches the App ID in HockeyApp. 2. Check if CFBundleIdentifier in your Info.plist matches the Bundle Identifier of the app in HockeyApp. HockeyApp accepts crashes only if both the App ID and the Bundle Identifier equal their corresponding values in your plist and source code. 3. Unless you have set `[BITCrashManager setCrashManagerStatus:]` to `BITCrashManagerStatusAutoSubmit`: If your app crashes and you start it again, is the alert shown which asks the user to send the crash report? If not, please crash your app again, then connect the debugger and set a break point in `BITCrashManager.m`, method `startManager` to see why the alert is not shown. 4. Check if the code is really executed by adding an `NSLog` statement. 5. If you are using `#ifdef (CONFIGURATION_something)`, make sure that the `something` string matches the exact name of your Xcode build configuration. Spaces are not allowed! -6. If it still does not work, please [contact us](http://support.hockeyapp.net/discussion/new). \ No newline at end of file +6. Remove of at least disable any other exception handler or crash reporting framework. +7. If there an older version of PLCrashReporters framework `CrashReporter.framework` added to the project, remove it. +6. If it still does not work, please [contact us](http://support.hockeyapp.net/discussion/new). + diff --git a/docs/index.md b/docs/index.md index 3c04716fab..1b067f6945 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,4 @@ -Introduction -============ +## Introduction HockeySDK-iOS implements support for using HockeyApp in your iOS applications. @@ -11,31 +10,26 @@ The following features are currently supported: The main SDK class is `BITHockeyManager`. It initializes all modules and provides access to them, so they can be further adjusted if required. Additionally all modules provide their own protocols. -Prerequisites -============= +## Prerequisites 1. Before you integrate HockeySDK into your own app, you should add the app to HockeyApp if you haven't already. Read [this how-to](http://support.hockeyapp.net/kb/how-tos/how-to-create-a-new-app) on how to do it. 2. We also assume that you already have a project in Xcode and that this project is opened in Xcode 4. 3. The SDK supports iOS 4.0 or newer. -Guides -====== +## Guides - [Installation & Setup](Guide-Installation-Setup) - [Migration from HockeyKit & QuincyKit](Guide-Migration-Kits) -HowTos -====== +## HowTos - [How to do app versioning](HowTo-App-Versioning) - [How to upload symbols for crash reporting](HowTo-Upload-Symbols) - [How to handle crashes on startup](HowTo-Handle-Crashes-On-Startup) -- [How to do Xcode build confugration based SDK setup](HowTo-Configuration-Based-Setup) - [How to add application specific log data](HowTo-Add-Application-Log) -Troubleshooting -=============== +## Troubleshooting - [Symbolication doesn't work](Symbolication-Doesnt-Work) (Or the rules of binary UUIDs and dSYMs) - [Crashes do not appear on HockeyApp](Troubleshooting-Crashes-Dont-Appear)