Re: [PATCH] typo fix in Documentation/eisa.txt

[L. A. Walsh]

Rolf Eike Beer wrote:

> Typo fixes.
>
> Thanks to Randy Dunlap and Jean Delvare.
>
> Signed-off-by: Rolf Eike Beer <eike-kernel@xxxxxxxxx>
>
> --- linux-2.6.11/Documentation/eisa.txt	2005-03-02 08:38:12.000000000 +0100
> +++ linux-2.6.12-rc1/Documentation/eisa.txt	2005-03-27 21:58:04.000000000 +0200
> @@ -171,9 +171,9 @@
> virtual_root.force_probe :
>
> Force the probing code to probe EISA slots even when it cannot find an
> -EISA compliant mainboard (nothing appears on slot 0). Defaultd to 0
> -(don't force), and set to 1 (force probing) when either
> -CONFIG_ALPHA_JENSEN or CONFIG_EISA_VLB_PRIMING are set.
> +EISA compliant mainboard (nothing appears on slot 0). Defaults to 0
> +(don't force) and set to 1 (force probing) when either
> +CONFIG_ALPHA_JENSEN or CONFIG_EISA_VLB_PRIMING is set.
---
01234567890123456789012345678901234567890123456789012345678901234567890123456789
   My expertise is limited by a fuzzy memory, and I know it's bad form to
comment much on english usage or spelling as they are often tangential to
the issue at hand, but as long as we are on the topic, I think you had it
right the first time.

   I believe the comment, properly used the "imperative":
declaring intended usage of the variable, i.e. - "Do this or do
that"; "Default to 0 or set to 1".  To use a perl like example:

                      # set probe action:
probe=0;               # default to 0 (don't force)
probe=1 if (X || Y);   # and set to 1 (force), if either X or Y is set

   If you use "Defaults", then I think that's an implied 3rd person
singular usage and for correct parallelism, the parallel clause (after
the "and") should use the same tense.  Third person tense for "set"
would use "is" as a passive-voice auxiliary: "[it] is set to 1..."

   Saying "default to 0" is like the perlism:
   setup values of v:

   v=0;               # default to 0
   v=1 if (X || Y);   # and set to 1 if X or Y is set

   I can't believe we are discussing grammer concerns in comments in
the linux-kenel.  :-) (!).

-linda

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/