darcs

Issue 1455 darcs help environment

Title darcs help environment
Priority feature Status resolved
Milestone Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, kowey, thorkilnaur, twb
Assigned To twb
Topics Documentation

Created on 2009-04-30.10:15:28 by twb, last changed 2009-08-27.14:24:08 by admin.

Messages
msg7779 (view) Author: twb Date: 2009-04-30.10:15:25
Currently we special-case "darcs help --match" to provide (inadequate)
documentation on the match EDSL (embedded domain-specific language).

We can/should also provide information on Darcs environment variables
(e.g. DARCS_EMAIL) and Darcs files (e.g. ~/.darcs/sources).  Currently
this information is only available in the user manual, but it can and
should be available from the command line and in the manpage, too.

As a mock-up, consider how Mercurial does it:

    $ hg --help
    list of commands:
     <A COMMAND>  <ITS SYNOPSIS>
     [...]        [...]

    additional help topics:
     dates        Date Formats
     patterns     File Name Patterns
     environment  Environment Variables
     revisions    Specifying Single Revisions
     multirevs    Specifying Multiple Revisions
     diffs        Diff Formats
     templating   Template Usage
     urls         Url Paths

    $ hg help environment
    Environment Variables

    EDITOR::
        Sometimes Mercurial needs to open a text file in an editor
        for a user to modify, for example when writing commit messages.
        The editor it uses is determined by looking at the environment
        variables HGEDITOR, VISUAL and EDITOR, in that order. The first
        non-empty one is chosen. If all of them are empty, the editor
        defaults to 'sensible-editor'.

    [...]
msg7806 (view) Author: twb Date: 2009-05-13.03:13:17
The following patch updated the status of issue1455 to be resolved:

* Resolve issue1455: implement "darcs help environment". 
Ignore-this: 4db59cb774cfc06af64c0d7095b8923b
History
Date User Action Args
2009-04-30 10:15:28twbcreate
2009-05-01 06:41:18twbsetassignedto: twb
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-05-13 03:13:20twbsetstatus: unread -> resolved
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
messages: + msg7806
2009-08-10 01:50:21twbsettopic: + Documentation
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-08-10 01:52:16twbsetnosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
title: docs: darcs help environment -> darcs help environment
2009-08-10 02:04:16twbsetpriority: feature
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-08-10 02:04:26twbsetstatus: resolved -> has-patch
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-08-15 08:15:10twbsetstatus: has-patch -> resolved
nosy: kowey, simon, twb, thorkilnaur, dmitry.kurochkin
2009-08-25 17:44:51adminsetnosy: + darcs-devel, - simon
2009-08-27 14:24:08adminsetnosy: kowey, darcs-devel, twb, thorkilnaur, dmitry.kurochkin