Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Prev Previous commit
Next Next commit
Some improvements to documentation
  • Loading branch information
pesse committed Jun 8, 2018
commit 808a2d6dd5e4d0004085e18af9bc7f034f177428
46 changes: 16 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,28 @@ export LC_ALL=en_US.utf-8
The charset-part of LC_ALL is ignored.

## Usage
Currently, utPLSQL-cli knows the following commands:
Currently, utPLSQL-cli supports the following commands:
- run
- info
- reporters

#### \<ConnectionURL>

This is used in all commands as first parameter (though it's optional for `info`).

Accepted formats:

- `<user>/<password>@//<host>[:<port>]/<service>`
- `<user>/<password>@<host>:<port>:<SID>`
- `<user>/<password>@<TNSName>`

To connect using TNS, you need to have the ORACLE_HOME environment variable set.
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
The file tnsnames.ora must contain valid TNS entries.

### run
`utplsql run <ConnectionURL> [<options>]`

```
<ConnectionURL> - accepted formats:
<user>/<password>@//<host>[:<port>]/<service>
<user>/<password>@<host>:<port>:<SID>
<user>/<password>@<TNSName>
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
The file tnsnames.ora must contain valid TNS entries.
```

#### Options
```
Expand Down Expand Up @@ -133,15 +138,6 @@ Invokes all unit test suites from schema "hr". Results are displayed to screen u
### info
`utplsql info [<ConnectionURL>]`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Maybe make a separate section for the connection URL and link to it in each command. That way it is defined only once.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yes, came to my mind but wasn't able to come up with a good way and therefore decided to refactor later ;)


```
<ConnectionURL> - accepted formats:
<user>/<password>@//<host>[:<port>]/<service>
<user>/<password>@<host>:<port>:<SID>
<user>/<password>@<TNSName>
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
The file tnsnames.ora must contain valid TNS entries.
```

#### Examples

Expand All @@ -160,17 +156,7 @@ utPLSQL 3.1.2.1913
```

### reporters
`utplsql info <ConnectionURL>`

```
<ConnectionURL> - accepted formats:
<user>/<password>@//<host>[:<port>]/<service>
<user>/<password>@<host>:<port>:<SID>
<user>/<password>@<TNSName>
To connect using TNS, you need to have the ORACLE_HOME environment variable set.
The file tnsnames.ora must exist in path %ORACLE_HOME%/network/admin
The file tnsnames.ora must contain valid TNS entries.
```
`utplsql reporters <ConnectionURL>`

#### Examples
```
Expand Down