aboutsummaryrefslogtreecommitdiff
path: root/Documentation/Makefile
Commit message (Collapse)AuthorAge
* Documentation/Makefile: fix section (5) installationJunio C Hamano2007-04-22
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Document gitattributes(5)Junio C Hamano2007-04-19
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: support manual section (5) - file formats.Junio C Hamano2007-04-19
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Merge branch 'maint'Junio C Hamano2007-04-07
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * maint: Documentation: tighten dependency for git.{html,txt} Makefile: iconv() on Darwin has the old interface t5300-pack-object.sh: portability issue using /usr/bin/stat t3200-branch.sh: 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
| * Documentation: tighten dependency for git.{html,txt}Junio C Hamano2007-04-06
| | | | | | | | | | | | | | | | | | 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 <junkio@cox.net>
* | Documentation: Replace @@GIT_VERSION@@ in documentationFrank Lichtenheld2007-03-28
|/ | | | | | | | | | | | 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 <frank@lichtenheld.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* glossary: stop generating automaticallyJ. Bruce Fields2007-03-18
| | | | | | | | | | | | | | | | The sort_glossary.pl 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 <Johannes.Schindelin@gmx.de> Signed-off-by: "J. Bruce Fields" <bfields@citi.umich.edu>
* user-manual: run xsltproc without --nonet optionJ. Bruce Fields2007-03-18
| | | | | | | | | | | 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" <bfields@citi.umich.edu>
* user-manual: ensure generated manual references stylesheetJ. Bruce Fields2007-03-04
| | | | | | | | | | | | | 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" <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Include config.mak in doc/MakefileUwe Kleine-König2007-02-28
| | | | | | | | 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 <ukleinek@informatik.uni-freiburg.de> Signed-off-by: Junio C Hamano <junkio@cox.net>
* Add release notes to the distribution.Junio C Hamano2007-02-13
| | | | | | | | 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-11
| | | | | | | | 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-31
| | | | | | | | 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-31
|\ | | | | | | | | | | | | | | 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-07
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-19
| | | | | | | | | | | | | | | | | | | | | | | | 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-19
| | | | | | | | | | | | Pointed out by Santi. Signed-off-by: Junio C Hamano <junkio@cox.net>
* | Documentation: Generate command lists.Junio C Hamano2007-01-18
| | | | | | | | | | | | | | | | 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-17
|/ | | | | | | | | | | | 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-23
| | | | | | | | | | | | | | 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-11
| | | | | | | 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-01
| | | | | | | | | 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-31
| | | | | | | | ... 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-26
|\ | | | | | | | | | | * 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-29
| | | | | | | | | | | | | | | | | | 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-29
| | | | | | | | | | | | | | | | | | | | | | | | 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-14
|/ | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation/Makefile: remove extra /Martin Waitz2006-05-25
| | | | | | | | | | | | 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-21
| | | | | | | | 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-28
| | | | | | | | 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-05
| | | | | | | | | 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-24
| | | | | | | | 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-22
| | | | | | | | 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-09
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Documentation: fix dependency generation.Junio C Hamano2005-11-08
| | | | | | | 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-07
| | | | | | | | | 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-06
| | | | | | | | | | | | | 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-04
| | | | | | | ... 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-08
| | | | | | | 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-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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-21
|\
| * Fix documentation dependency.Junio C Hamano2005-09-21
| | | | | | | | | | | | | | | | | | | | | | 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-20
|/ | | | | | | | | | | | 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-15
| | | | | | | | | ... 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-02
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Add repository-layout document.Junio C Hamano2005-09-01
| | | | | | ... 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-30
| | | | | | | 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-29
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* Allow asciidoc formatted documentation in howto/Junio C Hamano2005-08-29
| | | | Signed-off-by: Junio C Hamano <junkio@cox.net>
* [PATCH] git bugfixes and cleanups, mainly Debian thingsTommi Virtanen2005-08-26
| | | | | | | 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>