Skip to content

Commit

Permalink
minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
karimra committed Apr 13, 2023
1 parent 8ba38a2 commit c8ef993
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/basic_usage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The following examples demonstrate the basic usage of the `gnmic` in a scenario where the remote target runs insecure (not TLS enabled) gNMI server. The `admin:admin` credentials are used to connect to the gNMI server running at `10.1.0.11:57400` address.
The following examples demonstrate the basic usage of `gnmic` in a scenario where the remote target runs an unsecured (without TLS enabled) gNMI server. The `admin:admin` credentials are used to connect to the gNMI server running at `10.1.0.11:57400` address.

!!!info
For the complete command usage examples, refer to the ["Command reference"](cmd/capabilities.md) menu.
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/capabilities.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Description

The `[cap | capabilities]` command represents the [gNMI Capabilities RPC](https://github.com/openconfig/gnmi/blob/master/proto/gnmi/gnmi.proto#L51).

It is used to send a [Capability Request](https://github.com/openconfig/gnmi/blob/master/proto/gnmi/gnmi.proto#L431) to the specified target(s) and expects one [Capability Response](https://github.com/openconfig/gnmi/blob/master/proto/gnmi/gnmi.proto#L440) per target.
Expand Down
2 changes: 2 additions & 0 deletions docs/user_guide/configuration_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ See [here](configuration_flags.md) for a complete list of the supported global a
The Env variable names are inline with the flag names as well as the configuration hierarchy.

See [here](configuration_env.md) for more details on environment variables.

## File configuration

Configuration file that `gnmic` reads must be in one of the following formats: JSON, YAML, TOML, HCL or Properties.

By default, `gnmic` will search for a file named `.gnmic.[yml/yaml, toml, json]` in the following locations and will use the first file that exists:
Expand Down

0 comments on commit c8ef993

Please sign in to comment.