simon-git: agedu (master): Simon Tatham

[Commits to Tartarus CVS repository.]

TL;DR:
  3922ffe Rearrange documentation of -S, -L and -D.

Repository:     git://git.tartarus.org/simon/agedu.git
On the web:     http://tartarus.org/~simon-git/gitweb/?p=agedu.git
Branch updated: master
Committer:      Simon Tatham <anakin at pobox.com>
Date:           2015-04-21 18:21:40

commit 3922ffef2280884b0ecf95ab816511070f9d5943
web diff http://tartarus.org/~simon-git/gitweb/?p=agedu.git;a=commitdiff;h=3922ffef2280884b0ecf95ab816511070f9d5943;hp=a2b5efc6b9e8e350cfbc529fa522a277937b6fb1
Author: Simon Tatham <anakin at pobox.com>
Date:   Tue Apr 21 18:17:57 2015 +0100

    Rearrange documentation of -S, -L and -D.
    
    I previously documented -D and -L first, as obvious inverses of one
    another (turn an index file into a textual dump and vice versa), and
    then mentioned -S as an afterthought (go straight from scan to dump
    without the intermediate index file). But a conversation with a user
    suggested to me that this is actually a silly way to document this
    cluster of options, because the most likely combination of them to be
    actually useful is not -D and -L, but -S and -L - if you want to scan
    one machine and end up with an index on another, those options are the
    pair that get you most efficiently to that state. -D is actually for
    the more specialist situation in which you've already built an index
    on one machine but then _change your mind_ about where it should live.
    
    The initial intro section now contains an example of -S and -L in
    action, and the per-option documentation has been switched round to
    mention those two first with simple descriptions and relegate -D to
    the position of 'afterthought with strange extra caveats' previously
    occupied by -S.

 agedu.but |   72 +++++++++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 53 insertions(+), 19 deletions(-)