Michael J Gruber <michaeljgruber+grubix+git@gmail.com> writes:

>
> I think it's worth spelling out somewhere that this remote helper does
> not deal with "remote" notmuch databases. Rather, it allows to treat a
> local notmuch db as a git repository.

Right, that is what the first sentence of the man page says.
Do you think we should repeat this somewhere?

> This may be clear to git users who read "remote helper" as "foreign
> repo helper", but in many of those cases the helpers allow (and
> typically are used with) remote URLs for the foreign system (svn and
> such).

Just to be clear (and I suspect you know this) but the name is fixed by
the protocol, so foo:: looks for git-remote-foo.

> What would be a good place for a "Usage" section?

I'm not 100% sure what you are looking for, but here are a couple of
ideas.

- look at the notmuch man page as a template, expand the description a
bit and add a NOTE section emphasizing what it is not good for.

- Add a section called Usage after description containing a prose
  discussion covering some of the same topics as Examples

- Alternatively the Examples section could be expanded.

> NB: s/proved//provided/ in patch 9.

Fixed in git. Also TIL the man page is not installed in the debian
package, so fixing that also (not that it would bother you, but it
actually breaks the debian packaging).

>
> Cheers
> Michael
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org