From: Matthieu Moy <Matthieu.Moy@imag•fr>
To: Junio C Hamano <gitster@pobox•com>
Cc: Benoit Sigoure <tsuna@lrde•epita.fr>,
Lars Hjemli <hjemli@gmail•com>,
"Jonas Juselius" <jonas.juselius@chem•uit.no>,
git@vger•kernel.org
Subject: Re: Git in a Nutshell guide
Date: Mon, 19 Nov 2007 23:59:40 +0100 [thread overview]
Message-ID: <vpqd4u5zvs3.fsf@bauges.imag.fr> (raw)
In-Reply-To: <7v7ikdna24.fsf@gitster.siamese.dyndns.org> (Junio C. Hamano's message of "Mon\, 19 Nov 2007 14\:29\:39 -0800")
Junio C Hamano <gitster@pobox•com> writes:
> I think the ref naming syntax is so commonly used and
> fundamental that we could treat it as prerequiste for individual
> manual pages. Maybe move the section to git(7)? That would
> certainly be better than having it in git-rev-parse(1), but does
> not reduce the cross referencing complaints.
Well, obviously, something which isn't addressed by my patch is the
fact that some of the documentation an average user needs is in the
plumbing man pages.
(Gosh, I was going to cite the manpage for git-log and git-rev-parse
as an example, but it has already been fixed :-). Good job !)
git-rev-parse(1) is full of terribly usefull information, and that
information is definitely not in the place an average user would look
at.
I have no ideal solution for that. git(7) is already really long.
Perhaps some "topic man pages" would be good. By "topic man page", I
mean "man git-something" where "something" isn't a git command, but a
crosscutting concept. For example, here, "man git-refspec" to document
reference specifiers like HEAD@{42}, master~55, d71c6c8e24a and
friends. "man git-i18n" would be another candidate.
Anyway, my patch is definitely a step forward, even if it's just the
first, small one ;-).
--
Matthieu
next prev parent reply other threads:[~2007-11-19 23:00 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-11-19 13:05 Git in a Nutshell guide Jonas Juselius
2007-11-19 13:29 ` Jakub Narebski
2007-11-19 14:33 ` Jonas Juselius
2007-11-22 8:22 ` David Kågedal
2007-11-23 9:28 ` Jakub Narebski
2007-11-19 15:02 ` Brian Downing
2007-11-19 15:03 ` Brian Downing
2007-11-19 15:48 ` Nicolas Pitre
2007-11-19 16:05 ` Jakub Narebski
2007-11-19 16:14 ` Jonas Juselius
2007-11-19 16:49 ` Benoit Sigoure
2007-11-19 22:01 ` Daniel Barkalow
2007-11-20 11:34 ` Jonas Juselius
2007-11-20 23:57 ` Jakub Narebski
2007-11-21 19:45 ` Jan Hudec
2007-11-21 21:32 ` Jakub Narebski
2007-11-22 16:37 ` jhud7196
2007-11-22 13:15 ` Jonas Juselius
2007-11-22 14:19 ` Jonathan del Strother
2007-11-22 14:24 ` Johannes Schindelin
2007-11-22 16:57 ` jhud7196
2007-11-19 16:45 ` Lars Hjemli
2007-11-19 16:56 ` Jonas Juselius
2007-11-19 16:57 ` Benoit Sigoure
2007-11-19 17:04 ` Lars Hjemli
2007-11-19 18:10 ` Benoit Sigoure
2007-11-19 18:13 ` J. Bruce Fields
2007-11-19 18:13 ` Matthieu Moy
2007-11-19 18:35 ` [PATCH] Doc fix for git-reflog: mention @{...} syntax, and <ref> in synopsys Matthieu Moy
2007-11-19 20:13 ` Junio C Hamano
2007-11-19 20:28 ` Matthieu Moy
2007-11-19 20:31 ` Matthieu Moy
2007-11-19 21:15 ` Git in a Nutshell guide Benoit Sigoure
2007-11-19 21:33 ` Matthieu Moy
2007-11-19 21:51 ` Benoit Sigoure
2007-11-19 22:23 ` J. Bruce Fields
2007-11-19 22:29 ` Junio C Hamano
2007-11-19 22:59 ` Matthieu Moy [this message]
2007-11-19 23:07 ` Junio C Hamano
2007-11-19 17:05 ` Matthieu Moy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=vpqd4u5zvs3.fsf@bauges.imag.fr \
--to=matthieu.moy@imag$(echo .)fr \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=hjemli@gmail$(echo .)com \
--cc=jonas.juselius@chem$(echo .)uit.no \
--cc=tsuna@lrde$(echo .)epita.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox