darcs

Issue 69 Improve documentation on environment variables

Title Improve documentation on environment variables
Priority feature Status resolved
Milestone Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, kowey, thorkilnaur, tommy
Assigned To
Topics ProbablyEasy

Created on 2005-12-21.14:43:21 by droundy, last changed 2009-08-27.14:10:40 by admin.

Messages
msg252 (view) Author: droundy Date: 2005-12-21.14:43:20
Hi David,

Just a quick note to suggest that the envvar's for output coloring are
not listed under the "Environment variables" section.

Best regards,
-- 
Yann Dirson    <ydirson@altern.org> |
Debian-related: <dirson@debian.org> |   Support Debian GNU/Linux:
                                    |  Freedom, Power, Stability, Gratis
     http://ydirson.free.fr/        | Check <http://www.debian.org/>
msg332 (view) Author: tommy Date: 2006-01-08.23:58:21
I wonder if it might not be a better idea to make the
Configuring Darcs chapter more usage oriented.  The grouping
of all environment variables in one section is not really
helpful, because the user must 1) know the wanted change is
done with an environment variable, 2) browse on average half
that section taking guesses at what environment variable
names might be heading promising paragraphs.
msg336 (view) Author: droundy Date: 2006-01-09.13:43:18
On Sun, Jan 08, 2006 at 11:58:22PM +0000, Tommy Pettersson wrote:
> I wonder if it might not be a better idea to make the
> Configuring Darcs chapter more usage oriented.  The grouping
> of all environment variables in one section is not really
> helpful, because the user must 1) know the wanted change is
> done with an environment variable, 2) browse on average half
> that section taking guesses at what environment variable
> names might be heading promising paragraphs.

Yes, that does sound like a good idea, although I think it would be good
also somewhere to have a listing of all environment variables darcs pays
attention to (perhaps with links to relevant sections?), since that can be
helpful in debugging why darcs behaves as it does in a particular situation.
-- 
David Roundy
http://www.darcs.net
msg2059 (view) Author: kowey Date: 2007-08-13.17:36:27
The original issue was fixed a long time ago in

Fri Apr  8 01:25:29 CEST 2005  Tommy Pettersson <ptp@lysator.liu.se>
  * document environment variables for controling color and escaping

Also, I think my patch does the jobs of splitting the env variable stuff into
thematic sections and providing a quick-glance table.  So it's probably fixed

Tue Aug  7 23:06:22 CEST 2007  Eric Kow <eric.kow@gmail.com>
  * [issue69] Add a table of environmental variables to the manual.
History
Date User Action Args
2005-12-21 14:43:21droundycreate
2006-01-08 23:58:22tommysetstatus: unread -> unknown
messages: + msg332
2006-01-09 13:43:19droundysetmessages: + msg336
2006-04-03 12:06:36droundysetpriority: bug -> feature
2006-08-06 22:02:04koweysettopic: + ProbablyEasy
title: darcs and *COLOR* documentation -> Improve documentation on environment variables
2007-08-13 17:36:28koweysetstatus: unknown -> resolved-in-unstable
nosy: + kowey, beschmi
messages: + msg2059
2007-10-21 19:58:29koweysetstatus: resolved-in-unstable -> resolved-in-stable
2008-09-16 21:30:05adminsetstatus: resolved-in-stable -> resolved
nosy: + dagit
2009-08-06 17:41:34adminsetnosy: + markstos, jast, Serware, dmitry.kurochkin, darcs-devel, zooko, mornfall, simon, thorkilnaur, - droundy
2009-08-06 20:38:47adminsetnosy: - beschmi
2009-08-10 22:15:50adminsetnosy: - markstos, darcs-devel, zooko, jast, Serware, mornfall
2009-08-11 00:07:33adminsetnosy: - dagit
2009-08-25 17:55:11adminsetnosy: + darcs-devel, - simon
2009-08-27 14:10:40adminsetnosy: tommy, kowey, darcs-devel, thorkilnaur, dmitry.kurochkin