[PATCH] Documentation: x86: Fix typos

[PATCH] Documentation: x86: Fix typos

[Tamara Diaconita]

Fix typos in x86 directory.
Make documentation clear and grammatically correct.

Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com>
---
 Documentation/x86/boot.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/x86/boot.txt b/Documentation/x86/boot.txt
index 5e9b826..694979a 100644
--- a/Documentation/x86/boot.txt
+++ b/Documentation/x86/boot.txt
@@ -336,7 +336,7 @@ Type:		read
 Offset/size:	0x20e/2
 Protocol:	2.00+
 
-  If set to a nonzero value, contains a pointer to a NUL-terminated
+  If set to a nonzero value, contains a pointer to a NULL-terminated
   human-readable kernel version number string, less 0x200.  This can
   be used to display the kernel version to the user.  This value
   should be less than (0x200*setup_sects).
@@ -1105,7 +1105,7 @@ address of the struct boot_params.
 
 **** EFI HANDOVER PROTOCOL
 
-This protocol allows boot loaders to defer initialisation to the EFI
+This protocol allows boot loaders to defer initialization to the EFI
 boot stub. The boot loader is required to load the kernel/initrd(s)
 from the boot media and jump to the EFI handover protocol entry point
 which is hdr->handover_offset bytes from the beginning of
-- 
2.9.3

Re: [Outreachy kernel] [PATCH] Documentation: x86: Fix typos

[Julia Lawall]

On Tue, 14 Mar 2017, Tamara Diaconita wrote:

> Fix typos in x86 directory.
> Make documentation clear and grammatically correct.
>
> Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com>
> ---
>  Documentation/x86/boot.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/x86/boot.txt b/Documentation/x86/boot.txt
> index 5e9b826..694979a 100644
> --- a/Documentation/x86/boot.txt
> +++ b/Documentation/x86/boot.txt
> @@ -336,7 +336,7 @@ Type:		read
>  Offset/size:	0x20e/2
>  Protocol:	2.00+
>
> -  If set to a nonzero value, contains a pointer to a NUL-terminated
> +  If set to a nonzero value, contains a pointer to a NULL-terminated
>    human-readable kernel version number string, less 0x200.  This can
>    be used to display the kernel version to the user.  This value
>    should be less than (0x200*setup_sects).
> @@ -1105,7 +1105,7 @@ address of the struct boot_params.
>
>  **** EFI HANDOVER PROTOCOL
>
> -This protocol allows boot loaders to defer initialisation to the EFI
> +This protocol allows boot loaders to defer initialization to the EFI

This is an American vs British English issue.  I don't know if the Linux
kernel prefers one or the other.

julia

>  boot stub. The boot loader is required to load the kernel/initrd(s)
>  from the boot media and jump to the EFI handover protocol entry point
>  which is hdr->handover_offset bytes from the beginning of
> --
> 2.9.3
>
> --
> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
> To post to this group, send email to outreachy-kernel@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20170314083902.4491-1-diaconita.tamara%40gmail.com.
> For more options, visit https://groups.google.com/d/optout.
>

Re: [Outreachy kernel] [PATCH] Documentation: x86: Fix typos

[Jani Nikula]

On Tue, 14 Mar 2017, Julia Lawall <julia.lawall@lip6.fr> wrote:
> On Tue, 14 Mar 2017, Tamara Diaconita wrote:
>
>> Fix typos in x86 directory.
>> Make documentation clear and grammatically correct.
>>
>> Signed-off-by: Tamara Diaconita <diaconita.tamara@gmail.com>
>> ---
>>  Documentation/x86/boot.txt | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/Documentation/x86/boot.txt b/Documentation/x86/boot.txt
>> index 5e9b826..694979a 100644
>> --- a/Documentation/x86/boot.txt
>> +++ b/Documentation/x86/boot.txt
>> @@ -336,7 +336,7 @@ Type:		read
>>  Offset/size:	0x20e/2
>>  Protocol:	2.00+
>>
>> -  If set to a nonzero value, contains a pointer to a NUL-terminated
>> +  If set to a nonzero value, contains a pointer to a NULL-terminated
>>    human-readable kernel version number string, less 0x200.  This can
>>    be used to display the kernel version to the user.  This value
>>    should be less than (0x200*setup_sects).
>> @@ -1105,7 +1105,7 @@ address of the struct boot_params.
>>
>>  **** EFI HANDOVER PROTOCOL
>>
>> -This protocol allows boot loaders to defer initialisation to the EFI
>> +This protocol allows boot loaders to defer initialization to the EFI
>
> This is an American vs British English issue.  I don't know if the Linux
> kernel prefers one or the other.

We prefer they are best left as they are!

http://marc.info/?i=20170313082328.06d0ccbf@lwn.net

BR,
Jani.


>
> julia
>
>>  boot stub. The boot loader is required to load the kernel/initrd(s)
>>  from the boot media and jump to the EFI handover protocol entry point
>>  which is hdr->handover_offset bytes from the beginning of
>> --
>> 2.9.3
>>
>> --
>> You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
>> To unsubscribe from this group and stop receiving emails from it, send an email to outreachy-kernel+unsubscribe@googlegroups.com.
>> To post to this group, send email to outreachy-kernel@googlegroups.com.
>> To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20170314083902.4491-1-diaconita.tamara%40gmail.com.
>> For more options, visit https://groups.google.com/d/optout.
>>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

-- 
Jani Nikula, Intel Open Source Technology Center

Re: [PATCH] Documentation: x86: Fix typos

[Jonathan Corbet]

On Tue, 14 Mar 2017 10:39:02 +0200
Tamara Diaconita <diaconitatamara@gmail.com> wrote:

> -  If set to a nonzero value, contains a pointer to a NUL-terminated
> +  If set to a nonzero value, contains a pointer to a NULL-terminated

This one is actually correct as-is.  NUL is an ASCII character zero, as
one would find at the end of a string, while NULL is a pointer value.

Thanks,

jon