Skip to content

Commit

Permalink
gRPC documentation - minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jacbar01-arm committed Nov 20, 2024
1 parent 6dfdb3c commit a497284
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions man/labgrid-client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ OPTIONS
relative path to the SSL certificate file, defaults to ``certificates/server.crt``
-ap AUTH_PLUGIN_NAME, --auth-plugin AUTH_PLUGIN_NAME
name of the entry point used to return an instance of the custom authentication plugin;
by default, the 'DefaultAuthMetadataPlugin' is used
by default, the ``DefaultAuthMetadataPlugin`` is used

-A / --auth
~~~~~~~~~~~~
Expand All @@ -76,8 +76,8 @@ The value related to this option is considered only when the gRPC connection aut
~~~~~~~~~~~~~~~~~~~
The name of the entry point used to return an instance of the custom authentication plugin;
this plugin is delivered as an independent Python package (not part of the labgrid code base);
the authentication plugin is a class derived from the grpc.AuthMetadataPlugin class;
by default, the 'DefaultAuthMetadataPlugin' is used, this default plugin is a part of the labgrid;
the authentication plugin is a class derived from the ``grpc.AuthMetadataPlugin`` class;
by default, the ``DefaultAuthMetadataPlugin`` is used, this default plugin is a part of the labgrid;
this parameter is only considered when the gRPC authorization/authentication is enabled


Expand Down
4 changes: 2 additions & 2 deletions man/labgrid-coordinator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ The value related to this option is considered only when the gRPC connection aut
~~~~~~~~~~~~~~~~~~~~~~~~~~
The name of the entry point used to return an instance of the custom server interceptor plugin.
This plugin is delivered as an independent Python package (not part of the labgrid code base).
The server interceptor plugin is a class derived from the grpc.ServerInterceptor class.
By default, the 'DefaultServerInterceptor' is used, this default plugin is a part of the labgrid.
The server interceptor plugin is a class derived from the ``grpc.aio.ServerInterceptor`` class.
By default, the ``DefaultServerInterceptor`` is used, this default plugin is a part of the labgrid.
This parameter is only considered when the gRPC authentication is enabled.


Expand Down
4 changes: 2 additions & 2 deletions man/labgrid-exporter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ The value related to this option is considered only when the gRPC connection aut
~~~~~~~~~~~~~~~~~~~
The name of the entry point used to return an instance of the custom authentication plugin;
this plugin is delivered as an independent Python package (not part of the labgrid code base);
the authentication plugin is a class derived from the grpc.AuthMetadataPlugin class;
by default, the 'DefaultAuthMetadataPlugin' is used, this default plugin is a part of the labgrid;
the authentication plugin is a class derived from the ``grpc.AuthMetadataPlugin`` class;
by default, the ``DefaultAuthMetadataPlugin`` is used, this default plugin is a part of the labgrid;
this parameter is only considered when the gRPC authorization/authentication is enabled


Expand Down

0 comments on commit a497284

Please sign in to comment.