Re: [PATCH] Add Documentation/CodingStyle

From: Andreas Ericsson <ae@op5.se>
Date: Nov 7, 2007, 00:04 UTC
Message-ID: <47310104.5040202@op5.se>
In-Reply-To: <Pine.LNX.4.64.0711062317330.4362@racer.site>

Johannes Schindelin wrote:

> Even if our code is quite a good documentation for our coding style,
> some people seem to prefer a document describing it.
>

Sweet. You just saved me 40 minutes of writing one just like that for company use. I owe you a drink, and then you can tell me what movie you alluded to ;-)

Show 5 quoted lines

> +
> + - if you are planning a new command, consider writing it in shell or
> +   perl first, so that changes in semantics can be easily changed and
> +   discussed.  Many git commands started out like that, and a few are
> +   still scripts.

I'd skip this part though and just add a pointer to contrib/examples/, saying something along the lines of

- if you're planning a new command, sneak a peak in contrib/examples/
  for ample study-material of retired git commands implemented in perl
  and shell.

Possibly with s/retired // on that paragraph.

There's nothing particular wrong with writing in C from the start after all.

-- 
Andreas Ericsson                   andreas.ericsson@op5.se
OP5 AB                             www.op5.se
Tel: +46 8-230225                  Fax: +46 8-230231