git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andreas Ericsson <ae@op5.se>
To: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Cc: Junio C Hamano <gitster@pobox.com>,
	Ralf Wildenhues <Ralf.Wildenhues@gmx.de>,
	git@vger.kernel.org
Subject: Re: [PATCH] Add Documentation/CodingStyle
Date: Wed, 07 Nov 2007 01:04:20 +0100	[thread overview]
Message-ID: <47310104.5040202@op5.se> (raw)
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 ;-)

> +
> + - 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

  reply	other threads:[~2007-11-07  0:04 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-11-06 20:15 [PATCH 0/5] some shell portability fixes Ralf Wildenhues
2007-11-06 20:17 ` [PATCH 1/5] Avoid a few unportable, needlessly nested "...`..." Ralf Wildenhues
2007-11-06 20:17 ` [PATCH 2/5] Fix sed script to work with AIX sed Ralf Wildenhues
2007-11-06 20:18 ` [PATCH 3/5] Replace $((...)) with expr invocations Ralf Wildenhues
2007-11-06 20:26   ` Ralf Wildenhues
2007-11-06 21:06     ` Junio C Hamano
2007-11-06 23:17       ` [PATCH] Add Documentation/CodingStyle Johannes Schindelin
2007-11-07  0:04         ` Andreas Ericsson [this message]
2007-11-07  0:40         ` Junio C Hamano
2007-11-07  8:52           ` Andreas Ericsson
2007-11-07 14:59             ` [PATCH v2] " Johannes Schindelin
2007-11-07 21:43               ` Robin Rosenberg
2007-11-07 22:35                 ` [PATCH v3] Add Documentation/CodingGuidelines Johannes Schindelin
2007-11-07 23:14                   ` Junio C Hamano
2007-11-08  0:33                     ` [PATCH v4] " Johannes Schindelin
2007-11-08  0:38                       ` Junio C Hamano
2007-11-07 14:54           ` [PATCH] Add Documentation/CodingStyle Johannes Schindelin
2007-11-07  7:53         ` Wincent Colaiuta
2007-11-07  8:53           ` Andreas Ericsson
2007-11-07 19:40         ` Jon Loeliger
2007-11-07 20:13           ` Johannes Schindelin
2007-11-08 11:29         ` Mike Ralphson
2007-11-06 20:20 ` [PATCH 4/5] Fix sed string regex escaping in module_name Ralf Wildenhues
2007-11-06 20:20 ` [PATCH 5/5] Avoid "test -o" and "test -a" which are not POSIX, only XSI Ralf Wildenhues
2007-11-06 20:46 ` [PATCH 0/5] some shell portability fixes Junio C Hamano
2007-11-06 21:02   ` Mike Hommey
2007-11-06 23:25     ` Johannes Schindelin
2007-11-07 14:17       ` Mike Ralphson
2007-11-07 14:47         ` Johannes Schindelin
2007-11-07 15:30           ` Mike Ralphson
2007-11-07 15:37             ` Johannes Schindelin
2007-11-06 21:09   ` Ralf Wildenhues
2007-11-07 15:58   ` Nguyen Thai Ngoc Duy
2007-11-07 16:05     ` Nguyen Thai Ngoc Duy
2007-11-07 20:42       ` Junio C Hamano
2007-11-08  6:14         ` Ralf Wildenhues
2007-11-12 11:20         ` Nguyen Thai Ngoc Duy
2007-11-10 22:30   ` Miles Bader

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=47310104.5040202@op5.se \
    --to=ae@op5.se \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=Ralf.Wildenhues@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).