1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-16 14:04:52 +01:00
Commit graph

124 commits

Author SHA1 Message Date
Jonas Fonseca
df8baa42fe [PATCH] Random documentation fixes
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>
2005-10-03 13:23:47 -07:00
Junio C Hamano
0493a3fd52 Merge branch 'fixes' 2005-09-21 12:31:33 -07:00
Junio C Hamano
b163512d4e 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 12:29:59 -07:00
Sergey Vlasov
d1c2e113c5 [PATCH] Documentation: Add asciidoc.conf file and gitlink: macro
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>
2005-09-20 15:07:51 -07:00
Peter Eriksen
53764ee43d [PATCH] Use '-d' as the first flag to 'install'
... 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>
2005-09-15 12:46:31 -07:00
Junio C Hamano
6d35cc7690 Document hooks.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-02 22:38:30 -07:00
Junio C Hamano
a1d4aa7424 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-01 16:56:13 -07:00
Junio C Hamano
8db9307c9c 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 13:55:34 -07:00
Junio C Hamano
789d577412 Make sure howto/*.html is built as well.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-29 23:09:22 -07:00
Junio C Hamano
8d0991d7d7 Allow asciidoc formatted documentation in howto/
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-29 22:38:12 -07:00
Tommi Virtanen
88db5f809d [PATCH] git bugfixes and cleanups, mainly Debian things
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>
2005-08-26 12:52:25 -07:00
Junio C Hamano
248542ea9a Don't forget to build the howto-index file.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-25 00:36:41 -07:00
Junio C Hamano
e6fc2346c1 Link howto documents from the main git.txt documentation.
Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-25 00:28:18 -07:00
Junio C Hamano
2a29da7c6d Tutorial updates.
- 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>
2005-08-23 15:28:34 -07:00
Johannes Schindelin
23bb8df2fb [PATCH] Add Makefile target glossary.html
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>
2005-08-18 10:25:52 -07:00
Junio C Hamano
3f971fc425 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-14 17:24:36 -07:00
Petr Baudis
a682ef9f06 [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-12 10:38:23 -07:00
Linus Torvalds
71931c1965 Fix up "make doc"
Fix 'git-var.txt' and use "-b xhtml11" instead of "-b css-embedded" to
make asciidoc 7.0.1 happy.
2005-07-15 14:57:09 -07:00
Eric W. Biederman
87a81c834b [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 11:38:24 -07:00
Junio C Hamano
dda2d79af2 [PATCH] Clean up diff option descriptions.
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>
2005-07-13 13:09:17 -07:00
David Greaves
b2bf34d6c5 [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 11:07:22 -07:00
Sebastian Kuzminsky
7984eabe07 [PATCH] manpage name conflict
This moves the git manpage to man7, since "git" isn't a direct command
per se.  It also does two other things:

    * Sort of works around the asciidoc 6.0.3 bug where the manpages all
      get called "git.1".  It just renames them to what they should have
      been called.

    * Fixes a cut-n-paste bug in git-diff-helper.txt that was making
      asciidoc choke.
2005-05-19 09:58:44 -07:00
David Greaves
f77b100ada The Makefile is now aware of Documentation/ include directives
It makes the includers (diff commands documentation) depend on the includee
(diff format description).

Signed-off-by: David Greaves <david@dgreaves.com>
Signed-off-by: Petr Baudis <pasky@ucw.cz>
2005-05-14 00:01:41 +02:00
David Greaves
b790abb874 [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 15:03:34 -07:00