Re: [PATCH] docs: Fix spaces and capitalisation of proper nouns and abbreviations

[Stefano Stabellini <sstabellini@xxxxxxxxxx>]

On Wed, 15 Jan 2025, Bernhard Kaindl wrote:
> Signed-off-by: Bernhard Kaindl <bernhard.kaindl@xxxxxxxxx>
> ---
>  SUPPORT.md                       | 18 +++++++++---------
>  docs/designs/qemu-deprivilege.md |  2 +-
>  2 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/SUPPORT.md b/SUPPORT.md
> index 2bc5bd81ee..9478b70b1b 100644
> --- a/SUPPORT.md
> +++ b/SUPPORT.md
> @@ -258,7 +258,7 @@ Go (golang) bindings for libxl
>  
>  ### Linux device model stubdomains
>  
> -Support for running qemu-xen device model in a linux stubdomain.
> +Support for running the qemu-xen device model in a Linux stubdomain.
>  
>      Status: Tech Preview
>  
> @@ -626,7 +626,7 @@ Guest-side driver capable of speaking the Xen 9pfs 
> protocol
>  
>  ### PVCalls (frontend)
>  
> -Guest-side driver capable of making pv system calls
> +Guest-side driver capable of making PV system calls
>  
>      Status, Linux: Tech Preview
>  
> @@ -1060,8 +1060,8 @@ This file contains prose, and machine-readable 
> fragments.
>  The data in a machine-readable fragment relate to
>  the section and subsection in which it is found.
>  
> -The file is in markdown format.
> -The machine-readable fragments are markdown literals
> +The file is in Markdown format.
> +The machine-readable fragments are Markdown literals
>  containing RFC-822-like (deb822-like) data.
>  
>  In each case, descriptions which expand on the name of a feature as
> @@ -1125,7 +1125,7 @@ in such a case this feature may be described as "Stable 
> / Interface not stable".
>  
>  Does it behave like a fully functional feature?
>  Does it work on all expected platforms,
> -or does it only work for a very specific sub-case?
> +or does it only work for a very specific subcase?
>  Does it have a sensible UI,
>  or do you have to have a deep understanding of the internals
>  to get it to work properly?
> @@ -1168,7 +1168,7 @@ will they still work when I upgrade to the next version?
>  
>    * **Stable**
>  
> -    We will try very hard to avoid breaking backwards  compatibility,
> +    We will try very hard to avoid breaking backwards compatibility,
>      and to fix any regressions that are reported.
>  
>  ### Security supported
> @@ -1200,7 +1200,7 @@ are given the following labels:
>    * **Supported, Security support external**
>  
>      This feature is security supported
> -    by a different organization (not the XenProject).
> +    by a different organization (not the Xen Project).
>      The extent of support is defined by that organization.
>      It might be limited, e.g. like described in **Supported, with caveats**
>      below.
> @@ -1221,8 +1221,8 @@ Some features are only for HVM guests; some don't work 
> with migration, &c.
>  
>  ### External security support
>  
> -The XenProject security team
> -provides security support for XenProject projects.
> +The Xen Project security team
> +provides security support for the various projects of the Xen Project.

We called sub-projects, I am not sure with or without the dash:

provides security support for the various sub-projects part of the Xen Project.


>  We also provide security support for Xen-related code in Linux,
>  which is an external project but doesn't have its own security process.
> diff --git a/docs/designs/qemu-deprivilege.md 
> b/docs/designs/qemu-deprivilege.md
> index 603491f24d..3be33adf6a 100644
> --- a/docs/designs/qemu-deprivilege.md
> +++ b/docs/designs/qemu-deprivilege.md
> @@ -297,7 +297,7 @@ namespaces):
>      unshare(CLONE_NEWNET);
>  
>  QEMU does actually use the network namespace as a Xen DM for two
> -purposes: 1) To set up network tap devices 2) To open vnc connections.
> +purposes: 1) To set up network tap devices 2) To open VNC connections.
>  
>  #### Network
>  
> -- 
> 2.43.0
>