@@ -1195,20 +1195,29 @@ see below.
11951195For now, the TFTP/NFS/HTTP server needs to be configured before using it from
11961196labgrid.
11971197
1198- .. _TFTPProvider :
1199- .. _HTTPProvider :
1200-
1201- TFTPProvider / HTTPProvider
1202- +++++++++++++++++++++++++++
1203- A :any: `TFTPProvider ` resource describes TFTP server.
1204- A :any: `HTTPProvider ` resource describes an HTTP server.
1198+ TFTPProvider
1199+ ++++++++++++
1200+ A :any: `TFTPProvider ` resource describes a TFTP server.
12051201
12061202.. code-block :: yaml
12071203
12081204 TFTPProvider :
12091205 internal : ' /srv/tftp/board-23/'
12101206 external : ' board-23/'
12111207
1208+ Arguments:
1209+ - internal (str): path prefix to the local directory accessible by the target
1210+ - external (str): corresponding path prefix for use by the target
1211+
1212+ Used by:
1213+ - `TFTPProviderDriver `_
1214+
1215+ HTTPProvider
1216+ ++++++++++++
1217+ An :any: `HTTPProvider ` resource describes an HTTP server.
1218+
1219+ .. code-block :: yaml
1220+
12121221 HTTPProvider :
12131222 internal : ' /srv/www/board-23/'
12141223 external : ' http://192.168.1.1/board-23/'
@@ -1218,7 +1227,6 @@ Arguments:
12181227 - external (str): corresponding path prefix for use by the target
12191228
12201229Used by:
1221- - `TFTPProviderDriver `_
12221230 - `HTTPProviderDriver `_
12231231
12241232NFSProvider
@@ -1235,15 +1243,10 @@ Arguments:
12351243Used by:
12361244 - `NFSProviderDriver `_
12371245
1238- .. _RemoteTFTPProvider :
1239- .. _RemoteHTTPProvider :
1240-
1241- RemoteTFTPProvider / RemoteHTTPProvider
1242- +++++++++++++++++++++++++++++++++++++++
1246+ RemoteTFTPProvider
1247+ ++++++++++++++++++
12431248A :any: `RemoteTFTPProvider ` describes a `TFTPProvider `_ resource available on
12441249a remote computer.
1245- A :any: `RemoteHTTPProvider ` describes a `HTTPProvider `_ resource available on
1246- a remote computer.
12471250
12481251.. code-block :: yaml
12491252
@@ -1252,18 +1255,32 @@ a remote computer.
12521255 internal : ' /srv/tftp/board-23/'
12531256 external : ' board-23/'
12541257
1258+ Arguments:
1259+ - host (str): hostname of the remote host
1260+ - internal (str): path prefix to the TFTP root directory on ``host ``
1261+ - external (str): corresponding path prefix for use by the target
1262+
1263+ Used by:
1264+ - `TFTPProviderDriver `_
1265+
1266+ RemoteHTTPProvider
1267+ ++++++++++++++++++
1268+ A :any: `RemoteHTTPProvider ` describes an `HTTPProvider `_ resource available on
1269+ a remote computer.
1270+
1271+ .. code-block :: yaml
1272+
12551273 RemoteHTTPProvider :
12561274 host : ' httphost'
12571275 internal : ' /srv/www/board-23/'
12581276 external : ' http://192.168.1.1/board-23/'
12591277
12601278 Arguments:
12611279 - host (str): hostname of the remote host
1262- - internal (str): path prefix to the HTTP/TFTP root directory on ``host ``
1280+ - internal (str): path prefix to the HTTP root directory on ``host ``
12631281 - external (str): corresponding path prefix for use by the target
12641282
12651283Used by:
1266- - `TFTPProviderDriver `_
12671284 - `HTTPProviderDriver `_
12681285
12691286RemoteNFSProvider
@@ -2496,20 +2513,15 @@ Implements:
24962513 Arguments:
24972514 - None
24982515
2499- .. _TFTPProviderDriver :
2500- .. _HTTPProviderDriver :
2501-
2502- TFTPProviderDriver / HTTPProviderDriver
2503- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2504- The :any: `TFTPProviderDriver ` and :any: `HTTPProviderDriver ` control their
2505- corresponding Provider resources, either locally or remotely.
2516+ TFTPProviderDriver
2517+ ~~~~~~~~~~~~~~~~~~
2518+ The :any: `TFTPProviderDriver ` controls its corresponding TFTP resource, either
2519+ locally or remotely.
25062520
25072521Binds to:
25082522 provider:
25092523 - `TFTPProvider `_
25102524 - `RemoteTFTPProvider `_
2511- - `HTTPProvider `_
2512- - `RemoteHTTPProvider `_
25132525
25142526Implements:
25152527 - None (yet)
@@ -2518,6 +2530,27 @@ Implements:
25182530
25192531 TFTPProviderDriver : {}
25202532
2533+ Arguments:
2534+ - None
2535+
2536+ The driver can be used in test cases by calling its ``stage() `` method, which
2537+ returns the path to be used by the target.
2538+
2539+ HTTPProviderDriver
2540+ ~~~~~~~~~~~~~~~~~~
2541+ The :any: `HTTPProviderDriver ` controls its corresponding HTTP resource, either
2542+ locally or remotely.
2543+
2544+ Binds to:
2545+ provider:
2546+ - `HTTPProvider `_
2547+ - `RemoteHTTPProvider `_
2548+
2549+ Implements:
2550+ - None (yet)
2551+
2552+ .. code-block :: yaml
2553+
25212554 HTTPProviderDriver : {}
25222555
25232556 Arguments:
0 commit comments