unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: Jameson Graef Rollins <jrollins@finestructure.net>,
	Jani Nikula <jani@nikula.org>,
	notmuch@notmuchmail.org
Subject: Re: [PATCH 0/6] notmuch cli config changes
Date: Tue, 12 Feb 2013 14:53:53 -0400	[thread overview]
Message-ID: <87pq05icse.fsf@convex-new.cs.unb.ca> (raw)
In-Reply-To: <87a9r9o4ks.fsf@servo.finestructure.net>

Jameson Graef Rollins <jrollins@finestructure.net> writes:

> But don't get me wrong, the CLI is one of the things that makes notmuch
> so incredibly awesome.  It's an email swiss army knife that's there when
> you need it.  But given that even I often need to look at the man page
> during my occasional CLI usage, I just don't want to see it get to
> overcrowded.

Well, maybe this should be a discussion about how to organize the CLI
documentation so that more commonly used options are easy to find. That
would indeed be a side effect of making less commonly used options
controlled by environment variables, and documenting the environment
variables at the bottom of the man pages as per tradition. But I don't
think this is the only way or even the best way to achieve good
documentation.

d

  reply	other threads:[~2013-02-12 18:54 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-01-29 21:46 [PATCH 0/6] notmuch cli config changes Jani Nikula
2013-01-29 21:46 ` [PATCH 1/6] cli: keep track of whether the config is newly created Jani Nikula
2013-03-03 16:13   ` David Bremner
2013-01-29 21:46 ` [PATCH 2/6] cli: make notmuch_config_open() "is new" parameter input only Jani Nikula
2013-03-03 16:17   ` David Bremner
2013-01-29 21:46 ` [PATCH 3/6] cli: abstract subcommand finding into a new function Jani Nikula
2013-03-03 16:23   ` David Bremner
2013-01-29 21:46 ` [PATCH 4/6] cli: plug main notmuch command into subcommand machinery Jani Nikula
2013-03-03 16:28   ` David Bremner
2013-01-29 21:46 ` [PATCH 5/6] cli: move config open/close to main() from subcommands Jani Nikula
2013-01-29 21:46 ` [PATCH 6/6] cli: add top level --config=FILE option Jani Nikula
2013-03-03 16:32   ` David Bremner
2013-02-06 17:50 ` [PATCH 0/6] notmuch cli config changes Jameson Graef Rollins
2013-02-07  7:43   ` Jani Nikula
2013-02-07 12:07   ` David Bremner
2013-02-12  7:50     ` Jameson Graef Rollins
2013-02-12 11:42       ` David Bremner
2013-02-12 16:54         ` Jameson Graef Rollins
2013-02-12 18:53           ` David Bremner [this message]
2013-02-13  7:51             ` Mark Walters
2013-02-12 20:06           ` Jani Nikula
2013-03-03 16:36             ` David Bremner

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: https://notmuchmail.org/

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

  git send-email \
    --in-reply-to=87pq05icse.fsf@convex-new.cs.unb.ca \
    --to=david@tethera.net \
    --cc=jani@nikula.org \
    --cc=jrollins@finestructure.net \
    --cc=notmuch@notmuchmail.org \
    /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://yhetil.org/notmuch.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).