From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Eric S. Raymond" Subject: Re: [PATCH] Add documentation on how to integrate commands. Date: Sat, 24 Nov 2012 19:06:05 -0500 Organization: Eric Conspiracy Secret Labs Message-ID: <20121125000605.GA22548@thyrsus.com> References: <20121124122333.BAD7B4065F@snark.thyrsus.com> <20121124151127.GA24459@padd.com> Reply-To: esr@thyrsus.com Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: QUOTED-PRINTABLE Cc: git@vger.kernel.org To: Pete Wyckoff X-From: git-owner@vger.kernel.org Sun Nov 25 01:07:33 2012 Return-path: Envelope-to: gcvg-git-2@plane.gmane.org Received: from vger.kernel.org ([209.132.180.67]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1TcPkx-0003oz-9W for gcvg-git-2@plane.gmane.org; Sun, 25 Nov 2012 01:07:31 +0100 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752822Ab2KYAHE convert rfc822-to-quoted-printable (ORCPT ); Sat, 24 Nov 2012 19:07:04 -0500 Received: from static-71-162-243-5.phlapa.fios.verizon.net ([71.162.243.5]:38569 "EHLO snark.thyrsus.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752720Ab2KYAHA (ORCPT ); Sat, 24 Nov 2012 19:07:00 -0500 Received: by snark.thyrsus.com (Postfix, from userid 1000) id 3B2AA4065F; Sat, 24 Nov 2012 19:06:06 -0500 (EST) Content-Disposition: inline In-Reply-To: <20121124151127.GA24459@padd.com> X-Eric-Conspiracy: There is no conspiracy User-Agent: Mutt/1.5.21 (2010-09-15) Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Archived-At: Working on my revised patch... Pete Wyckoff : > Nice start. A few other details; I recently did this for git-p4 > (python). >=20 > .gitignore: ignore the auto-generated script, e.g. when > git-foo.py is built into git-foo. Added: 3. If your command is implemented in an interpreted language with a= =20 p-code intermediate form, make sure .gitignore in the main director= y includes a pattern entry that ignores such files. Python .pyc and .pyo files will already be covered. > INSTALL: note language requirements if odd (see python section) Added: 4. If your command has dependency on a particular version, document it in the INSTALL file. =20 > command-list.txt: categorization of commands for git(1) etc. Are the values in the right-hand column documented somewhere? What uses them, and for what purposes. =20 > RelNotes: Junio generally does this. Added: 6. When your patch is merged, remind the maintainer to add somethin= g about it in the RelNotes file. =20 > Also please read Documentation/technical/api-builtin.txt to > see how to add a built-in command. It also has comments that > are identical for both built-in and stand-alone command. =A0Could > be that your text would better go near or with that one, as perhaps > api-command.txt. I think this is a good suggestion and will implement it. If someone can explain the values used in command-list.txt, or (better)= point me to documentation of them, that will enable me to finish the revised = patch. --=20 Eric S. Raymond