darcs

Issue 665 wish: improve progress report message for reading inventory

Title wish: improve progress report message for reading inventory
Priority wishlist Status given-up
Milestone Resolved in
Superseder Nosy List dmitry.kurochkin, jaredj, kowey, markstos, salty-horse, thorkilnaur, tommy
Assigned To
Topics ProbablyEasy, UI

Created on 2008-02-08.21:04:33 by salty-horse, last changed 2017-07-31.00:00:40 by gh.

Messages
msg3247 (view) Author: salty-horse Date: 2008-02-08.21:04:08
When a large "revert" operation takes place, the user is greeted to the message:
  "Reading inventory of repository /home/me/devel/project inventory"
which in time turns into "Finished reverting."

The last word, "inventory", is out of place.

The line is printed by finishedOneIO in read_repo_private
[src/Darcs/Repository/DarcsRepo.lhs]

Since reading the inventory file is the only IO operation in read_repo_private
(or more precisely: finishedOneIO is called only once), there is no "progress"
to report.

The message would make more sense if there were other files being read and the
the word "inventory" would have been replaced by their names, to show the
progress. But, this isn't the case here.
msg3248 (view) Author: droundy Date: 2008-02-08.22:23:36
This is only because you've not yet tagged your repository, or the repository
has not been optimized.  If your inventory was broken on tags (as ghc's is, for
instance), you'd see as various inventories are read.
msg3253 (view) Author: salty-horse Date: 2008-02-08.23:00:03
In that case, can the printed message visually separate the "current task"?
Something like:

"Reading inventory of repository /home/me/devel/project... [inventory]"
msg3256 (view) Author: markstos Date: 2008-02-09.05:01:48
I agree with salty-horse that the updated text is better. Further, I believe
even this  istoo much detail to go into by default. 

An average use shouldn't ever need to know what an "inventory" is. This is an
internal implementation detail that is not important to understand to use darcs
productively. 

Unless "--debug" is turned on, I suggest simplifying the message to be just
something like: 

"Reading files" or "Reading files (1/5)"

I feel the same way about displaying the full hash name in other progress
reports. The hash name would only need to be seen if you are debugging.
Otherwise, "Patch (23/45)" is sufficient.
msg8636 (view) Author: kowey Date: 2009-09-02.14:27:43
Ori (salty-horse): may I confirm that your proposal is to print out which
inventory we are reading from in the progress report?
msg8641 (view) Author: salty-horse Date: 2009-09-02.14:52:49
kowey, my suggestion is to make it less confusing.
The message "Reading inventory [...] inventory" makes little sense for newbies.

I'm OK with both suggestions made so far:
Either separate the inventory name from the rest of the message with
parentheses, or, as markstos suggested, not printing out the inventory name at all.
msg8642 (view) Author: kowey Date: 2009-09-02.15:11:17
On Wed, Sep 02, 2009 at 14:52:51 +0000, Ori Avtalion wrote:
> kowey, my suggestion is to make it less confusing.
> The message "Reading inventory [...] inventory" makes little sense for newbies.
 
Ok, I get it now, thanks! (I didn't understand that this bug was about two
instances of the same word 'inventory'; the second being the actual filename)

> I'm OK with both suggestions made so far:
> Either separate the inventory name from the rest of the message with
> parentheses, or, as markstos suggested, not printing out the inventory name at
all.

I personally like the first solution better
  reading inventory of repository /home/me/devel/project 'inventory'

or hiding filenames/hashes but retaining high level description
  reading inventory files (1/4)
  reading hashed pristine files (1/48)
  reading patches (49/98)

My attitude about this sort of thing is that hiding detail just for its own sake
(in the name of simplicity) isn't doing anybody any favours.  If somebody
submits a patch of some kind, we can discuss the matter on list.
History
Date User Action Args
2008-02-08 21:04:33salty-horsecreate
2008-02-08 22:23:37droundysetstatus: unread -> unknown
nosy: droundy, tommy, beschmi, kowey, salty-horse
messages: + msg3248
2008-02-08 23:00:04salty-horsesetnosy: droundy, tommy, beschmi, kowey, salty-horse
messages: + msg3253
2008-02-09 05:01:49markstossetnosy: + markstos
messages: + msg3256
2008-02-16 22:07:41markstossetpriority: bug -> wishlist
status: unknown -> deferred
title: Odd progress report message when reverting -> wish: improve progress report message when reverting
nosy: droundy, tommy, beschmi, kowey, markstos, salty-horse
2009-08-06 17:53:53adminsetnosy: + jast, Serware, dmitry.kurochkin, darcs-devel, zooko, dagit, mornfall, simon, thorkilnaur, - droundy, salty-horse
2009-08-06 20:57:19adminsetnosy: - beschmi
2009-08-10 22:14:16adminsetnosy: + salty-horse, - darcs-devel, zooko, jast, dagit, Serware, mornfall
2009-08-25 18:05:15adminsetnosy: + darcs-devel, - simon
2009-08-27 13:55:40adminsetnosy: tommy, kowey, markstos, darcs-devel, salty-horse, thorkilnaur, dmitry.kurochkin
2009-09-02 14:27:48koweysetstatus: deferred -> waiting-for
title: wish: improve progress report message when reverting -> wish: improve progress report message for reading inventory
nosy: tommy, kowey, markstos, darcs-devel, salty-horse, thorkilnaur, dmitry.kurochkin
messages: + msg8636
topic: + UI
assignedto: salty-horse
2009-09-02 14:52:51salty-horsesetnosy: tommy, kowey, markstos, darcs-devel, salty-horse, thorkilnaur, dmitry.kurochkin
messages: + msg8641
2009-09-02 15:11:23koweysetstatus: waiting-for -> needs-implementation
nosy: + jaredj
topic: + ProbablyEasy
messages: + msg8642
assignedto: salty-horse ->
2010-07-01 09:53:10koweysetnosy: - darcs-devel
2017-07-31 00:00:40ghsetstatus: needs-implementation -> given-up