path: root/Documentation/Makefile
AgeCommit message (Collapse)Author
2008-02-05man pages are littered with .ft C and othersJonas Fonseca
Jakub Narebski <> wrote Sun, Feb 03, 2008: > Junio C Hamano wrote: > > Jakub Narebski <> writes: > > > > [From] > Julian Phillips: > > Are you using docbook xsl 1.72? There are known problems building the > > manpages with that version. 1.71 works, and 1.73 should work when it get > > released. I was able to solve this problem with this patch, which adds a XSL file used specifically for DOCBOOK_XSL_172=YesPlease and where dots and backslashes are escaped properly so they won't be substituted to the wrong thing further down the "DocBook XSL pipeline". Doing the escaping in the existing callout.xsl breaks v1.70.1. Hopefully v1.73 will end this part of the manpage nightmare. Signed-off-by: Junio C Hamano <>
2008-01-15Add using merge subtree How-ToMiklos Vajna
Signed-off-by: Miklos Vajna <> Signed-off-by: Junio C Hamano <>
2008-01-07Documentation: remove with "make clean"Junio C Hamano
Signed-off-by: Junio C Hamano <>
2008-01-07Documentation/Makefile - honor $DESTDIR for quick-install targetMark Levedahl
Signed-off-by: Mark Levedahl <> Signed-off-by: Junio C Hamano <>
2007-12-22parse-options: Add a gitcli(5) man page.Pierre Habouzit
This page should hold every information about the git ways to parse command lines, and best practices to be used for scripting. Signed-off-by: Pierre Habouzit <>
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-12Documentation: rename git.texi to user-manual.texiJunio C Hamano
Signed-off-by: Junio C Hamano <>
2007-12-10Documentation: add targetJunio C Hamano
Signed-off-by: Junio C Hamano <>
2007-12-10Merge branch 'master' into cc/helpJunio C Hamano
This is to primarily pull in MANPATH tweak and help.txt formatting fix from the master branch.
2007-12-09git-help: add -w|--web option to display html man page in a browser.Christian Couder
Now when using "git help -w cmd", we will try to show the HTML man page "git-cmd.html" in your prefered web browser. To do that "help.c" code will call a new shell script "git-browse-help". This currently works only if the HTML versions of the man page have been installed in $(htmldir) (typically "/usr/share/doc/git-doc"), so new target to do that is added to "Documentation/Makefile". The browser to use can be configured using the "web.browser" config variable. We try to open a new tab in an existing web browser, if possible. The code in "git-browse-help" is heavily stolen from "git-mergetool" by Theodore Y. Ts'o. Thanks. Signed-off-by: Christian Couder <> Signed-off-by: Junio C Hamano <>
2007-12-04Run the specified perl in Documentation/Junio C Hamano
Makefile uses $(PERL_PATH) but Documentation/Makefile uses "perl"; that means the two Makefiles can use two different Perl installations. Teach Documentation/Makefile to use PERL_PATH that is exported from the toplevel Makefile, and give a sane fallback for people who run "make" from Documentation directory. Signed-off-by: Junio C Hamano <>
2007-12-04install-sh from automake does not like -m without delimiting spaceRobert Schiele
The install-sh script as shipped with automake requires a space between the -m switch and its argument. Since this is also the regular way of doing it with other install implementations this change inserts the missing space in all makefiles. Signed-off-by: Robert Schiele <> Signed-off-by: Junio C Hamano <>
2007-12-02Consolidate command list to one.Junio C Hamano
The categorized list of commands in git(7) and the list of common commands in "git help" output were maintained separately, which was insane. This consolidates them to a single command-list.txt file. Signed-off-by: Junio C Hamano <>
2007-11-14Documentation: Fix man page breakage with DocBook XSL v1.72Jonas Fonseca
From version 1.72 it will replace all dots in roff requests with U+2302 ("house" character), and add escaping in output for all instances of dot that are not in roff requests. This caused the ".ft" hack forcing monospace font in listingblocks to end up as "\&.ft" and being visible in the resulting man page. The fix adds a DOCBOOK_XSL_172 build variable that will disable the hack. To allow this variable to be defined in config.mak it also moves build variable handling below the inclusion of config.mak. Signed-off-by: Jonas Fonseca <> Signed-off-by: Junio C Hamano <>
2007-09-16documentation: replace Discussion section by link to user-manual chapterJ. Bruce Fields
The "Discussion" section has a lot of useful information, but is a little wordy, especially for an already-long man page, and is designed for an audience more of potential git hackers than users, which probably doesn't make as much sense as git matures. Also, I (perhaps foolishly) forked a version in the user manual, which has been significantly rewritten in an attempt to address some of the above problems. So, remove this section and replace it by a (very terse) summary of the original material--my attempt at the World's Shortest Git Overview--and a reference to the appropriate chapter of the user manual. It's unfortunate to remove something that's been in this place for a long time, as some people may still depend on finding it there. But I think we'll want to do this some day anyway. Cc: Andreas Ericsson <> Signed-off-by: J. Bruce Fields <>
2007-08-11Documentation/Makefile: remove cmd-list.made before redirecting to it.David Kastrup
If cmd-list.made has been created by a previous run as root, output redirection to it will fail. So remove it before regeneration. Signed-off-by: David Kastrup <> Signed-off-by: Junio C Hamano <>
2007-08-11Add support for an info version of the user manualDavid Kastrup
These patches use docbook2x in order to create an info version of the git user manual. No existing Makefile targets (including "all") are touched, so you need to explicitly say make info sudo make install-info to get created and installed. If the info target directory does not already contain a "dir" file, no directory entry is created. This facilitates $(DESTDIR)-based installations. The same could be achieved with sudo make INSTALL_INFO=: install-info explicitly. perl is used for patching up sub-par file and directory information in the Texinfo file. It would be cleaner to place the respective info straight into user-manual.txt or the conversion configurations, but I find myself unable to find out how to do this with Asciidoc/Texinfo. Signed-off-by: David Kastrup <>
2007-08-02When generating manpages, delete outdated targets first.David Kastrup
This makes "make doc" work even if you made "sudo make doc" previously by mistake. Apparently an oversight: the other targets did this already. Signed-off-by: David Kastrup <> Signed-off-by: Junio C Hamano <>
2007-07-24Mark user-manual as UTF-8Junio C Hamano
There have been several complaints against's user-manual page. The document is generated in ISO-8859-1 by the xsltproc toolchain (I suspect this is because released docbook.xsl we use has xsl:output element that says the output is ISO-8859-1) but server delivers it with "charset=UTF-8", and all h*ll breaks loose. This attempts to force UTF-8 on the generating end. Signed-off-by: Junio C Hamano <>
2007-07-15Use $(RM) in Makefiles instead of 'rm -f'Emil Medve
Signed-off-by: Emil Medve <> Signed-off-by: Junio C Hamano <>
2007-06-20Change default man page path to /usr/share/manIsmail Dönmez
According to FHS, default man page path is $prefix/share/man. Signed-off-by: Ismail Donmez <> Signed-off-by: Junio C Hamano <>
2007-06-16Merge branch 'lh/submodule'Junio C Hamano
* lh/submodule: gitmodules(5): remove leading period from synopsis Add gitmodules(5) git-submodule: give submodules proper names Rename sections from "module" to "submodule" in .gitmodules git-submodule: remember to checkout after clone t7400: barf if git-submodule removes or replaces a file
2007-06-16Documentation: adjust to AsciiDoc 8Junio C Hamano
It turns out that the attribute definition we have had for a long time to hide "^" character from AsciiDoc 7 was not honored by AsciiDoc 8 even under "-a asciidoc7compatible" mode. There is a similar breakage with the "compatible" mode with + characters. The double colon at the end of definition list term needs to be attached to the term, without a whitespace. After this minimum fixups, AsciiDoc 8 (I used 8.2.1 on Debian) with compatibility mode seems to produce reasonably good results. Signed-off-by: Junio C Hamano <>
2007-06-12Add gitmodules(5)Lars Hjemli
This adds documentation for the .gitmodules file. Signed-off-by: Lars Hjemli <> Signed-off-by: Junio C Hamano <>
2007-06-02Create a new manpage for the gitignore format, and reference it elsewhereJosh Triplett
Only git-ls-files(1) describes the gitignore format in detail, and it does so with reference to git-ls-files options. Most users don't use the plumbing command git-ls-files directly, and shouldn't have to look in its manpage for information on the gitignore format. Create a new manpage gitignore(5) (Documentation/gitignore.txt), and factor out the gitignore documentation into that file, changing it to refer to .gitignore and $GIT_DIR/info/exclude as used by porcelain commands. Reference gitignore(5) from other relevant manpages and documentation. Remove now-redundant information on exclude patterns from git-ls-files(1), leaving only information on how git-ls-files options specify exclude patterns and what precedence they have. Signed-off-by: Josh Triplett <> Signed-off-by: Junio C Hamano <>
2007-06-02Documentation: robustify asciidoc GIT_VERSION replacementJeff King
Instead of using sed on the resulting file, we now have a git_version asciidoc attribute. This means that we don't pipe the output of asciidoc, which means we can detect build failures. Problem reported by Scott Lamb, solution suggested by Jonas Fonseca. Signed-off-by: Jeff King <> Signed-off-by: Junio C Hamano <>
2007-04-22Documentation/Makefile: fix section (5) installationJunio C Hamano
Signed-off-by: Junio C Hamano <>
2007-04-20Document gitattributes(5)Junio C Hamano
Signed-off-by: Junio C Hamano <>
2007-04-20Documentation: support manual section (5) - file formats.Junio C Hamano
Signed-off-by: Junio C Hamano <>
2007-04-07Merge branch 'maint'Junio C Hamano
* maint: Documentation: tighten dependency for git.{html,txt} Makefile: iconv() on Darwin has the old interface portability issue using /usr/bin/stat small language nit usermanual.txt: some capitalization nits Make builtin-branch.c handle the git config file rename_ref(): only print a warning when config-file update fails Distinguish branches by more than case in tests. Avoid composing too long "References" header. cvsimport: Improve formating consistency cvsimport: Reorder options in documentation for better understanding cvsimport: Improve usage error reporting cvsimport: Improve documentation of CVSROOT and CVS module determination cvsimport: sync usage lines with existing options Conflicts: Documentation/Makefile
2007-04-07Documentation: tighten dependency for git.{html,txt}Junio C Hamano
Every time _any_ documentation page changed, cmds-*.txt files were regenerated, which caused git.{html,txt} to be remade. Try not to update cmds-*.txt files if their new contents match the old ones. Signed-off-by: Junio C Hamano <>
2007-03-28Documentation: Replace @@GIT_VERSION@@ in documentationFrank Lichtenheld
Include GIT-VERSION-FILE and replace @@GIT_VERSION@@ in the HTML and XML asciidoc output. The documentation doesn't depend on GIT-VERSION-FILE so it will not be automatically rebuild if nothing else changed. [jc: fixing the case for interrupted build] Signed-off-by: Frank Lichtenheld <> Signed-off-by: Junio C Hamano <>
2007-03-19glossary: stop generating automaticallyJ. Bruce Fields
The script sorts the glossary, checks for duplicates, and automatically adds cross-references. But it's not so hard to do all that by hand, and sometimes the automatic cross-references are a little wrong; so let's run the script one last time and check in its output. Note: to make the output fit better into the user manual I also deleted the acknowledgements at the end, which was maybe a little rude; feel free to object and I can find a different solution. Cc: Johannes Schindelin <> Signed-off-by: "J. Bruce Fields" <>
2007-03-19user-manual: run xsltproc without --nonet optionJ. Bruce Fields
The --nonet option prevents xsltproc from going to the network to find anything. But it always tries to find them locally first, so for a user with the necessary docbook stylesheets installed the build will work just fine without xsltproc attempting to use the network; all --nonet does is make it fail rather than falling back on that. That doesn't seem particularly helpful. Signed-off-by: "J. Bruce Fields" <>
2007-03-05user-manual: ensure generated manual references stylesheetJ. Bruce Fields
The generated user manual is rather hard to read thanks to the lack of the css that's supposed to be included from docbook-xsl.css. I'm totally ignorant of the toolchain; grubbing through xmlto and related scripts, the easiest way I could find to ensure that the generated html links to the stylesheet is by calling xsltproc directly. Maybe there's some better way. Signed-off-by: "J. Bruce Fields" <> Signed-off-by: Junio C Hamano <>
2007-02-28Include config.mak in doc/MakefileUwe Kleine-König
config.mak.autogen is already there. Without this change it is not possible to override mandir in config.mak. Signed-off-by: Uwe Kleine-König <> Signed-off-by: Junio C Hamano <>
2007-02-13Add release notes to the distribution.Junio C Hamano
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 Signed-off-by: Junio C Hamano <>
2007-02-11Make it easier to override path to asciidoc commandDotan Barak
Allow setting the path of asciidoc in only one place when creating the documentation. Signed-off-by: Dotan Barak <> Signed-off-by: Junio C Hamano <>
2007-01-31Do not use hardcoded path to xhmtl.xsl to generate user's manualJunio C Hamano
It does not seem to need it either and gives an error on FC5 I use at to cut documentation tarballs, so remove it in the meantime. Signed-off-by: Junio C Hamano <>
2007-01-31Merge branch 'master' of git:// C Hamano
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.
2007-01-20Documentation/git.txt: command re-classificationJunio C Hamano
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 <>
2007-01-19Documentation: generated cmds-*.txt does not depend on git.txtJunio C Hamano
Pointed out by Santi. Signed-off-by: Junio C Hamano <>
2007-01-19Documentation: Generate command lists.Junio C Hamano
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 <>
2007-01-17sanitize content of README fileNicolas Pitre
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 <> Signed-off-by: Junio C Hamano <>
2007-01-08Documentation: add git user's manualJ. Bruce Fields
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" <>
2006-12-23Makefile: add quick-install-doc for installing pre-built manpagesEric Wong
This adds and uses the 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 <> Signed-off-by: Junio C Hamano <>
2006-12-11no need to install manpages as executableChris Wright
No need to install manpages as executable. Noticed by Ville Skytt,Ad(B. Signed-off-by: Chris Wright <> Signed-off-by: Junio C Hamano <>
2006-09-01Documentation: Fix howto/revert-branch-rebase.html generationSergey Vlasov
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 <> Signed-off-by: Junio C Hamano <>
2006-08-31Include config.mak.autogen in the doc MakefileJonas Fonseca
... to install documentation relative to the path set with configure's --prefix option. Signed-off-by: Jonas Fonseca <> Signed-off-by: Junio C Hamano <>
2006-07-26Merge branch 'pb/configure'Junio C Hamano
* pb/configure: Rename man1 and man7 variables to man1dir and man7dir Allow INSTALL, bindir, mandir to be set in main Makefile