summaryrefslogtreecommitdiff
path: root/Documentation/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* Add release notes to the distribution.Junio C Hamano2007-02-131-1/+2
| | | | | | | | This also adds a hook in the Makefile I can use to automatically include pointers to documentation for older releases when updating the pages at http://kernel.org/pub/software/scm/git/docs/. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Make it easier to override path to asciidoc commandDotan Barak2007-02-111-6/+7
| | | | | | | | Allow setting the path of asciidoc in only one place when creating the documentation. Signed-off-by: Dotan Barak <dotanb@dev.mellanox.co.il> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Do not use hardcoded path to xhmtl.xsl to generate user's manualJunio C Hamano2007-01-311-1/+1
| | | | | | | | It does not seem to need it either and gives an error on FC5 I use at kernel.org to cut documentation tarballs, so remove it in the meantime. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'master' of git://linux-nfs.org/~bfields/gitJunio C Hamano2007-01-311-1/+7
|\ | | | | | | | | | | | | | | This is in the hope of giving JBF's user-manual wider exposure. I am not very happy with trailing whitespaces in the new document, but let's not worry too much about the formatting issues for now, but concentrate more on the structure and the contents.
| * Documentation: add git user's manualJ. Bruce Fields2007-01-071-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The goals are: - Readable from beginning to end in order without having read any other git documentation beforehand. - Helpful section names and cross-references, so it's not too hard to skip around some if you need to. - Organized to allow it to grow much larger (unlike the tutorials) It's more liesurely than tutorial.txt, but tries to stay focused on practical how-to stuff. It adds a discussion of how to resolve merge conflicts, and partial instructions on setting up and dealing with a public repository. I've lifted a little bit from "branching and merging" (e.g., some of the discussion of history diagrams), and could probably steal more if that's OK. (Similarly anyone should of course feel free to reuse bits of this if any parts seem more useful than the whole.) There's a lot of detail on managing branches and using git-fetch, just because those are essential even to people needing read-only access (e.g., kernel testers). I think those sections will be much shorter once the new "git remote" command and the disconnected checkouts are taken into account. I do feel bad about adding yet another piece of documentation, but I we need something that goes through all the basics in a logical order, and I wasn't seeing how to grow the tutorials into that. Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* | Documentation/git.txt: command re-classificationJunio C Hamano2007-01-191-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | This adds two new classes (pure-helpers and "Interacting with Others") to the command list in the main manual page. The latter class is primarily about foreign SCM interface and is placed before low-level (plumbing) commands. Also it promotes a handful commands to mainporcelain category while demoting some others. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Documentation: generated cmds-*.txt does not depend on git.txtJunio C Hamano2007-01-191-1/+1
| | | | | | | | | | | | Pointed out by Santi. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Documentation: Generate command lists.Junio C Hamano2007-01-181-1/+11
| | | | | | | | | | | | | | | | This moves the source of the list of commands and categorization to the end of Documentation/cmd-list.perl, so that re-categorization and re-ordering would become easier to manage. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | sanitize content of README fileNicolas Pitre2007-01-171-7/+2
|/ | | | | | | | | | | | Current README content is way too esoteric for someone looking at GIT for the first time. Instead it should provide a quick summary of what GIT is with a few pointers to other resources. The bulk of the previous README content is moved to Documentation/core-intro.txt. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Makefile: add quick-install-doc for installing pre-built manpagesEric Wong2006-12-231-0/+4
| | | | | | | | | | | | | | This adds and uses the install-doc-quick.sh file to Documentation/, which is usable for people who track either the 'html' or 'man' heads in Junio's repository (prefixed with 'origin/' if cloned locally). You may override this by specifying DOC_REF in the make environment or in config.mak. GZ may also be set in the environment (or config.mak) if you wish to gzip the documentation after installing it. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* no need to install manpages as executableChris Wright2006-12-111-2/+2
| | | | | | | No need to install manpages as executable. Noticed by Ville Skytt,Ad(B. Signed-off-by: Chris Wright <chrisw@sous-sol.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: Fix howto/revert-branch-rebase.html generationSergey Vlasov2006-09-011-1/+1
| | | | | | | | | The rule for howto/*.html used "$?", which expands to the list of all newer prerequisites, including asciidoc.conf added by another rule. "$<" should be used instead. Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Include config.mak.autogen in the doc MakefileJonas Fonseca2006-08-311-0/+2
| | | | | | | | ... to install documentation relative to the path set with configure's --prefix option. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'pb/configure'Junio C Hamano2006-07-261-7/+7
|\ | | | | | | | | | | * pb/configure: Rename man1 and man7 variables to man1dir and man7dir Allow INSTALL, bindir, mandir to be set in main Makefile
| * Rename man1 and man7 variables to man1dir and man7dirJakub Narebski2006-06-291-5/+5
| | | | | | | | | | | | | | | | | | This patch renames man1 and man7 variables to man1dir and man7dir, according to "Makefile Conventions: Variables for Installation Directories" in make.info of GNU Make. Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
| * Allow INSTALL, bindir, mandir to be set in main MakefileJakub Narebski2006-06-291-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Makefiles in subdirectories now use existing value of INSTALL, bindir, mandir if it is set, allowing those to be set in main Makefile or in included config.mak. Main Makefile exports variables which it sets. Accidentally it renames bin to bindir in Documentation/Makefile (should be bindir from start, but is unused, perhaps to be removed). Signed-off-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Documentation/Makefile: product depends on asciidoc.confJunio C Hamano2006-07-141-0/+1
|/ | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation/Makefile: remove extra /Martin Waitz2006-05-251-3/+3
| | | | | | | | | | | | As both DESTDIR and the prefix are supposed to be absolute pathnames they can simply be concatenated without an extra / (like in the main Makefile). The extra slash may even break installation on Windows. [jc: adjusted an earlier workaround for this problem in the dist-doc target in the main Makefile as well. ] Signed-off-by: Martin Waitz <tali@admingilde.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* tutorial: add discussion of index file, object databaseJ. Bruce Fields2006-05-211-0/+1
| | | | | | | | Add a sequel to tutorial.txt which discusses the index file and the object database. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Properly render asciidoc "callouts" in git man pages.Sean Estabrooks2006-04-281-1/+1
| | | | | | | | Adds an xsl fragment to render docbook callouts when converting to man page format. Update the Makefile to have "xmlto" use it when generating man pages. Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca>
* Documentation/Makefile: Some `git-*.txt' files aren't manpages.Mark Wooding2006-03-051-1/+5
| | | | | | | | | In particular, git-tools.txt isn't a manpage, and my Asciidoc gets upset by it. The simplest fix is to Remove articles from the list of manpages the Makefile. Signed-off-by: Mark Wooding <mdw@distorted.org.uk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Don't include ../README in git.txt - make a local copyPavel Roskin2006-01-241-3/+6
| | | | | | | | asciidoc 7.0.4 and newer considers such includes from parent directory unsafe. Signed-off-by: Pavel Roskin <proski@gnu.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: finishing touches to the new tutorial.Junio C Hamano2006-01-221-0/+1
| | | | | | | | We forgot to update the primary link from git.html leading to the tutorial, and also forgot to build and install the renamed core-tutorial document. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Everyday GIT with 20 commandsJunio C Hamano2005-12-091-0/+1
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: fix dependency generation.Junio C Hamano2005-11-081-2/+1
| | | | | | | The previous rule misses the case where git.txt or tutorial.txt includes new files. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Fix documentation dependency generation.Junio C Hamano2005-11-071-9/+7
| | | | | | | | | Documentation/Makefile spent a lot of time to generate include dependencies, which was quite noticeable especially during "make clean". Rewrite it to generate just a single dependency file. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Refactored merge options into separate merge-options.txt.Jon Loeliger2005-11-061-10/+13
| | | | | | | | | | | | | Refactored fetch options into separate fetch-options.txt. Made git-merge use merge-options. Made git-fetch use fetch-options. Made git-pull use merge-options and fetch-options. Added --help option to git-pull and git-format-patch scripts. Rewrote Documentation/Makefile to dynamically determine include dependencies. Signed-off-by: Jon Loeliger <jdl@freescale.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: -merge and -pull: describe merge strategies.Junio C Hamano2005-11-041-1/+6
| | | | | | | ... and give a couple of examples of running 'git pull' against local repository. Signed-off-by: Junio C Hamano <junkio@cox.net>
* make $prefix available for sub-makefilesKai Ruemmler2005-10-081-2/+2
| | | | | | | exports $prefix and makes Documentation/Makefile following it also. Signed-off-by: Kai Ruemmler <kai.ruemmler@gmx.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Random documentation fixesJonas Fonseca2005-10-031-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | The fixes focuses on improving the HTML output. Most noteworthy: - Fix the Makefile to also make various *.html files depend on included files. - Consistently use 'NOTE: ...' instead of '[ ... ]' for additional info. - Fix ending '::' for description lists in OPTION section etc. - Fix paragraphs in description lists ending up as preformated text. - Always use listingblocks (preformatted text wrapped in lines with -----) for examples that span empty lines, so they are put in only one HTML block. - Use '1.' instead of '(1)' for numbered lists. - Fix linking to other GIT docs. - git-rev-list.txt: put option descriptions in an OPTION section. Signed-off-by: Jonas Fonseca <fonseca@diku.dk> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'fixes'Junio C Hamano2005-09-211-3/+5
|\
| * Fix documentation dependency.Junio C Hamano2005-09-211-3/+5
| | | | | | | | | | | | | | | | | | | | | | Randal L. Schwartz noticed that 'make install' does not rebuild what is installed. Make the 'install' rule depend on 'man'. I noticed also 'touch' of the source files were used to express include dependencies, which is a no-no. Rewrite it to do dependencies properly, and add missing include dependencies while we are at it. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | [PATCH] Documentation: Add asciidoc.conf file and gitlink: macroSergey Vlasov2005-09-201-2/+2
|/ | | | | | | | | | | | Introduce an asciidoc.conf file with the purpose of adding a gitlink: macro which will improve the manpage output. Original cogito patch by Jonas Fonseca <fonseca@diku.dk>; asciidoc.conf from that patch was further enhanced to use the proper DocBook tag <citerefentry> for references to man pages. Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Use '-d' as the first flag to 'install'Peter Eriksen2005-09-151-1/+1
| | | | | | | | | ... in order to please Solaris 'install'. GNU install is not harmed with this. [jc: Documentation/Makefile also fixed.] Signed-off-by: Junio C Hamano <junkio@cox.net>
* Document hooks.Junio C Hamano2005-09-021-0/+1
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Add repository-layout document.Junio C Hamano2005-09-011-1/+5
| | | | | | ... and link to it from both the main index and the tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentaion updates.Junio C Hamano2005-08-301-9/+10
| | | | | | | Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <junkio@cox.net> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit)
* Make sure howto/*.html is built as well.Junio C Hamano2005-08-291-2/+2
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Allow asciidoc formatted documentation in howto/Junio C Hamano2005-08-291-1/+8
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] git bugfixes and cleanups, mainly Debian thingsTommi Virtanen2005-08-261-1/+1
| | | | | | | Generate docs for gitk. Install them in the right deb package. Signed-off-by: Tommi Virtanen <tv@debian.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Don't forget to build the howto-index file.Junio C Hamano2005-08-251-0/+1
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Link howto documents from the main git.txt documentation.Junio C Hamano2005-08-251-1/+14
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Tutorial updates.Junio C Hamano2005-08-231-2/+5
| | | | | | | | | | | | | | - Use "working tree", "object name", "repository" as the canonical term consistenly. - Start formatting tutorial with asciidoc. - Mention shared repository style of cooperation. - Update with some usability enhancements recently made, such as the "-m" flag to the "git commit" command. Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Add Makefile target glossary.htmlJohannes Schindelin2005-08-181-1/+6
| | | | | | | | This also includes a script which does the sorting, and introduces hyperlinks for every described term. Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation updates.Junio C Hamano2005-08-141-0/+1
| | | | | | | | Linus brought up that documentation for many commands have incorrect attribution. I started counting lines again, but ended up adding a handful of missing manual pages. Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] Use $DESTDIR instead of $destPetr Baudis2005-08-121-3/+4
| | | | | | | | $DESTDIR is more usual during the build than $dest and is what is usually used in the makefiles, so let's use it too. Signed-off-by: Petr Baudis <pasky@ucw.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Fix up "make doc"Linus Torvalds2005-07-151-1/+1
| | | | | Fix 'git-var.txt' and use "-b xhtml11" instead of "-b css-embedded" to make asciidoc 7.0.1 happy.
* [PATCH] Add doc and install-doc targets to the MakefileEric W. Biederman2005-07-151-0/+13
| | | | | | | | This makes it straightforward for people wanting to build and install the git man pages and the rest of the documentation to do so. Signed-off-by: Eric W. Biederman <ebiederm@xmission.com> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] Clean up diff option descriptions.Junio C Hamano2005-07-131-1/+1
| | | | | | | | I got tired of maintaining almost duplicated descriptions in diff-* brothers, both in usage string and documentation. Signed-off-by: Junio C Hamano <junkio@cox.net> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
* [PATCH] Docs - Makefile updateDavid Greaves2005-05-221-7/+21
| | | | | | | | A Makefile that works just fine when the 6 character patch is applied to asciidoc Signed-off-by: David Greaves <david@dgreaves.com> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
View Lorry Controller Status