On Thu, 6 Sep 2012 00:05:36 +0100 Justin B Rye wrote: > Francesco Poli wrote: [...] > > We can hopefully compensate the unfortunate misleading nature of the > > --stats long option name with better documentation. > > > > The man page could say something like: > > > > * -S <statuses> | --stats <statuses> > > > > Statuses of the bugs you want to see, separated by commas. Default: [forwarded,done,pending,pending-fixed] > > > > The output of "apt-listbugs -h" could say something like: > > > > -S <statuses> : Statuses of the bugs you want to see > > [forwarded,done,pending,pending-fixed,]. > > > > > > Would this be more understandable? > > It has taken me a long, long time to work out what it meant, so on the > whole I'd have to say no. Well, this sounds as a good criterion. If a native speaker needs to spend a long time to understand a sentence, then that sentence is not really clear! ;-) > I was assuming apt-listbugs was offering to > filter "the bugs you want to see" by status; but that would make the > default a very strange filter! No, it's offering to include these > status-flags in the output; in other words, they're the "Statuses (of > the bugs) that you want to see". Is that right? Actually all the following options are filters on what bugs the user wants to see listed: -s, -T, -S, -B. By default apt-listbugs will show only RC bugs (that is to say, bugs that have one of the following severities: critical, grave, serious). But the -s option can be used to request the display of bugs of all the severities (-s all) or of bugs of one of a specified comma-separated list of desired severities (for instance: -s normal,minor) By default apt-listbugs will show bugs regardless of their tags. With the -T option, the user may request that only bugs having all the specified tags are displayed. For instance, -T security,moreinfo will only show bugs that have both the "security" tag and the "moreinfo" tag. By default apt-listbugs will show bugs regardless of their statuses. With the -S option, the user may request that only bugs having one of the specified statuses are displayed. For instance, -S done,forwarded will only show bugs that are fixed in some version or forwarded to upstream. By default apt-listbugs will show bugs regardless of their bug number. With the -B option, the user may request bugs not belonging to the specified comma-separated list of bug numbers are not displayed. For instance, -B 123456,567890,135792 will only show those three bugs (or possibly only some of those three bugs, if the remaining ones do not satisfy the other conditions...). Please note the slight different behavior of the -T option (where the specified tags are put in AND) with respect to the other mentioned options (where the specified severities, statuses, or bug numbers are put in OR). See also the attached example session transcript. I hope this clarifies how apt-listbugs works with these options. Maybe the man page descriptions for -s, -T, and -S should be made more similar to the description of -B (which is hopefully a bit clearer): * -B <bug#> | --bugs <bug#> By default, apt-listbugs will consider all bugs. This option adds a restriction to the bug numbers you want to see, separated by commas (e.g. 123456,567890,135792). If this option is specified, all other bugs will be ignored. Likewise for the output of "apt-listbugs -h": -B <bug#> : Restrict reporting to specified bug#s only. Please let me know what you think. [...] > > Can I sleep on it? Or maybe hibernate? Sure, I had a similar need, to be frank... Once again, thanks a lot for all the time you are spending helping me! -- http://www.inventati.org/frx/frx-gpg-key-transition-2010.txt New GnuPG key, see the transition document! ..................................................... Francesco Poli . GnuPG key fpr == CA01 1147 9CD2 EFDF FB82 3925 3E1C 27E1 1F69 BFFE
Attachment:
apt-listbugs_session.txt.gz
Description: Binary data
Attachment:
pgpDLaPseljRe.pgp
Description: PGP signature