Skip to content

Fix help for livesync command and debug command #745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 5, 2015
Merged

Fix help for livesync command and debug command #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/man_pages/project/testing/debug-android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Debugs your project on a connected device, in a native emulator or in Genymotion
* `--stop` - Detaches the debug tools.
* `--get-port` - Retrieves the port on which you are debugging your application.
* `--debug-port` - Sets a new port on which to attach the debug tools.
* `--timeout` - Sets the number of seconds that NativeScript CLI will wait for the debugger to boot. If not set, the default timeout is 60 seconds.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the NativeScript CLI

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add this option to the synopsis above


### Attributes
* `<Device ID>` is the index or name of the target device as listed by `$ tns device`
Expand Down
5 changes: 3 additions & 2 deletions docs/man_pages/project/testing/livesync-ios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ livesync ios

Usage | Synopsis
------|-------
General | `$ tns livesync ios [--device <Device ID>] [--watch]`
General | `$ tns livesync ios [--device <Device ID>] [--watch] [--emulator]`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you have --device and --emulator simultaneously? If not, split this into a few rows:

Synchronize changes to all connected devices | `$ tns livesync ios [--watch]`
Synchronize changes to a selected device | `$ tns livesync ios --device <Device ID> [--watch]`
Synchronize changes to the iOS Simulator | `$ tns livesync ios --emulator [--watch]`

Also, add line notes to --device and --emulator that they cannot be used simultaneously. => You cannot set --device and --emulator simultaneously.

Also, add a Command Limitations section at the bottom, stating this limitation.

<% if(isHtml) { %> 
### Command Limitations

* You cannot set `--device` and `--emulator` simultaneously.

 ### Related Commands

<% } %>


Synchronizes the latest changes in your project to iOS devices.
Synchronizes the latest changes in your project to iOS devices or iOS simulator.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or the iOS Simulator.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run a check for this description (it should be appearing in the index.md and the Related Commands across the testing section). Update it in all instances to match the description here.


### Options
* `--watch` - If set, when you save changes to the project, changes are automatically synchronized to the connected device.
* `--device` - Specifies the serial number or the index of the connected device to which you want to synchronize changes. To list all connected devices, grouped by platform, run `$ tns device`
* `--emulator` - If set, changes are synchronized to iOS simulator.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If set, synchronizes changes to the iOS Simulator.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the simulator be running? If yes, state this here and in the description of the command.


### Attributes
* `<Device ID>` is the device index or identifier as listed by `$ tns device`
Expand Down