Commit b4ca4a1d authored by Pawel Wodkowski's avatar Pawel Wodkowski Committed by Ben Walker
Browse files

jsonrpc.md: add new line before fenced code 



This is not strictly required for GFM compatibility but many editors not
correctly implement it and display blobs instead of fenced code. Other
parts of this file already using this scheme.

Change-Id: I8f16a3d89a2c978d8d0ee3e59d3a3d9f8675c0a5
Signed-off-by: default avatarPawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/445281


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarKarol Latecki <karol.latecki@intel.com>
Reviewed-by: default avatarDarek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 2e6dbe75

doc/jsonrpc.md

+66 −0
Original line number Diff line number Diff line
@@ -69,6 +69,7 @@ sig_name | Required | string | Signal to send (SIGINT, SIGTE 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -81,6 +82,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -108,6 +110,7 @@ enabled | boolean | The current state of context switch moni 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -120,6 +123,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -147,6 +151,7 @@ Completion status of SPDK subsystem initialization is returned as a boolean. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -156,6 +161,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -180,6 +186,7 @@ Returns True when subsystems have been initialized. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -189,6 +196,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -214,6 +222,7 @@ The response is an array of supported RPC methods. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -223,6 +232,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -321,6 +331,7 @@ The response is an array of name and dependency relationship of SPDK subsystems 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -330,6 +341,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -407,6 +419,7 @@ Null is returned if it is not retrievable by the get_subsystem_config method and 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -419,6 +432,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -487,6 +501,7 @@ bdev_io_cache_size | Optional | number | Maximum number of spdk_bdev_i 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -500,6 +515,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -528,6 +544,7 @@ The response is an array of objects containing information about the requested b 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -540,6 +557,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -587,6 +605,7 @@ The response is an array of objects containing I/O statistics of the requested b 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -599,6 +618,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -641,6 +661,7 @@ enable | Required | boolean | Enable or disable histogram o 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -654,6 +675,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -683,6 +705,7 @@ tsc_rate | Ticks per second 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -726,6 +749,7 @@ w_mbytes_per_sec | Optional | number | Number of Write megabytes per 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -742,6 +766,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -1476,6 +1501,7 @@ The response is an array of objects containing information about the requested N 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -1488,6 +1514,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -2526,6 +2553,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -3460,6 +3488,7 @@ buf_cache_size | Optional | number | The number of shared buffers 
### Example:



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -3473,6 +3502,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -3490,6 +3520,7 @@ This method has no parameters. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -3499,6 +3530,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -3874,6 +3906,7 @@ max_subsystems | Required | number | Maximum number of NVMe-oF sub 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -3886,6 +3919,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -3908,6 +3942,7 @@ acceptor_poll_rate | Optional | number | Polling interval of the accep 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -3920,6 +3955,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -3937,6 +3973,7 @@ This method has no parameters. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -3946,6 +3983,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4479,6 +4517,7 @@ UUID of the created logical volume store is returned. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4493,6 +4532,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4517,6 +4557,7 @@ Either uuid or lvs_name must be specified, but not both. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4529,6 +4570,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4554,6 +4596,7 @@ If both uuid and lvs_name are omitted, information about all logical volume stor 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4566,6 +4609,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4598,6 +4642,7 @@ new_name | Required | string | New logical volume store name 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4611,6 +4656,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4644,6 +4690,7 @@ UUID of the created logical volume is returned. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4660,6 +4707,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4686,6 +4734,7 @@ UUID of the created logical volume snapshot is returned. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4699,6 +4748,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4725,6 +4775,7 @@ UUID of the created logical volume clone is returned. 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0"
@@ -4738,6 +4789,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4760,6 +4812,7 @@ new_name | Required | string | New logical volume name 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4773,6 +4826,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4795,6 +4849,7 @@ size | Required | number | Desired size of the logical v 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4808,6 +4863,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4829,6 +4885,7 @@ name | Required | string | UUID or alias of the logical 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4841,6 +4898,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4862,6 +4920,7 @@ name | Required | string | UUID or alias of the logical 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4874,6 +4933,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4895,6 +4955,7 @@ name | Required | string | UUID or alias of the logical 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4907,6 +4968,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4928,6 +4990,7 @@ name | Required | string | UUID or alias of the logical 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4940,6 +5003,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",
@@ -4979,6 +5043,7 @@ metadata | string | Metadata transferred from controller to 
### Example



Example request:



~~~

{

  "jsonrpc": "2.0",
@@ -4995,6 +5060,7 @@ Example request: 
~~~



Example response:



~~~

{

  "jsonrpc": "2.0",