Re: [PATCH] CodingGuidelines: updating 'rough' rule count

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Apr 13, 2015, 00:04 UTC
Message-ID: <CAPig+cS=xBoe-hr5Kwm0N9hBUy4bzN1NoXTcDEwz_4ZwrrXPXA@mail.gmail.com>
In-Reply-To: <20150412234720.GA37658@Serenity.local>

On Sun, Apr 12, 2015 at 7:47 PM, Julian Gindi <juliangindi@gmail.com> wrote:

Show 12 quoted lines

> Changed inaccurate count of "rough rules" from three to four.
>
> Signed-off-by: Julian Gindi <juliangindi@gmail.com>
> ---
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 0f8cccf..c422ecd 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -1,5 +1,5 @@
>  Like other projects, we also have some guidelines to keep to the
> -code.  For Git in general, three rough rules are:
> +code.  For Git in general, four rough rules are:

Although this change is technically accurate, this sentence is still a potential maintenance burden. How about taking a more generic approach, and saying something like:

    For Git, in general, the rough rules are:

>   - Most importantly, we never say "It's in POSIX; we'll happily
>     ignore your needs should your system not conform to it."
> --
> 2.3.5