path: root/Documentation/technical
AgeCommit message (Collapse)Author
2008-03-03Fix doc typos.Ralf Wildenhues
Signed-off-by: Ralf Wildenhues <> Signed-off-by: Junio C Hamano <>
2008-02-29Merge branch 'maint'Junio C Hamano
* maint: templates/Makefile: don't depend on local umask setting Correct name of diff_flush() in API documentation Start preparing for Conflicts: RelNotes
2008-02-28Correct name of diff_flush() in API documentationDaniel Barkalow
Signed-off-by: Daniel Barkalow <> Signed-off-by: Junio C Hamano <>
2008-02-20Technical documentation of the run-command API.Johannes Sixt
Signed-off-by: Johannes Sixt <> Signed-off-by: Junio C Hamano <>
2008-02-19API documentation for remote.hDaniel Barkalow
Signed-off-by: Daniel Barkalow <> Signed-off-by: Junio C Hamano <>
2008-01-30fix doc typosJim Meyering
Signed-off-by: Jim Meyering <> Signed-off-by: Junio C Hamano <>
2008-01-16close_lock_file(): new function in the lockfile APIBrandon Casey
The lockfile API is a handy way to obtain a file that is cleaned up if you die(). But sometimes you would need this sequence to work: 1. hold_lock_file_for_update() to get a file descriptor for writing; 2. write the contents out, without being able to decide if the results should be committed or rolled back; 3. do something else that makes the decision --- and this "something else" needs the lockfile not to have an open file descriptor for writing (e.g. Windows do not want a open file to be renamed); 4. call commit_lock_file() or rollback_lock_file() as appropriately. This adds close_lock_file() you can call between step 2 and 3 in the above sequence. Signed-off-by: Junio C Hamano <>
2008-01-16Document lockfile APIJunio C Hamano
We have nice set of placeholders, but nobody stepped in to fill the gap in the API documentation, so I am doing it myself. Signed-off-by: Junio C Hamano <>
2008-01-07Documentation: typofixRalf Wildenhues
Signed-off-by: Ralf Wildenhues <> Signed-off-by: Junio C Hamano <>
2007-12-15Start preparing the API documents.Junio C Hamano
Most of them are still stubs, but the procedure to build the HTML documentation, maintaining the index and installing the end product are there. I placed names of people who are likely to know the most about the topic in the stub files, so that volunteers will know whom to ask questions as needed. Signed-off-by: Junio C Hamano <>
2007-12-14Documentation: describe pack idx
Lifted from the log message of c553ca25bd60dc9fd50b8bc7bd329601b81cee66 (pack-objects: learn about pack index version 2). Acked-by: Nicolas Pitre <> Signed-off-by: Junio C Hamano <>
2007-06-07War on whitespaceJunio C Hamano
This uses "git-apply --whitespace=strip" to fix whitespace errors that have crept in to our source files over time. There are a few files that need to have trailing whitespaces (most notably, test vectors). The results still passes the test, and build result in Documentation/ area is unchanged. Signed-off-by: Junio C Hamano <>
2007-03-22Merge branch 'maint'Junio C Hamano
* maint: Documentation/pack-format.txt: Clear up description of types. fix typo in git-am manpage
2007-03-22Documentation/pack-format.txt: Clear up description of types.Peter Eriksen
Signed-off-by: Peter Eriksen <> Signed-off-by: Junio C Hamano <>
2007-03-20Provide some technical documentation for shallow clonesJohannes Schindelin
There has not been any work on the shallow stuff lately, so it is hard to find out what it does, and how. This document describes the ideas as well as the current problems, and can serve as a starting point for shallow people. Signed-off-by: Johannes Schindelin <> Signed-off-by: Junio C Hamano <>
2007-01-01Update send-pack pipeline documentation.Junio C Hamano
The pipeline was much more complex and needed documentation, but now it is trivial and straightforward. Signed-off-by: Junio C Hamano <>
2006-12-29Documentation: illustrate send-pack pipeline.Junio C Hamano
Signed-off-by: Junio C Hamano <>
2006-12-18racy-git: documentation updates.Junio C Hamano
We've removed the workaround for runtime penalty that did not exist in practice some time ago, but the technical paper that proposed that change still said "we probably should do so". Signed-off-by: Junio C Hamano <>
2006-08-16Documentation/technical/racy-git.txtJunio C Hamano
Signed-off-by: Junio C Hamano <>
2006-07-09Assorted typo fixesPavel Roskin
Signed-off-by: Junio C Hamano <>
2006-06-04Documentation: Spelling fixesHorst H. von Brand
Signed-off-by: Horst H. von Brand <> Signed-off-by: Junio C Hamano <>
2006-05-31Improved pack format documentation.Shawn Pearce
While trying to implement a pack reader in Java I was mislead by some facts listed in this documentation as well as found a few details to be missing about the pack header. Signed-off-by: Shawn O. Pearce <> Signed-off-by: Junio C Hamano <>
2006-04-07Add Documentation/technical/pack-format.txtJunio C Hamano
... along with the previous one, pack-heuristics, by popular demand. Signed-off-by: Junio C Hamano <>
2006-04-07Added Packing Heursitics IRC writeup.Jon Loeliger
Signed-off-by: Jon Loeliger <> Signed-off-by: Junio C Hamano <>
2005-12-13Documentation: fix missing links to git(7)Junio C Hamano
Also move pack protocol description to technical/. Signed-off-by: Junio C Hamano <>
2005-09-25[PATCH] Finish documenting trivial merge rulesDaniel Barkalow
Fix missing symbol explanations, a few incorrect cases, and add two-way merge rules. Signed-off-by: Daniel Barkalow <> Signed-off-by: Junio C Hamano <>
2005-09-11[PATCH] Document the trivial merge rules for 3(+more ancestors)-way merges.Daniel Barkalow
Signed-off-by: Daniel Barkalow Signed-off-by: Junio C Hamano <>