From 1ff3715d3804d304de24d5235b9b034f3681a1d1 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Wed, 24 Nov 2021 20:40:59 -0500 Subject: [PATCH] spelling: scripts Part of #2256 * available * classes * coalesce * configuration * controller * currently * dependencies * different * displaying * does not * environment * explicitly * hugepages * ignoring * inflight * initialize * parameters * priority * properties * recovery * subsystem * subsystems * template * the same * underlying * usable * values Change-Id: Ibc8567af288c9f4641563835e16bf88949ba6a71 Signed-off-by: Josh Soref Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10408 Community-CI: Broadcom CI Reviewed-by: Tomasz Zawadzki Reviewed-by: Jim Harris Tested-by: SPDK CI Jenkins --- scripts/bash-completion/spdk | 2 +- scripts/bpf/trace.py | 6 +++--- scripts/ceph/ceph.conf | 2 +- scripts/check_format.sh | 2 +- scripts/perf/nvmf/run_nvmf.py | 10 +++++----- scripts/perf/vhost/run_vhost_test.py | 2 +- scripts/pkgdep/debian.sh | 2 +- scripts/rpc.py | 8 ++++---- scripts/rpc/app.py | 2 +- scripts/rpc/bdev.py | 6 +++--- scripts/rpc/iscsi.py | 2 +- scripts/setup.sh | 2 +- scripts/spdkcli/ui_node.py | 2 +- scripts/spdkcli/ui_node_nvmf.py | 4 ++-- scripts/spdkcli/ui_root.py | 2 +- scripts/vagrant/README.md | 2 +- scripts/vagrant/Vagrantfile | 2 +- scripts/vagrant/create_vbox.sh | 2 +- 18 files changed, 30 insertions(+), 30 deletions(-) diff --git a/scripts/bash-completion/spdk b/scripts/bash-completion/spdk index a7cf5bc39..f7c918605 100644 --- a/scripts/bash-completion/spdk +++ b/scripts/bash-completion/spdk @@ -14,7 +14,7 @@ _get_help_pos() { # Fetch all the positional parameters, i.e. get first word prefixed # with 20h x 2. This may not be 100% accurate. Also, it won't return - # any usuable strings, it's just meant to point out what type of + # any usable strings, it's just meant to point out what type of # mandatory argument given method depends on, like bdev_name, etc. # TODO: separate completion for such arguments, e.g., get all bdevs # for parameter like bdev_name? diff --git a/scripts/bpf/trace.py b/scripts/bpf/trace.py index 9f0bd2faa..bf897a825 100755 --- a/scripts/bpf/trace.py +++ b/scripts/bpf/trace.py @@ -475,7 +475,7 @@ class SPDKObject: """Describes a specific type of an SPDK objects (e.g. qpair, thread, etc.)""" @dataclass class Lifetime: - """Describes a lifetime and properites of a particular SPDK object.""" + """Describes a lifetime and properties of a particular SPDK object.""" begin: int end: int ptr: int @@ -486,7 +486,7 @@ class SPDKObject: for name in tpoints: tpoint = next((t for t in trace.tpoints.values() if t.name == name), None) if tpoint is None: - # Some tpoints might be undefined if configured without specific subystems + # Some tpoints might be undefined if configured without specific subsystems continue self.tpoints[tpoint.id] = tpoint @@ -496,7 +496,7 @@ class SPDKObject: def annotate(self, entry: TraceEntry): """Annotates a tpoint entry and returns a dict indexed by argname with values representing - various object properites. For instance, {"qpair": {"qid": 1, "subnqn": "nqn"}} could be + various object properties. For instance, {"qpair": {"qid": 1, "subnqn": "nqn"}} could be returned to annotate an argument called "qpair" with two items: "qid" and "subnqn". """ if entry.tpoint.id not in self.tpoints: diff --git a/scripts/ceph/ceph.conf b/scripts/ceph/ceph.conf index 9cf918e5d..bd457a55f 100644 --- a/scripts/ceph/ceph.conf +++ b/scripts/ceph/ceph.conf @@ -47,7 +47,7 @@ journal_max_write_bytes=1048576000 journal_queue_max_bytes=1048576000 ms_dispatch_throttle_bytes=1048576000 - objecter_infilght_op_bytes=1048576000 + objecter_inflight_op_bytes=1048576000 filestore_max_sync_interval=10 osd_client_message_size_cap = 0 osd_client_message_cap = 0 diff --git a/scripts/check_format.sh b/scripts/check_format.sh index 40c34dd5d..2c31df58c 100755 --- a/scripts/check_format.sh +++ b/scripts/check_format.sh @@ -70,7 +70,7 @@ function check_permissions() { rc=1 fi else - # If the file doesnot have execute permissions, it should not start with a shebang. + # If the file does not have execute permissions, it should not start with a shebang. if [ "$shebang" = "#!/" ]; then echo "ERROR: $path is not marked executable but starts with a shebang." rc=1 diff --git a/scripts/perf/nvmf/run_nvmf.py b/scripts/perf/nvmf/run_nvmf.py index 8cc5296d0..812949afb 100755 --- a/scripts/perf/nvmf/run_nvmf.py +++ b/scripts/perf/nvmf/run_nvmf.py @@ -119,7 +119,7 @@ class Server: self.log_print("%s resulted in error: %s" % (e.cmd, e.output)) def adq_configure_tc(self): - self.log_print("Configuring ADQ Traffic classess and filters...") + self.log_print("Configuring ADQ Traffic classes and filters...") if self.mode == "kernel": self.log_print("WARNING: ADQ setup not yet supported for Kernel mode. Skipping configuration.") @@ -160,7 +160,7 @@ class Server: self.log_print("%s" % tc_disk_out) self.log_print("%s" % tc_filter_out) - # Ethtool coalese settings must be applied after configuring traffic classes + # Ethtool coalesce settings must be applied after configuring traffic classes self.exec_cmd(["sudo", "ethtool", "--coalesce", nic_name, "adaptive-rx", "off", "rx-usecs", "0"]) self.exec_cmd(["sudo", "ethtool", "--coalesce", nic_name, "adaptive-tx", "off", "tx-usecs", "500"]) @@ -256,7 +256,7 @@ class Server: def configure_tuned(self): if not self.tuned_profile: - self.log_print("WARNING: Tuned profile not set in configration file. Skipping configuration.") + self.log_print("WARNING: Tuned profile not set in configuration file. Skipping configuration.") return self.log_print("Configuring tuned-adm profile to %s." % self.tuned_profile) @@ -517,7 +517,7 @@ class Target(Server): rw_mixread = float(re.search(r"m_(\d+)", job_name).group(1)) / 100 # If "_CPU" exists in name - ignore it - # Initiators for the same job could have diffrent num_cores parameter + # Initiators for the same job could have different num_cores parameter job_name = re.sub(r"_\d+CPU", "", job_name) job_result_files = [x for x in json_files if x.startswith(job_name)] self.log_print("Matching result files for current fio config:") @@ -1193,7 +1193,7 @@ class SPDKTarget(Target): fh.write(str(proc.pid)) self.nvmf_proc = proc self.log_print("SPDK NVMeOF Target PID=%s" % self.pid) - self.log_print("Waiting for spdk to initilize...") + self.log_print("Waiting for spdk to initialize...") while True: if os.path.exists("/var/tmp/spdk.sock"): break diff --git a/scripts/perf/vhost/run_vhost_test.py b/scripts/perf/vhost/run_vhost_test.py index 56933325f..7d2cf1421 100644 --- a/scripts/perf/vhost/run_vhost_test.py +++ b/scripts/perf/vhost/run_vhost_test.py @@ -111,7 +111,7 @@ def gen_qemu_cpu_mask_config(spdk_cpu_list, vm_count, vm_cpu_num): def create_fio_cfg(template_dir, output_dir, **kwargs): - fio_tempalte = os.path.join(template_dir, "fio_test.conf") + fio_template = os.path.join(template_dir, "fio_test.conf") with open("scripts/perf/vhost/fio_test.conf", "r") as fh: cfg = fh.read() cfg = cfg.format(**kwargs) diff --git a/scripts/pkgdep/debian.sh b/scripts/pkgdep/debian.sh index a418c254c..7c7ba8ccf 100755 --- a/scripts/pkgdep/debian.sh +++ b/scripts/pkgdep/debian.sh @@ -37,7 +37,7 @@ if [[ $INSTALL_DEV_TOOLS == "true" ]]; then abigail-tools bash-completion ruby-dev # Additional python style checker not available on ubuntu 16.04 or earlier. apt-get install -y pycodestyle || true - # Additional dependecies for nvmf performance test script + # Additional dependencies for nvmf performance test script apt-get install -y python3-paramiko fi if [[ $INSTALL_PMEM == "true" ]]; then diff --git a/scripts/rpc.py b/scripts/rpc.py index fb24607f7..1d0447c89 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -297,7 +297,7 @@ if __name__ == "__main__": default=0, ) p.add_argument('cache_bdev_name', help='Name of underlying cache bdev') - p.add_argument('core_bdev_name', help='Name of unerlying core bdev') + p.add_argument('core_bdev_name', help='Name of underlying core bdev') p.set_defaults(func=bdev_ocf_create) def bdev_ocf_delete(args): @@ -476,7 +476,7 @@ if __name__ == "__main__": p = subparsers.add_parser('bdev_nvme_set_options', aliases=['set_bdev_nvme_options'], help='Set options for the bdev nvme type. This is startup command.') p.add_argument('-a', '--action-on-timeout', - help="Action to take on command time out. Valid valies are: none, reset, abort") + help="Action to take on command time out. Valid values are: none, reset, abort") p.add_argument('-t', '--timeout-us', help="Timeout for each command, in microseconds. If 0, don't track timeouts.", type=int) p.add_argument('--timeout-admin-us', @@ -2289,7 +2289,7 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p = subparsers.add_parser('vhost_scsi_controller_add_target', aliases=['add_vhost_scsi_lun'], help='Add lun to vhost controller') - p.add_argument('ctrlr', help='conntroller name where add lun') + p.add_argument('ctrlr', help='controller name where add lun') p.add_argument('scsi_target_num', help='scsi_target_num', type=int) p.add_argument('bdev_name', help='bdev name') p.set_defaults(func=vhost_scsi_controller_add_target) @@ -2323,7 +2323,7 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p.add_argument('--cpumask', help='cpu mask for this controller') p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') p.add_argument("-p", "--packed_ring", action='store_true', help='Set controller as packed ring supported') - p.add_argument("-l", "--packed_ring_recovery", action='store_true', help='Enable packed ring live reocvery') + p.add_argument("-l", "--packed_ring_recovery", action='store_true', help='Enable packed ring live recovery') p.set_defaults(func=vhost_create_blk_controller) def vhost_get_controllers(args): diff --git a/scripts/rpc/app.py b/scripts/rpc/app.py index 5aa0d7865..9ad5cdc2f 100644 --- a/scripts/rpc/app.py +++ b/scripts/rpc/app.py @@ -56,7 +56,7 @@ def framework_get_scheduler(client): """Query currently set scheduler. Returns: - Name, period (in microseconds) of currently set scheduler and name of curently set governor. + Name, period (in microseconds) of currently set scheduler and name of currently set governor. """ return client.call('framework_get_scheduler') diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index b31f2f34c..94f802bd9 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -442,9 +442,9 @@ def bdev_nvme_set_options(client, action_on_timeout=None, timeout_us=None, timeo keep_alive_timeout_ms: Keep alive timeout period in millisecond, default is 10s (optional) retry_count: The number of attempts per I/O when an I/O fails (deprecated) (optional) arbitration_burst: The value is expressed as a power of two (optional) - low_prioity_weight: The number of commands that may be executed from the low priority queue at one time (optional) - medium_prioity_weight: The number of commands that may be executed from the medium priority queue at one time (optional) - high_prioity_weight: The number of commands that may be executed from the high priority queue at one time (optional) + low_priority_weight: The number of commands that may be executed from the low priority queue at one time (optional) + medium_priority_weight: The number of commands that may be executed from the medium priority queue at one time (optional) + high_priority_weight: The number of commands that may be executed from the high priority queue at one time (optional) nvme_adminq_poll_period_us: How often the admin queue is polled for asynchronous events in microseconds (optional) nvme_ioq_poll_period_us: How often to poll I/O queues for completions in microseconds (optional) io_queue_requests: The number of requests allocated for each NVMe I/O queue. Default: 512 (optional) diff --git a/scripts/rpc/iscsi.py b/scripts/rpc/iscsi.py index f79e2bf52..9e212e8eb 100644 --- a/scripts/rpc/iscsi.py +++ b/scripts/rpc/iscsi.py @@ -443,7 +443,7 @@ def iscsi_create_portal_group(client, portals, tag, private, wait): portals: List of portals, e.g. [{'host': ip, 'port': port}] tag: Initiator group tag (unique, integer > 0) private: Public (false) or private (true) portal group for login redirection. - wait: Do not listen on portals until it is allowed explictly. + wait: Do not listen on portals until it is allowed explicitly. Returns: True or False diff --git a/scripts/setup.sh b/scripts/setup.sh index 192c3e91e..c044eb685 100755 --- a/scripts/setup.sh +++ b/scripts/setup.sh @@ -782,7 +782,7 @@ fi if [[ $os == Linux ]]; then if [[ -n $HUGEPGSZ && ! -e /sys/kernel/mm/hugepages/hugepages-${HUGEPGSZ}kB ]]; then - echo "${HUGEPGSZ}kB is not supported by the running kernel, ingoring" >&2 + echo "${HUGEPGSZ}kB is not supported by the running kernel, ignoring" >&2 unset -v HUGEPGSZ fi diff --git a/scripts/spdkcli/ui_node.py b/scripts/spdkcli/ui_node.py index c681c0660..f7989994e 100644 --- a/scripts/spdkcli/ui_node.py +++ b/scripts/spdkcli/ui_node.py @@ -575,7 +575,7 @@ class UIVirtioScsiBdev(UIBdev): class UIBdevObj(UINode): def __init__(self, bdev, parent): self.bdev = bdev - # Using bdev name also for lvol bdevs, which results in displying + # Using bdev name also for lvol bdevs, which results in displaying # UUID instead of alias. This is because alias naming convention # (lvol_store_name/lvol_bdev_name) conflicts with configshell paths # ("/" as separator). diff --git a/scripts/spdkcli/ui_node_nvmf.py b/scripts/spdkcli/ui_node_nvmf.py index 2cf183cb0..ccdaa2c08 100644 --- a/scripts/spdkcli/ui_node_nvmf.py +++ b/scripts/spdkcli/ui_node_nvmf.py @@ -76,7 +76,7 @@ class UINVMfSubsystems(UINode): def ui_command_create(self, nqn, serial_number=None, max_namespaces=None, allow_any_host="false"): - """Create subsystem with given parameteres. + """Create subsystem with given parameters. Arguments: nqn - Target nqn(ASCII). @@ -96,7 +96,7 @@ class UINVMfSubsystems(UINode): """Delete subsystem with given nqn. Arguments: - nqn_subsystem - Name of susbsytem to delete + nqn_subsystem - Name of subsystem to delete """ self.delete(subsystem_nqn) diff --git a/scripts/spdkcli/ui_root.py b/scripts/spdkcli/ui_root.py index cec8eb5f9..fabbad6af 100644 --- a/scripts/spdkcli/ui_root.py +++ b/scripts/spdkcli/ui_root.py @@ -69,7 +69,7 @@ class UIRoot(UINode): if f.__name__ in self.methods: r = f(self, **kwargs) return r - # If given method is not avaialble return empty list + # If given method is not available return empty list # similar to real get_* like rpc return [] return w diff --git a/scripts/vagrant/README.md b/scripts/vagrant/README.md index 617b2ab01..4741a36f2 100644 --- a/scripts/vagrant/README.md +++ b/scripts/vagrant/README.md @@ -138,7 +138,7 @@ This script will: 6. rsync a copy of the `~/vagrant_tools` directory to `/home/vagrant/tools` (optional) 7. execute vm_setup.sh on the guest to install all spdk dependencies (optional) -This arrangement allows the provisioning of multiple, different VMs within that same directory hierarchy using thesame +This arrangement allows the provisioning of multiple, different VMs within that same directory hierarchy using the same spdk repository. Following the creation of the vm you'll need to ssh into your virtual box and finish the VM initialization. ```bash diff --git a/scripts/vagrant/Vagrantfile b/scripts/vagrant/Vagrantfile index ea1fc0ba6..bea428ae0 100644 --- a/scripts/vagrant/Vagrantfile +++ b/scripts/vagrant/Vagrantfile @@ -179,7 +179,7 @@ def deploy_test_vm(config, distro, plugins_sync_backend) return unless ENV['COPY_SPDK_DIR'] == "1" return unless ENV['SPDK_DIR'] - # use http proxy if avaiable + # use http proxy if available setup_proxy(config, distro) # Copy the tsocks configuration file for use when installing some spdk test pool dependencies diff --git a/scripts/vagrant/create_vbox.sh b/scripts/vagrant/create_vbox.sh index f8e1cde36..3f837eb80 100755 --- a/scripts/vagrant/create_vbox.sh +++ b/scripts/vagrant/create_vbox.sh @@ -269,7 +269,7 @@ if [ -n "$SPDK_QEMU_EMULATOR" ] && [ "$SPDK_VAGRANT_PROVIDER" == "libvirt" ]; th fi if [ ${DRY_RUN} = 1 ]; then - echo "Environemnt Variables" + echo "Environment Variables" printenv SPDK_VAGRANT_DISTRO printenv SPDK_VAGRANT_VMRAM printenv SPDK_VAGRANT_VMCPU