git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Felipe Contreras <felipe.contreras@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Felipe Contreras" <felipe.contreras@gmail.com>
Cc: Theodore Ts'o <tytso@mit.edu>,
	Atharva Raykar <raykar.ath@gmail.com>,
	Git List <git@vger.kernel.org>
Subject: Re: The git spring cleanup challenge completion
Date: Tue, 06 Jul 2021 17:31:28 -0500	[thread overview]
Message-ID: <60e4d9c07914e_1c42812081a@natae.notmuch> (raw)
In-Reply-To: <87wnq57q9n.fsf@evledraar.gmail.com>

Ævar Arnfjörð Bjarmason wrote:
> On Sun, Jul 04 2021, Felipe Contreras wrote:

> > I think there's some value in that idea but that doesn't solve the same
> > problem my suggestion solves. Basically there's too many commands in
> > `man git`. Splitting the git binary would allow us to only put the
> > important commands in `man git`.
> >
> > I think having too many commands overwhelms many newcomers, because they
> > don't know which it's important for them to learn and which are
> > basically noise.
> 
> I'm very much for the idea of a cleanup of "man git", but I don't think
> we need to introduce a git-tool(1) for that.

Indeed, it's not *necessary*, but it would help tremendously.

> E.g. "man perl" is a good example of where we should be
> headed. I.e. right off the bat in "man git" we have a long listing of
> command-line options to git itself, things like --exec-path and
> --no-optional-locks etc. are useful to almost no casual user.
> 
> We should really split everything except a passing mention of -p, -P, -c
> etc. into a "man gitrun" or something (just like perl has "man
> perlrun"), ditto the whole "ENVIRONMENT VARIABLES" section.

I like that. For the record zsh also splits man pages that way.

I would prefer `git-run` (or `git-core`) though, althought if somebody
at some point wants to create such a built-in that would be problematic.

-- 
Felipe Contreras

      reply	other threads:[~2021-07-06 22:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-07-02 22:49 The git spring cleanup challenge completion Felipe Contreras
2021-07-03  5:53 ` Bagas Sanjaya
2021-07-03 17:33   ` Felipe Contreras
2021-07-03 14:00 ` Atharva Raykar
2021-07-03 18:16   ` Felipe Contreras
2021-07-04  0:45     ` Theodore Ts'o
2021-07-04 17:23       ` Felipe Contreras
2021-07-04 20:47         ` Ævar Arnfjörð Bjarmason
2021-07-06 22:31           ` Felipe Contreras [this message]

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=60e4d9c07914e_1c42812081a@natae.notmuch \
    --to=felipe.contreras@gmail.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=raykar.ath@gmail.com \
    --cc=tytso@mit.edu \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).