Re: [PATCH] documentation grammer correction

Khalid Masum
2025-02-03T16:48:10Z

On Mon, Feb 3, 2025 at 10:19 PM Pranav Tyagi <pranav.tyagi03@gmail.com> wrote:
Hi Pranav,

Good catch on those grammatical errors!
>
> I am submitting this patch as a part of lfx mentorship application tasks.
> This patch contains grammatical and spelling corrections in the linux
> documentation. Please let me know if any further clarification is
> required.
>
> Regards

This part will end up in the commit log. Basically whatever "email body" you
put with your patch will end up in the commit log after acceptance. And you
want the commit log to explain what your change does.

To be more clear:
The subject line of the email becomes the commit title
The email body upto --- will turn into the commit log
Rest is the actual code change.

Now, in case of your subject line you want it to be something like this:
subsystem: your subject text

So, in your case, you want it to be something like:
vgaarbiter: documentation grammar correction

Afterwards, you can proceed with explaining what you did. For example:

"Fix grammar issues in ...."

>
> Signed-off-by: Pranav Tyagi <pranav.tyagi03@gmail.com>
Good job here!

For more information, you can look into this:
https://www.kernel.org/doc/html/v6.10/process/submitting-patches.html#the-canonical-patch-format

Best Regards,
-- Khalid Masum
> ---
> Documentation/gpu/vgaarbiter.rst | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/gpu/vgaarbiter.rst b/Documentation/gpu/vgaarbiter.rst
> index bde3c0afb059..d1e953712cc2 100644
> --- a/Documentation/gpu/vgaarbiter.rst
> +++ b/Documentation/gpu/vgaarbiter.rst
> @@ -11,9 +11,9 @@ Section 7, Legacy Devices.
>
> The Resource Access Control (RAC) module inside the X server [0] existed for
> the legacy VGA arbitration task (besides other bus management tasks) when more
> -than one legacy device co-exists on the same machine. But the problem happens
> +than one legacy device co-exist on the same machine. But the problem happens
> when these devices are trying to be accessed by different userspace clients
> -(e.g. two server in parallel). Their address assignments conflict. Moreover,
> +(e.g. two servers in parallel). Their address assignments conflict. Moreover,
> ideally, being a userspace application, it is not the role of the X server to
> control bus resources. Therefore an arbitration scheme outside of the X server
> is needed to control the sharing of these resources. This document introduces
> @@ -106,7 +106,7 @@ In-kernel interface
> libpciaccess
> ------------
>
> -To use the vga arbiter char device it was implemented an API inside the
> +To use the vga arbiter char device, an API was implemented inside the
> libpciaccess library. One field was added to struct pci_device (each device
> on the system)::
>
> --
> 2.47.1
>
>