aboutsummaryrefslogtreecommitdiff
path: root/Documentation/technical
Commit message (Collapse)AuthorAge
* Add description of OFS_DELTA to the pack format descriptionPeter Eriksen2008-04-06
| | | | | | Signed-off-by: Peter Eriksen <s022018@student.dtu.dk> Acked-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* run-command: Redirect stderr to a pipe before redirecting stdout to stderrChristian Couder2008-03-05
| | | | | | | | | | | | | | | | | | | | | | | | | | With this patch, in the 'start_command' function after forking we now take care of stderr in the child process before stdout. This way if 'start_command' is called with a 'child_process' argument like this: .err = -1; .stdout_to_stderr = 1; then stderr will be redirected to a pipe before stdout is redirected to stderr. So we can now get the process' stdout from the pipe (as well as its stderr). Earlier such a call would have redirected stdout to stderr before stderr was itself redirected, and therefore stdout would not have followed stderr, which would not have been very useful anyway. Update documentation in 'api-run-command.txt' accordingly. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Acked-by: Johannes Sixt <johannes.sixt@telecom.at> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Fix doc typos.Ralf Wildenhues2008-03-02
| | | | | Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Merge branch 'maint'Junio C Hamano2008-02-29
|\ | | | | | | | | | | | | | | | | | | | | * maint: templates/Makefile: don't depend on local umask setting Correct name of diff_flush() in API documentation Start preparing for 1.5.4.4 Conflicts: RelNotes
| * Correct name of diff_flush() in API documentationDaniel Barkalow2008-02-28
| | | | | | | | | | Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | Technical documentation of the run-command API.Johannes Sixt2008-02-19
| | | | | | | | | | Signed-off-by: Johannes Sixt <johannes.sixt@telecom.at> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* | API documentation for remote.hDaniel Barkalow2008-02-19
|/ | | | | Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* fix doc typosJim Meyering2008-01-29
| | | | | Signed-off-by: Jim Meyering <meyering@redhat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* close_lock_file(): new function in the lockfile APIBrandon Casey2008-01-16
| | | | | | | | | | | | | | | | | | | | | | | | | 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 <gitster@pobox.com>
* Document lockfile APIJunio C Hamano2008-01-16
| | | | | | | 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 <gitster@pobox.com>
* Documentation: typofixRalf Wildenhues2008-01-07
| | | | | Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* Start preparing the API documents.Junio C Hamano2007-12-14
| | | | | | | | | | | | 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 <gitster@pobox.com>
* Documentation: describe pack idx v2linux@horizon.com2007-12-14
| | | | | | | | Lifted from the log message of c553ca25bd60dc9fd50b8bc7bd329601b81cee66 (pack-objects: learn about pack index version 2). Acked-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
* War on whitespaceJunio C Hamano2007-06-07
| | | | | | | | | 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 <gitster@pobox.com>
* Merge branch 'maint'Junio C Hamano2007-03-22
|\ | | | | | | | | | | * maint: Documentation/pack-format.txt: Clear up description of types. fix typo in git-am manpage
| * Documentation/pack-format.txt: Clear up description of types.Peter Eriksen2007-03-22
| | | | | | | | | | Signed-off-by: Peter Eriksen <s022018@student.dtu.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Provide some technical documentation for shallow clonesJohannes Schindelin2007-03-19
|/ | | | | | | | | | 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 <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Update send-pack pipeline documentation.Junio C Hamano2007-01-01
| | | | | | | The pipeline was much more complex and needed documentation, but now it is trivial and straightforward. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: illustrate send-pack pipeline.Junio C Hamano2006-12-29
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* racy-git: documentation updates.Junio C Hamano2006-12-18
| | | | | | | | 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 <junkio@cox.net>
* Documentation/technical/racy-git.txtJunio C Hamano2006-08-15
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Assorted typo fixesPavel Roskin2006-07-09
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: Spelling fixesHorst H. von Brand2006-06-03
| | | | | Signed-off-by: Horst H. von Brand <vonbrand@inf.utfsm.cl> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Improved pack format documentation.Shawn Pearce2006-05-30
| | | | | | | | | 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 <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Add Documentation/technical/pack-format.txtJunio C Hamano2006-04-07
| | | | | | | ... along with the previous one, pack-heuristics, by popular demand. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Added Packing Heursitics IRC writeup.Jon Loeliger2006-04-07
| | | | | Signed-off-by: Jon Loeliger <jdl@jdl.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: fix missing links to git(7)Junio C Hamano2005-12-12
| | | | | | Also move pack protocol description to technical/. Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Finish documenting trivial merge rulesDaniel Barkalow2005-09-24
| | | | | | | | Fix missing symbol explanations, a few incorrect cases, and add two-way merge rules. Signed-off-by: Daniel Barkalow <barkalow@iabervon.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Document the trivial merge rules for 3(+more ancestors)-way merges.Daniel Barkalow2005-09-10
Signed-off-by: Daniel Barkalow Signed-off-by: Junio C Hamano <junkio@cox.net>