git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Where do I stick development documentation?

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Aug 11, 2010, 22:49 UTC
Message-ID
<AANLkTi=dS1DYJ3MB-Du34sVPy8Qw8VNck=Lx54DtSfO0@mail.gmail.com>

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.

Next: Jonathan Nieder
Message 1 of 11 in “Where do I stick development documentation?”
  1. Ævar Arnfjörð BjarmasonAug 11, 2010
  2. Jonathan NiederAug 12, 2010
  3. Ævar Arnfjörð BjarmasonAug 12, 2010
  4. Low-level repository inspection (Re: Where do I stick development documentation?)Jonathan Nieder, Aug 12, 2010
  5. Ævar Arnfjörð BjarmasonAug 12, 2010
  6. Jonathan NiederAug 12, 2010
  7. Michael WittenAug 12, 2010
  8. Ævar Arnfjörð BjarmasonAug 12, 2010
  9. Jonathan NiederAug 12, 2010
  10. Jonathan NiederAug 12, 2010
  11. Ævar Arnfjörð BjarmasonAug 12, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.