darcs

Issue 271 Make specific corrections to documentation

Title Make specific corrections to documentation
Priority wishlist Status resolved
Milestone Resolved in
Superseder Nosy List darcs-devel, dmitry.kurochkin, era, kowey, thorkilnaur, tommy
Assigned To
Topics ProbablyEasy

Created on 2006-09-24.15:26:38 by era+darcs, last changed 2009-10-24.00:32:11 by admin.

Files
File name Uploaded Type Edit Remove
darcs-patches.out era+darcs, 2006-09-24.15:26:32 application/octet-stream
Messages
msg1006 (view) Author: era Date: 2006-09-24.15:26:32
I'm completely new to darcs, so please have patience ...

I discovered some typos and other minor problems in the documentation,
and tried to fix those things I was able to. I am attaching a bundle
of patches for the issues I think I managed to correct; the remainder
of this bug is more of a TODO list.

I understand splitting the patch into multiple subpatches might
improve my rank in the commits league (-: so feel free to coalesce
this into a single patch before committing.

  - DarcsCommands.lhs: footnote #3 is defined but never displayed in
    the PostScript verion (it's there in bigpage.html). Anyway,
    perhaps the table should be rehashed to make the footnotes
    unnecessary? (Divide further into "affects remote" vs "affects
    local", etc?)

  - .muttrc examples are different in Apply.lhs, best_practices.tex,
    and darcs.lhs (but maybe this is only for the better -- diversity
    and all that)

  - In command option listings, [DEFAULT] markings could be clearer
    and more consistent. For example, most switches are two-way, and
    it's obvious that the [DEFAULT] is the default; in many places,
    it's not explicitly marked, but it's also perhaps not necessary
    (like in 'darcs whatsnew', there is no indication whether
    --look-for-adds or --don't-look-for-adds is the default); but e.g
    in 'darcs record', there is the three-way switch --edit-long-comment
    vs --skip-long-comment vs --prompt-long-comment; and in yet other
    contexts, I found it slighly hard to figure out from just a
    [DEFAULT] tag which options were related (e.g. which other options
    would override this default).

  - DarcsRepo.lhs: Maybe explain how to configure Emacs to never save
    any temp files in _darcs/current?

Sorry for cramming all of this into a single bug report; I imagine a
couple of these might be easy to fix for someone who knows how, and
the rest might not even be worth having as bugs.

/* era */
Attachments
History
Date User Action Args
2006-09-24 15:26:38era+darcscreate
2006-10-01 21:10:23koweysettopic: + ProbablyEasy
nosy: droundy, tommy, kowey, era+darcs
title: Minor documentation fixes -> Make specific corrections to documentation
2007-07-16 21:12:45koweysetstatus: unread -> resolved
nosy: + beschmi
2009-08-06 17:45:54adminsetnosy: + markstos, jast, Serware, dmitry.kurochkin, darcs-devel, zooko, dagit, mornfall, simon, thorkilnaur, - droundy, era+darcs
2009-08-06 20:41:34adminsetnosy: - beschmi
2009-08-10 21:55:50adminsetnosy: + era+darcs, - markstos, darcs-devel, zooko, jast, dagit, Serware, mornfall
2009-08-25 17:57:42adminsetnosy: + darcs-devel, - simon
2009-08-27 13:50:03adminsetnosy: tommy, kowey, darcs-devel, era+darcs, thorkilnaur, dmitry.kurochkin
2009-10-24 00:32:11adminsetnosy: + era, - era+darcs