git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: linux@horizon.com
To: linux@horizon.com, pasky@suse.cz
Cc: alan@chandlerfamily.org.uk, git@vger.kernel.org
Subject: Re: as promised, docs: git for the confused
Date: 9 Dec 2005 09:01:23 -0500	[thread overview]
Message-ID: <20051209140123.3234.qmail@science.horizon.com> (raw)
In-Reply-To: <20051209094328.GT22159@pasky.or.cz>

>   BTW, such a "wide" reply is a bit hard to handle - it might be perhaps
> more practical to make separate replies at least to the mails whose
> contents does not overlap. Also, people would not get Cc's of subthreads
> they are not involved with.

Sorry... it was one edit session while I made all the corrections,
and it was just more natural...

>> Unfortunately, given the number of commands, you can't just document
>> them well individually.  Some overview of how they fit together into
>> a system is required.

> Hmm. Well, actually... what's the point? If I want to get a really quick
> overview, I do
>
>	whatis git
>
> and it will DTRT. But when do I need something more detailed but not yet
> the manual page of the given command?

"I want to do X and Y but not Z.  What commands are worth knowing?"

I have 106 git-* commands available to me (my document covers 105;
I'll have to find the extra), and the biggest question I have is
"how many of those man pages can I get away with NOT reading?"

Heck, that categorized list is what I started out writing, and I happen
to think it's the most important part of the whole document.

The man page tells me HOW to execute a command.  But before I'm ready for
that level of detail, I need to figure out WHICH command to execute.
To be specific, I need to know the terrain just well enough so I can
plan a route from where I am to where I want to be.  Then I can look
into the details of each step.

But without that overview, my trip is going to take me into a lot of dead
ends, because I'm executing commands that I think are getting me closer,
but I have the wrong mental model of what "close" is.

Or perhaps I found one command that sort-of does what I want an
missed the one that works better.


(BTW, don't you mean "whatis -w git\*"?)

  reply	other threads:[~2005-12-09 14:01 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <7vbqzrcmgr.fsf@assigned-by-dhcp.cox.net>
2005-12-09  5:43 ` as promised, docs: git for the confused linux
2005-12-09  9:43   ` Petr Baudis
2005-12-09 14:01     ` linux [this message]
2005-12-09 16:49       ` Randy.Dunlap
2005-12-09 19:12       ` Junio C Hamano
2005-12-09 21:54         ` linux
2005-12-09 23:23           ` Junio C Hamano
2005-12-12 16:34             ` Linus Torvalds
2005-12-12 17:53               ` Timo Hirvonen
2005-12-12 18:18                 ` Linus Torvalds
2005-12-12 20:39                   ` Randal L. Schwartz
2005-12-13  3:58                     ` Joshua N Pritikin
2005-12-13  3:59                       ` Randal L. Schwartz
2005-12-13  5:19                         ` Junio C Hamano
2005-12-13  5:29                           ` Linus Torvalds
2005-12-13  7:18                             ` H. Peter Anvin
2005-12-13  8:01                           ` Junio C Hamano
2005-12-13 13:58                             ` Randal L. Schwartz
2005-12-13 21:16                               ` Tip of the day: archaeology Junio C Hamano
2005-12-13 21:54                                 ` Linus Torvalds
2005-12-13 22:19                                   ` Junio C Hamano
2005-12-12 17:54               ` as promised, docs: git for the confused Junio C Hamano
2005-12-13  0:22               ` [PATCH] Everyday: some examples Junio C Hamano
2005-12-09 21:33       ` as promised, docs: git for the confused Petr Baudis
2005-12-09  5:44 ` linux
2005-12-10  1:22   ` Junio C Hamano
2005-12-10  8:00   ` Junio C Hamano
2005-12-10 10:56     ` linux
2005-12-04 21:34 git-name-rev off-by-one bug Petr Baudis
2005-12-08  6:34 ` as promised, docs: git for the confused linux
2005-12-08 21:53   ` Junio C Hamano
2005-12-08 22:02     ` H. Peter Anvin
2005-12-09  0:47   ` Alan Chandler
2005-12-09  1:45     ` Petr Baudis
2005-12-09  1:19   ` Josef Weidendorfer

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=20051209140123.3234.qmail@science.horizon.com \
    --to=linux@horizon.com \
    --cc=alan@chandlerfamily.org.uk \
    --cc=git@vger.kernel.org \
    --cc=pasky@suse.cz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).