From 7cebcf087e14c95d97359fd3565c83e978e5c856 Mon Sep 17 00:00:00 2001 From: Bernhard Kaindl Date: Fri, 31 Jan 2025 12:00:00 +0100 Subject: [PATCH 1/2] Hugo docs: Fix random typos and simple word repetitions here and there Signed-off-by: Bernhard Kaindl --- doc/content/design/emulated-pci-spec.md | 2 +- doc/content/design/user-certificates.md | 2 +- doc/content/squeezed/architecture/index.md | 2 +- doc/content/squeezed/squeezer.md | 2 +- doc/content/toolstack/high-level/environment.md | 6 +++--- doc/content/toolstack/responsibilities.md | 2 +- doc/content/xen-api/topics/udhcp.md | 2 +- doc/content/xen-api/wire-protocol.md | 6 +++--- doc/content/xenopsd/design/Tasks.md | 2 +- doc/content/xenopsd/design/pvs-proxy-ovs.md | 2 +- doc/content/xenopsd/design/suspend-image-framing-format.md | 2 +- doc/content/xenopsd/features.md | 4 ++-- doc/layouts/partials/content.html | 4 ++-- 13 files changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/content/design/emulated-pci-spec.md b/doc/content/design/emulated-pci-spec.md index 7a976ede1a2..cd8b8e7b13f 100644 --- a/doc/content/design/emulated-pci-spec.md +++ b/doc/content/design/emulated-pci-spec.md @@ -11,7 +11,7 @@ status: proposed At present (early March 2015) the datamodel defines a VM as having a "platform" string-string map, in which two keys are interpreted as specifying a PCI device which should be emulated for the VM. Those keys are "device_id" and "revision" (with int values represented as decimal strings). Limitations: -* Hardcoded defaults are used for the the vendor ID and all other parameters except device_id and revision. +* Hardcoded defaults are used for the vendor ID and all other parameters except device_id and revision. * Only one emulated PCI device can be specified. When instructing qemu to emulate PCI devices, qemu accepts twelve parameters for each device. diff --git a/doc/content/design/user-certificates.md b/doc/content/design/user-certificates.md index 33f61c3e905..a2674fe02dd 100644 --- a/doc/content/design/user-certificates.md +++ b/doc/content/design/user-certificates.md @@ -220,7 +220,7 @@ A new class, Certificate, will be added with the following schema: | ---------- | --------- | ----- | | uuid | | | type | CA | Certificate trusted by all hosts -| | Host | Certificate that the host present sto normal clients +| | Host | Certificate that the host presents to normal clients | name | String | Name, only present for trusted certificates | host | Ref _host | Host where the certificate is installed | not_before | DateTime | Date after which the certificate is valid diff --git a/doc/content/squeezed/architecture/index.md b/doc/content/squeezed/architecture/index.md index 6d85730ae30..fb86fd69989 100644 --- a/doc/content/squeezed/architecture/index.md +++ b/doc/content/squeezed/architecture/index.md @@ -18,7 +18,7 @@ includes: together describe a range, within which the domain's actual used memory should remain. - Per-domain calibration data which allows us to compute the necessary balloon - target value to achive a particular memory usage value. + target value to achieve a particular memory usage value. Squeezed is a single-threaded program which receives commands from xenopsd over a Unix domain socket. When Xenopsd wishes to start a new VM, squeezed will be diff --git a/doc/content/squeezed/squeezer.md b/doc/content/squeezed/squeezer.md index 059d295a532..5b7c2d17739 100644 --- a/doc/content/squeezed/squeezer.md +++ b/doc/content/squeezed/squeezer.md @@ -4,7 +4,7 @@ hidden: true --- {{% notice warning %}} -This was converted to markdown from squeezer.tex. It is not clear how much +This was converted to Markdown from squeezer.tex. It is not clear how much of this document is still relevant and/or already present in the other docs. {{% /notice %}} diff --git a/doc/content/toolstack/high-level/environment.md b/doc/content/toolstack/high-level/environment.md index cdfbd41a47d..7522757fdfd 100644 --- a/doc/content/toolstack/high-level/environment.md +++ b/doc/content/toolstack/high-level/environment.md @@ -7,14 +7,14 @@ The Toolstack runs in an environment on a server (host) that has: - Physical hardware. - The Xen hypervisor. -- The control domain (domain 0): the priviledged domain that the Toolstack runs in. -- Other, mostly unpriviledged domains, usually for guests (VMs). +- The control domain (domain 0): the privileged domain that the Toolstack runs in. +- Other, mostly unprivileged domains, usually for guests (VMs). The Toolstack relies on various bits of software inside the control domain, and directly communicates with most of these: - Linux kernel including drivers for hardware and Xen paravirtualised devices (e.g. `netback` and `blkback`). - Interacts through `/sys` and `/proc`, udev scripts, xenstore, ... -- CentOS distibution including userspace tools and libraries. +- CentOS distribution including userspace tools and libraries. - systemd, networking tools, ... - Xen-specific libraries, especially `libxenctrl` (a.k.a. `libxc`) - `xenstored`: a key-value pair configuration database diff --git a/doc/content/toolstack/responsibilities.md b/doc/content/toolstack/responsibilities.md index 3af1b8d4e31..dc0c3febd4a 100644 --- a/doc/content/toolstack/responsibilities.md +++ b/doc/content/toolstack/responsibilities.md @@ -3,7 +3,7 @@ title = "Responsibilities" weight = 10 +++ -The XAPI Toolstack forms the main control plane of a pool of XenServer hosts. It allow the administrator to: +The XAPI Toolstack forms the main control plane of a pool of XenServer hosts. It allows the administrator to: - Configure the hardware resources of XenServer hosts: storage, networking, graphics, memory. - Create, configure and destroy VMs and their virtual resources. diff --git a/doc/content/xen-api/topics/udhcp.md b/doc/content/xen-api/topics/udhcp.md index a126ed1624c..70393fd2342 100644 --- a/doc/content/xen-api/topics/udhcp.md +++ b/doc/content/xen-api/topics/udhcp.md @@ -11,7 +11,7 @@ the network. It should be noted that for this reason, that callers who modify the default configuration should be aware that their changes may have an -adverse affect on other consumers of the HIMN. +adverse effect on other consumers of the HIMN. Version history --------------- diff --git a/doc/content/xen-api/wire-protocol.md b/doc/content/xen-api/wire-protocol.md index 8a4fe9f5012..2afc98bf3f2 100644 --- a/doc/content/xen-api/wire-protocol.md +++ b/doc/content/xen-api/wire-protocol.md @@ -285,7 +285,7 @@ contains the members `jsonrpc`, `method`, `params`, and `id`. (requests without responses). For example, the body of a JSON-RPC v2.0 request to retrieve the VMs resident on -a host may may look like this: +a host may look like this: ```json { @@ -538,7 +538,7 @@ you must login and initiate a session. For example: where `uname` and `password` refer to your username and password, as defined by the Xen administrator, while `version` and `originator` are optional. The `session ref` returned by `session.login_with_password` is passed -to subequent RPC calls as an authentication token. Note that a session +to subsequent RPC calls as an authentication token. Note that a session reference obtained by a login request to the XML-RPC backend can be used in subsequent requests to the JSON-RPC backend, and vice-versa. @@ -565,7 +565,7 @@ Instead of returning its result directly, an asynchronous RPC call returns an identifier of type `task ref` which is subsequently used to track the status of a running asynchronous RPC. -Note that an asychronous call may fail immediately, before a task has even been +Note that an asynchronous call may fail immediately, before a task has even been created. When using the XML-RPC wire protocol, this eventuality is represented by wrapping the returned `task ref` in an XML-RPC struct with a `Status`, `ErrorDescription`, and `Value` fields, exactly as specified above; the diff --git a/doc/content/xenopsd/design/Tasks.md b/doc/content/xenopsd/design/Tasks.md index 1c06f18fee9..23f012d5e0e 100644 --- a/doc/content/xenopsd/design/Tasks.md +++ b/doc/content/xenopsd/design/Tasks.md @@ -124,7 +124,7 @@ helper function [perform_atomics](https://github.com/xapi-project/xenopsd/blob/f876f9029cf53f14a52bf42a4a3a03265e048926/lib/xenops_server.ml#L1092) which divides the progress 'bar' into sections, where each "micro-op" can have a different size (`weight`). A progress callback function is passed into -each Xenopsd backend function so it can be updated with fine granulatiry. For +each Xenopsd backend function so it can be updated with fine granularity. For example note the arguments to [B.VM.save](https://github.com/xapi-project/xenopsd/blob/f876f9029cf53f14a52bf42a4a3a03265e048926/lib/xenops_server.ml#L1092) diff --git a/doc/content/xenopsd/design/pvs-proxy-ovs.md b/doc/content/xenopsd/design/pvs-proxy-ovs.md index 372179077c5..4bed353b449 100644 --- a/doc/content/xenopsd/design/pvs-proxy-ovs.md +++ b/doc/content/xenopsd/design/pvs-proxy-ovs.md @@ -16,7 +16,7 @@ redirect traffic between PVS and VM to pass through the proxy. OVS uses rules that match packets. Rules are organised in sets called tables. A rule can be used to match a packet and to inject it into -another rule set/table table such that a packet can be matched again. +another rule set/table such that a packet can be matched again. Furthermore, a rule can set registers associated with a packet which that can be matched in subsequent rules. In that way, a packet can be tagged diff --git a/doc/content/xenopsd/design/suspend-image-framing-format.md b/doc/content/xenopsd/design/suspend-image-framing-format.md index 1b9311ebf26..e1e619bed9a 100644 --- a/doc/content/xenopsd/design/suspend-image-framing-format.md +++ b/doc/content/xenopsd/design/suspend-image-framing-format.md @@ -19,7 +19,7 @@ Example suspend image layout: | 5.0 End_of_image footer | +----------------------------+ -A suspend image is now constucted as a series of header-record pairs. The +A suspend image is now constructed as a series of header-record pairs. The initial signature (1.) is used to determine whether we are dealing with the unstructured, "legacy" suspend image or the new, structured format. diff --git a/doc/content/xenopsd/features.md b/doc/content/xenopsd/features.md index 65651e8d8bc..be0e9e98b73 100644 --- a/doc/content/xenopsd/features.md +++ b/doc/content/xenopsd/features.md @@ -73,11 +73,11 @@ Hosts APIs ---- -- versioned json-rpc API with feature advertisements +- versioned JSON-RPC API with feature advertisements - clients can disconnect, reconnect and easily resync with the latest VM state without losing updates - all operations have task control including - - asychronous cancellation: for both subprocesses and xenstore watches + - asynchronous cancellation: for both subprocesses and xenstore watches - progress updates - subtasks - per-task debug logs diff --git a/doc/layouts/partials/content.html b/doc/layouts/partials/content.html index c0c377e2f5d..ebba286db1e 100644 --- a/doc/layouts/partials/content.html +++ b/doc/layouts/partials/content.html @@ -1,7 +1,7 @@ {{- /* Partial to generate the content of XenAPI class reference and release pages, see: */}} {{- /* https://mcshelby.github.io/hugo-theme-relearn/configuration/customization/partials/index.html */}} -{{- /* XenAPI class reference pages define a class fontmatter */}} +{{- /* XenAPI class reference pages define a class frontmatter */}} {{- /* For these, provide and generate their class reference content: */}} {{ .Content }} @@ -200,7 +200,7 @@

{{ end }} -{{- /* XenAPI release pages define a release fontmatter */}} +{{- /* XenAPI release pages define a release frontmatter */}} {{- /* For these provide and generate their page content */}} {{ $r := .Page.Params.release }} From e899078b990199897a40ea1bdb74bcb729f6d47e Mon Sep 17 00:00:00 2001 From: Bernhard Kaindl Date: Mon, 3 Feb 2025 12:00:00 +0100 Subject: [PATCH 2/2] Fix CI: Re-enable running shellcheck even when only docs changed Signed-off-by: Bernhard Kaindl --- .github/workflows/shellcheck.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/shellcheck.yaml b/.github/workflows/shellcheck.yaml index 2a41d80da51..b078eaba549 100644 --- a/.github/workflows/shellcheck.yaml +++ b/.github/workflows/shellcheck.yaml @@ -2,10 +2,6 @@ name: ShellCheck on: pull_request: - # When only Hugo docs change, this workflow is not required: - paths-ignore: - - 'doc/**' - - '.github/workflows/hugo.yml' merge_group: concurrency: # On new push, cancel old workflows from the same PR, branch or tag: