From: "Eric S. Raymond" <esr@thyrsus.com>
To: Pete Wyckoff <pw@padd.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Add documentation on how to integrate commands.
Date: Sat, 24 Nov 2012 19:06:05 -0500 [thread overview]
Message-ID: <20121125000605.GA22548@thyrsus.com> (raw)
In-Reply-To: <20121124151127.GA24459@padd.com>
Working on my revised patch...
Pete Wyckoff <pw@padd.com>:
> Nice start. A few other details; I recently did this for git-p4
> (python).
>
> .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
p-code intermediate form, make sure .gitignore in the main directory
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.
> 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.
> RelNotes: Junio generally does this.
Added:
6. When your patch is merged, remind the maintainer to add something
about it in the RelNotes file.
> 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. Could
> 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.
--
<a href="http://www.catb.org/~esr/">Eric S. Raymond</a>
next prev parent reply other threads:[~2012-11-25 0:07 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-11-24 12:23 [PATCH] Add documentation on how to integrate commands Eric S. Raymond
2012-11-24 15:11 ` Pete Wyckoff
2012-11-24 15:23 ` Eric S. Raymond
2012-11-25 0:06 ` Eric S. Raymond [this message]
2012-11-25 7:12 ` Michael Haggerty
2012-11-25 8:29 ` Eric S. Raymond
2012-11-26 4:47 ` Junio C Hamano
2012-11-26 5:25 ` Eric S. Raymond
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20121125000605.GA22548@thyrsus.com \
--to=esr@thyrsus.com \
--cc=git@vger.kernel.org \
--cc=pw@padd.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).