Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 99780 - equery manpage in -l (list) paragraph - big "typo", minor unclarity
Summary: equery manpage in -l (list) paragraph - big "typo", minor unclarity
Status: RESOLVED FIXED
Alias: None
Product: Portage Development
Classification: Unclassified
Component: Tools (show other bugs)
Hardware: All All
: High trivial (vote)
Assignee: Portage Tools Team
URL:
Whiteboard:
Keywords: InVCS
Depends on:
Blocks:
 
Reported: 2005-07-21 04:26 UTC by Gasper Azman
Modified: 2006-01-17 19:30 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Gasper Azman 2005-07-21 04:26:36 UTC
equery manpage has a sintax-related error in the 'list' paragraph.

$ man equery:
------ related snippet -------
      list <local-opts> pkgspec
              This command lists packages matching pkgspec in a user-specified 
combination  of
              installed  packages,  packages which are not installed, the
portage tree, and the
              portage overlay tree.

              <local-opts> must include not include only -I; if -I is used, -p
and/or  -o  must
              be also.  By default, only installed packages are searched.  -o
searches only the
              overlay tree [and possibly installed packages], not the main
portage tree.

              -i, --installed search installed packages (default)
              -I, --exclude-installed do not search installed packages
              -p, --portage-tree also search in portage tree (/usr/portage)
              -o, --overlay-tree also search in overlay tree (/usr/local/portage)
------ end of snippet ------

the <local-opts> paragraph, line 1:
>>> <local-opts> must include not include only -I;
This is clearly a typo, the 1st "include" should be dropped. However, for
greater clarity, I propose this change:
<<< <local-opts> must not include not include only -I; if -I is used, -p and/or
-o must be also. BY default, only installed packages are searched.
>>> if <local-opts> includes -I, -p and/or -o must also be present in order to
define the search area, since the default one (-i, installed packages) is disabled.

It is not clear to me whether -I actually excludes installed packages from the
search results, making the -Ipo option generate a search area like this
[(portage_tree U overlay_tree) - installed_packages] or so that it doesn't
substract installed_packages, it just doesn't include them explicitly.
The unclarity comes from this sentence: "-o searches only the overlay tree [and
possibly installed packages], not the main portage tree." The behavior should be
as stated above with the fancy expression.

If the manpage is wrong (and I am right), i propose the whole <local-opts>
paragraph be replaced with this:

<local-opts> can be a combination of the following: either -i or -I, and
optionally -p and/or -o. If -I is specified, at least one of -p and -o must be
present, in order to define the search area, because the default (-i, installed
packages) is not present. -p includes the whole portage tree, -o includes the
whole overlay tree, and -I substracts all installed packages from the results.

Tell me what you think :D

Gasper

Reproducible: Always
Steps to Reproduce:
1.
2.
3.
Comment 1 Paul Varner (RETIRED) gentoo-dev 2005-11-11 21:23:50 UTC
Fixed in >=gentoolkit-0.2.1_pre9
Comment 2 Paul Varner (RETIRED) gentoo-dev 2006-01-17 19:30:23 UTC
Fix is in gentoolkit-0.2.1