mirrors/git - Incest Forge: Beyond sex. We incest.

mirrors/git

mirror of https://github.com/git/git.git synced 2024-11-12 20:23:02 +01:00

161 lines

3.9 KiB

Makefile

Raw Normal View History

Documentation/Makefile: Some `git-*.txt' files aren't manpages. 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> 2006-03-05 10:36:33 +01:00			`MAN1_TXT= \`
			`$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \`
			`$(wildcard git-*.txt)) \`
			`gitk.txt`
Add gitmodules(5) This adds documentation for the .gitmodules file. Signed-off-by: Lars Hjemli <hjemli@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2007-06-12 09:05:21 +02:00			`MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt`
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00			`MAN7_TXT=git.txt`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT))`
Documentaion updates. Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <junkio@cox.net> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit) 2005-08-30 22:51:01 +02:00
Add repository-layout document. ... and link to it from both the main index and the tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-09-02 01:56:13 +02:00			`ARTICLES = tutorial`
tutorial: add discussion of index file, object database 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> 2006-05-22 01:49:34 +02:00			`ARTICLES += tutorial-2`
Documentation: finishing touches to the new tutorial. 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> 2006-01-23 07:43:59 +01:00			`ARTICLES += core-tutorial`
Add repository-layout document. ... and link to it from both the main index and the tutorial. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-09-02 01:56:13 +02:00			`ARTICLES += cvs-migration`
			`ARTICLES += diffcore`
			`ARTICLES += howto-index`
			`ARTICLES += repository-layout`
Document hooks. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-09-03 06:19:26 +02:00			`ARTICLES += hooks`
Everyday GIT with 20 commands Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-12-10 08:07:29 +01:00			`ARTICLES += everyday`
Documentation/Makefile: Some `git-*.txt' files aren't manpages. 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> 2006-03-05 10:36:33 +01:00			`ARTICLES += git-tools`
glossary: stop generating automatically 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> 2007-03-18 22:02:37 +01:00			`ARTICLES += glossary`
Documentaion updates. Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <junkio@cox.net> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit) 2005-08-30 22:51:01 +02:00			`# with their own formatting rules.`
glossary: stop generating automatically 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> 2007-03-18 22:02:37 +01:00			`SP_ARTICLES = howto/revert-branch-rebase user-manual`
Documentaion updates. Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <junkio@cox.net> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit) 2005-08-30 22:51:01 +02:00
			`DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))`
Make sure howto/*.html is built as well. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-08-30 08:09:22 +02:00
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00			`DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))`
Documentation/Makefile: fix section (5) installation Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-22 09:11:41 +02:00			`DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))`
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00			`DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))`

make $prefix available for sub-makefiles 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> 2005-10-09 00:54:37 +02:00			`prefix?=$(HOME)`
Allow INSTALL, bindir, mandir to be set in main Makefile 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> 2006-06-29 22:11:25 +02:00			`bindir?=$(prefix)/bin`
Change default man page path to /usr/share/man According to FHS, http://www.pathname.com/fhs/pub/fhs-2.3.html#USRSHAREMANMANUALPAGES default man page path is $prefix/share/man. Signed-off-by: Ismail Donmez <ismail@pardus.org.tr> Signed-off-by: Junio C Hamano <gitster@pobox.com> 2007-05-08 12:49:31 +02:00			`mandir?=$(prefix)/share/man`
Rename man1 and man7 variables to man1dir and man7dir 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> 2006-06-29 23:26:54 +02:00			`man1dir=$(mandir)/man1`
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`man5dir=$(mandir)/man5`
Rename man1 and man7 variables to man1dir and man7dir 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> 2006-06-29 23:26:54 +02:00			`man7dir=$(mandir)/man7`
[PATCH] Use $DESTDIR instead of $dest $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> 2005-08-05 01:56:38 +02:00			`# DESTDIR=`
[PATCH] Add doc and install-doc targets to the Makefile 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> 2005-07-15 03:21:57 +02:00
Make it easier to override path to asciidoc command 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> 2007-02-11 16:54:40 +01:00			`ASCIIDOC=asciidoc`
Add release notes to the distribution. 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> 2007-02-14 00:15:05 +01:00			`ASCIIDOC_EXTRA =`
Documentation: adjust to AsciiDoc 8 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 <gitster@pobox.com> 2007-06-15 07:20:16 +02:00			`ifdef ASCIIDOC8`
			`ASCIIDOC_EXTRA += -a asciidoc7compatible`
			`endif`
make $prefix available for sub-makefiles 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> 2005-10-09 00:54:37 +02:00			`INSTALL?=install`
Makefile: add quick-install-doc for installing pre-built manpages 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> 2006-12-23 17:26:09 +01:00			`DOC_REF = origin/man`
[PATCH] Add doc and install-doc targets to the Makefile 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> 2005-07-15 03:21:57 +02:00
Include config.mak.autogen in the doc Makefile ... 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> 2006-09-01 00:31:08 +02:00			`-include ../config.mak.autogen`
Include config.mak in doc/Makefile 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> 2007-02-28 21:57:42 +01:00			`-include ../config.mak`
Include config.mak.autogen in the doc Makefile ... 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> 2006-09-01 00:31:08 +02:00
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00			`#`
			`# Please note that there is a minor bug in asciidoc.`
			`# The version after 6.0.3 _will_ include the patch found here:`
			`# http://marc.theaimsgroup.com/?l=git&m=111558757202243&w=2`
			`#`
			`# Until that version is released you may have to apply the patch`
			`# yourself - yes, all 6 characters of it!`
			`#`

			`all: html man`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
			`html: $(DOC_HTML)`

Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`$(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7): asciidoc.conf`
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`man: man1 man5 man7`
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00			`man1: $(DOC_MAN1)`
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`man5: $(DOC_MAN5)`
[PATCH] Docs - Makefile update 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> 2005-05-22 19:44:15 +02:00			`man7: $(DOC_MAN7)`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
Fix documentation dependency. 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> 2005-09-21 21:29:59 +02:00			`install: man`
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`$(INSTALL) -d -m755 $(DESTDIR)$(man1dir)`
			`$(INSTALL) -d -m755 $(DESTDIR)$(man5dir)`
			`$(INSTALL) -d -m755 $(DESTDIR)$(man7dir)`
no need to install manpages as executable 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> 2006-12-11 08:39:32 +01:00			`$(INSTALL) -m644 $(DOC_MAN1) $(DESTDIR)$(man1dir)`
Document gitattributes(5) Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:48:03 +02:00			`$(INSTALL) -m644 $(DOC_MAN5) $(DESTDIR)$(man5dir)`
no need to install manpages as executable 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> 2006-12-11 08:39:32 +01:00			`$(INSTALL) -m644 $(DOC_MAN7) $(DESTDIR)$(man7dir)`
[PATCH] Add doc and install-doc targets to the Makefile 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> 2005-07-15 03:21:57 +02:00
Documentation: -merge and -pull: describe merge strategies. ... and give a couple of examples of running 'git pull' against local repository. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-11-04 09:06:20 +01:00
Documentation: Replace @@GIT_VERSION@@ in documentation 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> 2007-03-25 13:56:49 +02:00			`../GIT-VERSION-FILE: .FORCE-GIT-VERSION-FILE`
			`$(MAKE) -C ../ GIT-VERSION-FILE`

			`-include ../GIT-VERSION-FILE`

Refactored merge options into separate merge-options.txt. 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> 2005-11-07 06:30:56 +01:00			`#`
			`# Determine "include::" file references in asciidoc files.`
			`#`
Documentation: fix dependency generation. The previous rule misses the case where git.txt or tutorial.txt includes new files. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-11-08 07:21:21 +01:00			`doc.dep : $(wildcard *.txt) build-docdep.perl`
Fix documentation dependency generation. 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> 2005-11-08 03:21:51 +01:00			`rm -f $@+ $@`
			`perl ./build-docdep.perl >$@+`
			`mv $@+ $@`
Refactored merge options into separate merge-options.txt. 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> 2005-11-07 06:30:56 +01:00
Fix documentation dependency generation. 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> 2005-11-08 03:21:51 +01:00			`-include doc.dep`
Documentation: -merge and -pull: describe merge strategies. ... and give a couple of examples of running 'git pull' against local repository. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-11-04 09:06:20 +01:00
Documentation: Generate command lists. 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> 2007-01-19 01:02:13 +01:00			`cmds_txt = cmds-ancillaryinterrogators.txt \`
			`cmds-ancillarymanipulators.txt \`
			`cmds-mainporcelain.txt \`
			`cmds-plumbinginterrogators.txt \`
			`cmds-plumbingmanipulators.txt \`
Documentation/git.txt: command re-classification 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> 2007-01-19 07:32:38 +01:00			`cmds-synchingrepositories.txt \`
			`cmds-synchelpers.txt \`
			`cmds-purehelpers.txt \`
			`cmds-foreignscminterface.txt`
Documentation: Generate command lists. 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> 2007-01-19 01:02:13 +01:00
Documentation: tighten dependency for git.{html,txt} 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> 2007-04-06 07:17:20 +02:00			`$(cmds_txt): cmd-list.made`

			`cmd-list.made: cmd-list.perl $(MAN1_TXT)`
Documentation: Generate command lists. 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> 2007-01-19 01:02:13 +01:00			`perl ./cmd-list.perl`
Documentation: tighten dependency for git.{html,txt} 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> 2007-04-06 07:17:20 +02:00			`date >$@`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
Documentation: Generate command lists. 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> 2007-01-19 01:02:13 +01:00			`git.7 git.html: git.txt core-intro.txt`
Refactored merge options into separate merge-options.txt. 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> 2005-11-07 06:30:56 +01:00
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00			`clean:`
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`rm -f .xml .xml+ .html .html+ .1 .5 .7 howto-index.txt howto/.html doc.dep`
Documentation: tighten dependency for git.{html,txt} 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> 2007-04-06 07:17:20 +02:00			`rm -f $(cmds_txt) *.made`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
			`%.html : %.txt`
Documentation: Replace @@GIT_VERSION@@ in documentation 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> 2007-03-25 13:56:49 +02:00			`rm -f $@+ $@`
			`$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \`
Documentation: robustify asciidoc GIT_VERSION replacement 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 <peff@peff.net> Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-06-01 11:10:30 +02:00			`$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<`
Documentation: Replace @@GIT_VERSION@@ in documentation 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> 2007-03-25 13:56:49 +02:00			`mv $@+ $@`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
Documentation: support manual section (5) - file formats. Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-04-20 05:47:04 +02:00			`%.1 %.5 %.7 : %.xml`
Properly render asciidoc "callouts" in git man pages. 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> 2006-04-28 15:15:06 +02:00			`xmlto -m callouts.xsl man $<`
[PATCH 4/4] split core-git.txt and update Makefile for html and man Signed-off-by: David Greaves <david@dgreaves.com> 2005-05-10 23:32:39 +02:00
			`%.xml : %.txt`
Documentation: Replace @@GIT_VERSION@@ in documentation 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> 2007-03-25 13:56:49 +02:00			`rm -f $@+ $@`
			`$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \`
Documentation: robustify asciidoc GIT_VERSION replacement 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 <peff@peff.net> Signed-off-by: Junio C Hamano <junkio@cox.net> 2007-06-01 11:10:30 +02:00			`$(ASCIIDOC_EXTRA) -agit_version=$(GIT_VERSION) -o $@+ $<`
Documentation: Replace @@GIT_VERSION@@ in documentation 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> 2007-03-25 13:56:49 +02:00			`mv $@+ $@`
Documentation updates. 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> 2005-08-15 02:24:36 +02:00
Documentation: add git user's manual 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> 2007-01-08 01:23:49 +01:00			`user-manual.xml: user-manual.txt user-manual.conf`
Make it easier to override path to asciidoc command 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> 2007-02-11 16:54:40 +01:00			`$(ASCIIDOC) -b docbook -d book $<`
Documentation: add git user's manual 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> 2007-01-08 01:23:49 +01:00
user-manual: ensure generated manual references stylesheet 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> 2007-03-03 19:33:48 +01:00			`XSLT = http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl`
user-manual: run xsltproc without --nonet option 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> 2007-03-16 16:45:29 +01:00			`XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css`
user-manual: ensure generated manual references stylesheet 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> 2007-03-03 19:33:48 +01:00
Documentation: add git user's manual 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> 2007-01-08 01:23:49 +01:00			`user-manual.html: user-manual.xml`
user-manual: ensure generated manual references stylesheet 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> 2007-03-03 19:33:48 +01:00			`xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<`
Documentation: add git user's manual 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> 2007-01-08 01:23:49 +01:00
Link howto documents from the main git.txt documentation. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-08-25 09:28:18 +02:00			`howto-index.txt: howto-index.sh $(wildcard howto/*.txt)`
			`rm -f $@+ $@`
			`sh ./howto-index.sh $(wildcard howto/*.txt) >$@+`
			`mv $@+ $@`

Documentaion updates. Mostly making the formatted html prettier. Signed-off-by: Junio C Hamano <junkio@cox.net> (cherry picked from 7adf1f15ebe074d4767df941817a6cf86d8e2533 commit) 2005-08-30 22:51:01 +02:00			`$(patsubst %,%.html,$(ARTICLES)) : %.html : %.txt`
Make it easier to override path to asciidoc command 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> 2007-02-11 16:54:40 +01:00			`$(ASCIIDOC) -b xhtml11 $*.txt`
Link howto documents from the main git.txt documentation. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-08-25 09:28:18 +02:00
			`WEBDOC_DEST = /pub/software/scm/git/docs`

Allow asciidoc formatted documentation in howto/ Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-08-30 07:38:12 +02:00			`$(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt`
			`rm -f $@+ $@`
Make it easier to override path to asciidoc command 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> 2007-02-11 16:54:40 +01:00			`sed -e '1,/^$$/d' $< \| $(ASCIIDOC) -b xhtml11 - >$@+`
Allow asciidoc formatted documentation in howto/ Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-08-30 07:38:12 +02:00			`mv $@+ $@`

Link howto documents from the main git.txt documentation. Signed-off-by: Junio C Hamano <junkio@cox.net> 2005-08-25 09:28:18 +02:00			`install-webdoc : html`
			`sh ./install-webdoc.sh $(WEBDOC_DEST)`
Makefile: add quick-install-doc for installing pre-built manpages 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> 2006-12-23 17:26:09 +01:00
			`quick-install:`
			`sh ./install-doc-quick.sh $(DOC_REF) $(mandir)`
Documentation: Replace @@GIT_VERSION@@ in documentation 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> 2007-03-25 13:56:49 +02:00
			`.PHONY: .FORCE-GIT-VERSION-FILE`