Skip to content

Commit 4b2e65b

Browse files
committed
Update README
1 parent 99957a8 commit 4b2e65b

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,11 @@ catch (err)
6060
}
6161
```
6262

63-
## Important note: to understand how to construct standard Perforce commands using this library's syntax, look at the option translations listed in p4options.js file. Below, I have taken those options and demonstrated the appropriate syntax to use in this library to add them as parameters to your Perforce commands.
63+
## Important note on how to use Perforce command options
6464

65-
Unary options (no value needed) should simply have a value of true when you pass them.
66-
Other options show the value type that is expected, e.g. changelists are expected to be provided as Numbers, not Strings.
65+
To understand how to construct standard Perforce commands using this library's syntax, look at the option translations listed in the p4options.js file. Below is a list of those Perforce options followed by the options object format needed to use them in this library as parameters for your Perforce commands.
66+
67+
Unary options (no value needed) should simply have a value of true when you pass them. Other options show the value type that is expected, e.g. changelists are expected to be provided as Numbers, not Strings.
6768

6869
```
6970
-am: {acceptmerged: true}
@@ -89,12 +90,14 @@ Other options show the value type that is expected, e.g. changelists are expecte
8990

9091
## Debugging:
9192

92-
A debug option has been added to make it easier to see what commands are being run. To use it, simply call p4.setDebugMode(true) after requiring the library. You will see debug info logged to console in this format:
93+
A debug option has been added to make it easier to see what commands are being run. Its output looks like this:
9394

9495
```
9596
[P4 DEBUG] p4.exe edit -c 109 -t text //depot/MyFileName.json
9697
```
9798

99+
To use it, simply call `p4.setDebugMode(true)` after requiring the library. You will see debug info logged to console in this format:
100+
98101
```js
99102
var p4 = require('reckless-node-perforce');
100103

0 commit comments

Comments
 (0)