Commit e591409f authored by Hadi Moshayedi's avatar Hadi Moshayedi Committed by Konrad Sztyber
Browse files

lvol: fix parameter name of bdev_lvol_set_parent[_bdev]. 



In `vbdev_lvol_rpc.c` we use `parent_name` for parent name parameter of
bdev_lvol_set_parent and bdev_lvol_set_parent_bdev. Docs missed this.

As a follow up, this patch also changes the corresponding names in
lvol.py and rpc.py to match the names in the json-rpc protocol.

Change-Id: I9837f579c550a0f3d61e41a3dda265b7fe9623cc
Signed-off-by: default avatarHadi Moshayedi <hadi@ubicloud.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24598


Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Reviewed-by: default avatarDamiano Cipriani <damiano.cipriani@suse.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <smatsumoto@nvidia.com>
parent c6c1234d

doc/jsonrpc.md

+4 −4
Original line number Diff line number Diff line
@@ -10815,7 +10815,7 @@ Lvol and parent snapshot must have the same size and must belong to the same lvo 
Name                    | Optional | Type        | Description

----------------------- | -------- | ----------- | -----------

lvol_name               | Required | string      | UUID or alias of the lvol to set parent of

snapshot_name           | Required | string      | UUID or alias of the snapshot to become parent of lvol

parent_name             | Required | string      | UUID or alias of the snapshot to become parent of lvol



#### Example
@@ -10828,7 +10828,7 @@ Example request: 
  "id": 1,

  "params": {

    "lvol_name": "LVS1/LVOL0",

    "snapshot_name": "LVS1/SNAP0"

    "parent_name": "LVS1/SNAP0"

  }

}

~~~
@@ -10856,7 +10856,7 @@ The size of the external snapshot device must be an integer multiple of cluster 
Name                    | Optional | Type        | Description

----------------------- | -------- | ----------- | -----------

lvol_name               | Required | string      | UUID or alias of the lvol to set external parent of

esnap_name              | Required | string      | UUID or name of the external snapshot to become parent of lvol

parent_name             | Required | string      | UUID or name of the external snapshot to become parent of lvol



#### Example
@@ -10869,7 +10869,7 @@ Example request: 
  "id": 1,

  "params": {

    "lvol_name": "LVS1/LVOL0",

    "esnap_name": "e465527b-f412-4f70-a03e-c4a5d608f65e"

    "parent_name": "e465527b-f412-4f70-a03e-c4a5d608f65e"

  }

}

~~~

python/spdk/rpc/lvol.py

+6 −6
Original line number Diff line number Diff line
@@ -250,30 +250,30 @@ def bdev_lvol_check_shallow_copy(client, operation_id): 
    return client.call('bdev_lvol_check_shallow_copy', params)





def bdev_lvol_set_parent(client, lvol_name, snapshot_name):

def bdev_lvol_set_parent(client, lvol_name, parent_name):

    """Set the parent snapshot of a lvol



    Args:

        lvol_name: name of the lvol to set parent of

        snapshot_name: name of the snapshot to become parent of lvol

        parent_name: name of the snapshot to become parent of lvol

    """

    params = {

        'lvol_name': lvol_name,

        'parent_name': snapshot_name

        'parent_name': parent_name

    }

    return client.call('bdev_lvol_set_parent', params)





def bdev_lvol_set_parent_bdev(client, lvol_name, esnap_name):

def bdev_lvol_set_parent_bdev(client, lvol_name, parent_name):

    """Set the parent external snapshot of a lvol



    Args:

        lvol_name: name of the lvol to set parent of

        esnap_name: name of the external snapshot to become parent of lvol

        parent_name: name of the external snapshot to become parent of lvol

    """

    params = {

        'lvol_name': lvol_name,

        'parent_name': esnap_name

        'parent_name': parent_name

    }

    return client.call('bdev_lvol_set_parent_bdev', params)

scripts/rpc.py

+4 −4
Original line number Diff line number Diff line
@@ -2184,21 +2184,21 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse 
    def bdev_lvol_set_parent(args):

        rpc.lvol.bdev_lvol_set_parent(args.client,

                                      lvol_name=args.lvol_name,

                                      snapshot_name=args.snapshot_name)

                                      parent_name=args.parent_name)



    p = subparsers.add_parser('bdev_lvol_set_parent', help='Set the parent snapshot of a lvol')

    p.add_argument('lvol_name', help='lvol name')

    p.add_argument('snapshot_name', help='snapshot name')

    p.add_argument('parent_name', help='parent snapshot name')

    p.set_defaults(func=bdev_lvol_set_parent)



    def bdev_lvol_set_parent_bdev(args):

        rpc.lvol.bdev_lvol_set_parent_bdev(args.client,

                                           lvol_name=args.lvol_name,

                                           esnap_name=args.esnap_name)

                                           parent_name=args.parent_name)



    p = subparsers.add_parser('bdev_lvol_set_parent_bdev', help='Set the parent external snapshot of a lvol')

    p.add_argument('lvol_name', help='lvol name')

    p.add_argument('esnap_name', help='external snapshot name')

    p.add_argument('parent_name', help='parent external snapshot name')

    p.set_defaults(func=bdev_lvol_set_parent_bdev)



    def bdev_lvol_delete_lvstore(args):