public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Jari Aalto <jari.aalto@cante•net>
To: Michael J Gruber <git@drmicha•warpmail.net>
Cc: git@vger•kernel.org
Subject: Re: [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase
Date: Fri, 16 Apr 2010 20:05:52 +0300	[thread overview]
Message-ID: <87eiifqqdr.fsf@jondo.cante.net> (raw)
In-Reply-To: <4BC8605F.5070306@drmicha.warpmail.net> (Michael J. Gruber's message of "Fri, 16 Apr 2010 15:04:31 +0200")

Michael J Gruber <git@drmicha•warpmail.net> writes:

> I just think that using all these options on the command line is very
> atypical. It would be helpful to see the defaults in one place:

Now, think this:

    You have 30 servers.

    You notice a problem.

    You need that command, whatever that is.

    Consult manual page, yay (Wow, or "Ugh")

    <blink> there is EXMAPLE, options and - Hurray: Copy/Paste and use.

You don't necessarily have full blown "environment" in front of you, so
we need both

    * Full command line exmaples. They are commadn line options after
      all
    * And configuration examples

The more copy/paste ready, the better. The more FAQ like, the better.
Let's make FAQs obsolete.

Thansk for the examples, I'll be revising the patch
Jari

  reply	other threads:[~2010-04-16 17:06 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-04-15 15:37 [PATCH] git-send-email.txt: Add EXAMPLES section. Write 1st level sections in uppercase jari.aalto
2010-04-16  8:01 ` Michael J Gruber
2010-04-16 11:46   ` Jari Aalto
2010-04-16 13:04     ` Michael J Gruber
2010-04-16 17:05       ` Jari Aalto [this message]
2010-04-17 18:46       ` Junio C Hamano

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=87eiifqqdr.fsf@jondo.cante.net \
    --to=jari.aalto@cante$(echo .)net \
    --cc=git@drmicha$(echo .)warpmail.net \
    --cc=git@vger$(echo .)kernel.org \
    /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