Skip to content

Commit 4512521

Browse files
authored
Merge pull request #1831 from NativeScript/docs
docs improved
2 parents 5e5c839 + 372f32c commit 4512521

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

docs/man_pages/project/testing/debug-android.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
debug android
22
==========
33

4-
All you need to do to start debugging your app is to execute `tns debug android`. The NativeScript CLI will build, deploy, start your app, start Chrome DevTools and attach the debugger.
5-
* You cannot debug if there are multiple devices available (emulators and/or real devices). You need to have started only one device or emulator.
6-
74
Usage | Synopsis
85
---|---
9-
Deploy on device, run the app and attach the debugger | `$ tns debug android`
10-
Deploy on device, run the app and stop at the first breakpoint | `$ tns debug android --debug-brk [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
11-
Deploy in the native emulator, run the app and stop at the first breakpoint | `$ tns debug android --debug-brk --emulator [<Emulator Options>] [--timeout <timeout>]`
12-
Deploy in Genymotion, run the app and stop at the first breakpoint | `$ tns debug android --debug-brk --geny <Geny Name> [--timeout <timeout>]`
6+
Deploy on device, run the app start Chrome DevTools, and attach the debugger | `$ tns debug android`
7+
Deploy on device, run the app and stop at the first code statement | `$ tns debug android --debug-brk [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
8+
Deploy in the native emulator, run the app and stop at the first code statement | `$ tns debug android --debug-brk --emulator [<Emulator Options>] [--timeout <timeout>]`
9+
Deploy in Genymotion, run the app and stop at the first code statement | `$ tns debug android --debug-brk --geny <Geny Name> [--timeout <timeout>]`
1310
Attach the debug tools to a running app on device | `$ tns debug android --start [--device <Device ID>] [--debug-port <port>] [--timeout <timeout>]`
1411
Attach the debug tools to a running app in the native emulator | `$ tns debug android --start --emulator [<Emulator Options>] [--timeout <timeout>]`
1512
Attach the debug tools to a running app in Genymotion | `$ tns debug android --start --geny <Geny Name> [--print-app-output] [--timeout <timeout>]`
@@ -22,7 +19,7 @@ Debugs your project on a connected device, in a native emulator or in Genymotion
2219
* `--device` - Specifies a connected device on which to debug the app.
2320
* `--emulator` - Specifies that you want to debug the app in the native Android emulator from the Android SDK.
2421
* `--geny` - Specifies a Genymotion emulator on which you want to debug your app.
25-
* `--debug-brk` - Prepares, builds and deploys the application package on a device or in an emulator, launches the Chrome DevTools of your Chrome browser.
22+
* `--debug-brk` - Prepares, builds and deploys the application package on a device or in an emulator, launches the Chrome DevTools of your Chrome browser and stops at the first code statement.
2623
* `--start` - Attaches the debug tools to a deployed and running app.
2724
* `--stop` - Detaches the debug tools.
2825
* `--get-port` - Retrieves the port on which you are debugging your application.

docs/man_pages/project/testing/debug-ios.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
debug ios
22
==========
3-
All you need to do to start debugging your app is to execute `tns debug ios`. The NativeScript CLI will build, deploy, start your app, start Safari Web Inspector and attach the debugger.
4-
* You cannot debug if there are multiple devices available (emulators and/or real devices). You need to have started only one device or emulator.
53

64
Usage | Synopsis
75
---|---
8-
Deploy on device, run the app and attach the debugger | `$ tns debug ios`
9-
Deploy on device, run the app and stop at the first breakpoint | `$ tns debug ios --debug-brk [--device <Device ID>] [--no-client]`
10-
Deploy in the iOS Simulator, run the app and stop at the first breakpoint | `$ tns debug ios --debug-brk --emulator [<Emulator Options>] [--no-client]`
6+
Deploy on device, run the app, start Safari Web Inspector and attach the debugger | `$ tns debug ios`
7+
Deploy on device, run the app and stop at the first code statement | `$ tns debug ios --debug-brk [--device <Device ID>] [--no-client]`
8+
Deploy in the iOS Simulator, run the app and stop at the first code statement | `$ tns debug ios --debug-brk --emulator [<Emulator Options>] [--no-client]`
119
Attach the debug tools to a running app on device | `$ tns debug ios --start [--device <Device ID>] [--no-client]`
1210
Attach the debug tools to a running app in the iOS Simulator | `$ tns debug ios --start --emulator [<Emulator Options>] [--no-client]`
1311

@@ -19,7 +17,7 @@ Debugs your project on a connected device or in the iOS Simulator. <% if(isHtml)
1917
<% if(isHtml) { %>> <% } %>IMPORTANT: Before building for iOS device, verify that you have configured a valid pair of certificate and provisioning profile on your OS X system. <% if(isHtml) { %>For more information, see [Obtaining Signing Identities and Downloading Provisioning Profiles](https://developer.apple.com/library/mac/recipes/xcode_help-accounts_preferences/articles/obtain_certificates_and_provisioning_profiles.html).<% } %>
2018

2119
### Options
22-
* `--debug-brk` - Prepares, builds and deploys the application package on a device or in an emulator, runs the app, launches the developer tools of your Safari browser and stops at the first breakpoint.
20+
* `--debug-brk` - Prepares, builds and deploys the application package on a device or in an emulator, runs the app, launches the developer tools of your Safari browser and stops at the first code statement.
2321
* `--start` - Attaches the debug tools to a deployed and running app and launches the developer tools of your Safari browser.
2422
* `--emulator` - Indicates that you want to debug your app in the iOS simulator.
2523
* `--no-client` - If set, the NativeScript CLI attaches the debug tools but does not launch the developer tools in Safari.

0 commit comments

Comments
 (0)