git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Subject: Where do I stick development documentation?
Date: Wed, 11 Aug 2010 22:49:14 +0000	[thread overview]
Message-ID: <AANLkTi=dS1DYJ3MB-Du34sVPy8Qw8VNck=Lx54DtSfO0@mail.gmail.com> (raw)

There's some documentation aimed at developing that I'd like to see /
write in Git at some point.

Developing:

   * How to work with Gettext

   * How to write portable code, i.e. constructs to avoid in C / shell
     script etc (these keep coming up).

Translators:

   * How to deal with gettext / submit po files / keep them up to date
     etc.

   * Core git concepts (that need to be translated), maybe I could
     adopt the gitglossary to this task, but it'd need to be a bit
     more structured, i.e. describe core data concepts first, then
     some other terms.

     Actually, on that point, do we have documentation that describes
     git's data model in one place? I.e. everything from blobs to
     trees, how raw commit objects etc. look. Something like "Git for
     computer scientists".

The problem is that I don't know where to put these. I like idea of
them being man pages, maybe gitdev-gettext.txt,
gitdev-code-portable.txt or something like that?

The only thing like that currently it
Documentation/{SubmittingPatches,CodingGuidelines} and t/README.

             reply	other threads:[~2010-08-11 22:49 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-08-11 22:49 Ævar Arnfjörð Bjarmason [this message]
2010-08-12  2:39 ` Where do I stick development documentation? Jonathan Nieder
2010-08-12  3:11   ` Ævar Arnfjörð Bjarmason
2010-08-12  3:17     ` Low-level repository inspection (Re: Where do I stick development documentation?) Jonathan Nieder
2010-08-12  3:40       ` Ævar Arnfjörð Bjarmason
2010-08-12  3:57         ` Jonathan Nieder
2010-08-12 20:00     ` Where do I stick development documentation? Michael Witten
2010-08-12 20:08       ` Ævar Arnfjörð Bjarmason
2010-08-12 20:29         ` Jonathan Nieder
2010-08-12 20:33     ` Jonathan Nieder
2010-08-12 20:37       ` Ævar Arnfjörð Bjarmason

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='AANLkTi=dS1DYJ3MB-Du34sVPy8Qw8VNck=Lx54DtSfO0@mail.gmail.com' \
    --to=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    /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).