linux-kernel - [PATCH] Documentation: virt: clean up paravirt

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230610054310.6242-1-rdunlap@infradead.org>
Date:   Fri,  9 Jun 2023 22:43:10 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        Juergen Gross <jgross@...e.com>,
        Ajay Kaher <akaher@...are.com>,
        Alexey Makhalov <amakhalov@...are.com>,
        VMware PV-Drivers Reviewers <pv-drivers@...are.com>,
        virtualization@...ts.linux-foundation.org, x86@...nel.org,
        Paolo Bonzini <pbonzini@...hat.com>,
        "Luke Nowakowski-Krijger" <lnowakow@....ucsd.edu>,
        Luis Chamberlain <mcgrof@...nel.org>
Subject: [PATCH] Documentation: virt: clean up paravirt_ops doc.

Clarify language. Clean up grammar. Hyphenate some words.

Change "low-ops" to "low-level" since "low-ops" isn't defined or even
mentioned anywhere else in the kernel source tree.

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Juergen Gross <jgross@...e.com>
Cc: Ajay Kaher <akaher@...are.com>
Cc: Alexey Makhalov <amakhalov@...are.com>
Cc: VMware PV-Drivers Reviewers <pv-drivers@...are.com>
Cc: virtualization@...ts.linux-foundation.org
Cc: x86@...nel.org
Cc: Paolo Bonzini <pbonzini@...hat.com>
Cc: "Luke Nowakowski-Krijger" <lnowakow@....ucsd.edu>
Cc: Luis Chamberlain <mcgrof@...nel.org>
---
 Documentation/virt/paravirt_ops.rst |   16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff -- a/Documentation/virt/paravirt_ops.rst b/Documentation/virt/paravirt_ops.rst
--- a/Documentation/virt/paravirt_ops.rst
+++ b/Documentation/virt/paravirt_ops.rst
@@ -5,31 +5,31 @@ Paravirt_ops
 ============
 
 Linux provides support for different hypervisor virtualization technologies.
-Historically different binary kernels would be required in order to support
-different hypervisors, this restriction was removed with pv_ops.
+Historically, different binary kernels would be required in order to support
+different hypervisors; this restriction was removed with pv_ops.
 Linux pv_ops is a virtualization API which enables support for different
 hypervisors. It allows each hypervisor to override critical operations and
 allows a single kernel binary to run on all supported execution environments
 including native machine -- without any hypervisors.
 
 pv_ops provides a set of function pointers which represent operations
-corresponding to low level critical instructions and high level
-functionalities in various areas. pv-ops allows for optimizations at run
-time by enabling binary patching of the low-ops critical operations
+corresponding to low-level critical instructions and high-level
+functionalities in various areas. pv_ops allows for optimizations at run
+time by enabling binary patching of the low-level critical operations
 at boot time.
 
 pv_ops operations are classified into three categories:
 
 - simple indirect call
-   These operations correspond to high level functionality where it is
+   These operations correspond to high-level functionality where it is
    known that the overhead of indirect call isn't very important.
 
 - indirect call which allows optimization with binary patch
-   Usually these operations correspond to low level critical instructions. They
+   Usually these operations correspond to low-level critical instructions. They
    are called frequently and are performance critical. The overhead is
    very important.
 
 - a set of macros for hand written assembly code
    Hand written assembly codes (.S files) also need paravirtualization
-   because they include sensitive instructions or some of code paths in
+   because they include sensitive instructions or some code paths in
    them are very performance critical.