threads / patch / 39057

patchCodingGuidelines: updating 'rough' rule count

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

## tl;dr

7 messages between Apr 12, 2015 and Apr 13, 2015. Diffs are folded; open one to read it.

replies: 6people: 3as markdown or json

Julian Gindi· Apr 12, 2015, 23:47 UTC · lore
Changed inaccurate count of "rough rules" from three to four.
Signed-off-by: Julian Gindi <juliangindi@gmail.com>
---
 Documentation/CodingGuidelines | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/CodingGuidelines +1 −1
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:
 
  - 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
Eric Sunshine· Apr 13, 2015, 00:04 UTC · re: Julian Gindi · lore

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

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
Julian Gindi· Apr 13, 2015, 04:26 UTC · re: Eric Sunshine · lore

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

    Changed inaccurate count of "rough rules" from three to the more
    generic 'a few'.
---
 Documentation/CodingGuidelines | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/CodingGuidelines +1 −1
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 0f8cccf..2dd35bd 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, a few 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
Eric Sunshine· Apr 13, 2015, 05:00 UTC · re: Julian Gindi · lore

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

On Mon, Apr 13, 2015 at 12:26 AM, Julian Gindi <juliangindi@gmail.com> wrote:
> CodingGuidelines: updating 'rough' rule count
Imperative mood is preferred, so "update" rather than "updating":
    CodingGuidelines: update 'rough' rule count
>     Changed inaccurate count of "rough rules" from three to the more
>     generic 'a few'.
Imperative: s/Changed/Change/
> ---
Missing sign-off.
Show 8 quoted lines
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 0f8cccf..2dd35bd 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, a few rough rules are:
Looks better, thanks.
>   - 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
Eric Sunshine· Apr 13, 2015, 05:04 UTC · re: Eric Sunshine · lore

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

On Mon, Apr 13, 2015 at 1:00 AM, Eric Sunshine <sunshine@sunshineco.com> wrote:
Show 5 quoted lines
> On Mon, Apr 13, 2015 at 12:26 AM, Julian Gindi <juliangindi@gmail.com> wrote:
>>     Changed inaccurate count of "rough rules" from three to the more
>>     generic 'a few'.
>
> Imperative: s/Changed/Change/

I forgot to mention the unusual 2-space indentation of the log message. It should be left-justified.

Julian Gindi· Apr 13, 2015, 12:54 UTC · re: Eric Sunshine · lore

Re: [PATCH v3] CodingGuidelines: update 'rough' rule count

Changed inaccurate count of "rough rules" from three to the more generic 'a few'.

Signed-off-by: Julian Gindi <juliangindi@gmail.com>
---
 Documentation/CodingGuidelines | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Show changes to Documentation/CodingGuidelines +1 −1
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 0f8cccf..2dd35bd 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, a few 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
Jonathan Nieder· Apr 13, 2015, 17:30 UTC · re: Julian Gindi · lore

Re: [PATCH v3] CodingGuidelines: update 'rough' rule count

Julian Gindi wrote:
> Changed inaccurate count of "rough rules" from three to the more
> generic 'a few'.
>
> Signed-off-by: Julian Gindi <juliangindi@gmail.com>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Thanks.

← back to recent threads