Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 123327 - portage-utils documentation
Summary: portage-utils documentation
Status: RESOLVED FIXED
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: New Documentation (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-02-18 17:22 UTC by Łukasz Damentko (RETIRED)
Modified: 2006-05-12 10:15 UTC (History)
2 users (show)

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


Attachments
portage-utils.xml (portage-utils.xml,5.64 KB, text/plain)
2006-02-18 17:23 UTC, Łukasz Damentko (RETIRED)
Details
portage-utils.xml (portage-utils.xml,5.62 KB, text/plain)
2006-02-18 17:39 UTC, Marcelo Goes (RETIRED)
Details
portage-utils.xml.patch (portage-utils.xml.patch,3.17 KB, patch)
2006-04-30 07:42 UTC, nm (RETIRED)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Łukasz Damentko (RETIRED) gentoo-dev 2006-02-18 17:22:38 UTC
As our users tend to migrate away from gentoolkit to much faster alternative called portage-utils, i've decided to write a short guide about it, showing some of its most useful functions.

Josh Saddler (nightmorph) improved the language already (big thanks for that) - now i wait for people willing to proofread it and propose any changes necessary.

File is in the attachment. Thanks in advance for taking a look at it. :)
Comment 1 Łukasz Damentko (RETIRED) gentoo-dev 2006-02-18 17:23:45 UTC
Created attachment 80136 [details]
portage-utils.xml
Comment 2 Łukasz Damentko (RETIRED) gentoo-dev 2006-02-18 17:26:58 UTC
HTML version is here: http://dev.gentoo.org/~rane/portage-utils.html
Comment 3 Marcelo Goes (RETIRED) gentoo-dev 2006-02-18 17:39:56 UTC
Created attachment 80137 [details]
portage-utils.xml

My revision.

Some language fixes:
- saying something is faster and the other one is slower is redundant ;-)
- fixed a few prepositions
- title uniformity

Also, I removed the summary chapter. I moved the "gentoolkit is still useful" recommendation to the top and killed the other part, which was a repetition of what was already said.

Good job :-)

Cheers,
Marcelo
Comment 4 Łukasz Damentko (RETIRED) gentoo-dev 2006-02-18 19:02:40 UTC
Comment on attachment 80136 [details]
portage-utils.xml

Big thanks Marcelo.
Let's consider the version you attached as the "current" one. :)
Comment 5 solar (RETIRED) gentoo-dev 2006-02-19 06:35:59 UTC
Pepe Deluxe Black Cadillac

portage-utils is a collection of very fast utilities written in C,
which are meant to replace their counterparts included in gentoolkit.

---- eeek I want to be very careful about saying replace.

The goal is not to replace anything in gentoolkit. It's just an
alternative mainly targeted for use by scripts. For example calling an
equery 300 times in a row would be painful. There are quote a few things
that portage-utils does not do now that it's python counterparts may.
For example we don't look at eclasses at all.

Conditional expressions such as [[ $PV == "x.x.x" ]] && IUSE="$IUSE blah"
for sure wont be evaluated correctly.

Code listing 2.1: Finding the package to which a file belongs
# qfile /etc/fonts/fonts.conf

It also accepts basenames and can print versions.
# qfile fonts.conf -v

Code listing 2.4: Listing files which belong to an ebuild file.
By default that cmd would use regexp matching. The example should use
qlist -e flag (for exact matching)

When quse is given two or more -v -v it will color highlight the files
provided by package by type. (dirs are ignored unless you pass -dos)

Code listing 2.2: Checking package integrity

'When doing a qhceck -a' The python package is expected to fail with a
bunch of *pyo files not matching. python gets bytecode happy. compiles
py objects before install. installs them.  Then sees the mtime has
changed and re compiles them again right afterwords.


Anyway these are just a few mental notes that come to mind when 
quickly glancing over the last .xml attachment.

Thanks for taking the initiative on this Rane.
Comment 6 nm (RETIRED) gentoo-dev 2006-04-30 07:42:28 UTC
Created attachment 85833 [details, diff]
portage-utils.xml.patch

This guide looks good to me. I've attached a patch that tightens it up just a tiny bit further, and also makes it proper GuideXML. rane, please review and comment, and then I'll be happy to add it to the tree. :)
Comment 7 nm (RETIRED) gentoo-dev 2006-04-30 07:42:54 UTC
CCing GDP.
Comment 8 Łukasz Damentko (RETIRED) gentoo-dev 2006-04-30 09:31:09 UTC
This doc has fallen down pretty low on my TODO list, so i'm grateful that you've decided to revive it. It looks very tidy now, thanks for your input and apologies for writing "Josh" instead of "Joshua" in there. :)

As far as i'm concerned, it's ready to go.
Comment 9 solar (RETIRED) gentoo-dev 2006-04-30 11:49:04 UTC
06:45PM <CIA-14> nightmorph * gentoo/xml/htdocs/doc/en/portage-utils.xml: rane's 
brand spanking new portage-utils doc is now here, closes bug 123327
Comment 10 nm (RETIRED) gentoo-dev 2006-04-30 11:57:03 UTC
Okay, it's in the repo and metadoc has been updated. Blame me for any massive breakages in the tree. :D

rane, thanks for a great guide. thanks to solar and vanquirius for reviewing the guide, too.
Comment 11 solar (RETIRED) gentoo-dev 2006-05-01 07:59:49 UTC
Yikes guys..
The doc is incorrect. I clearly stated on this bug that they are in no
way ment as a replacement of the python counterparts. You guys put me in
a very awkward spot by publishing that doc as saying they are ment to
replace. Please correct it.
Comment 12 Xavier Neys (RETIRED) gentoo-dev 2006-05-01 08:19:31 UTC
Ooops, I've rephrased the text at the beginning.
Leaving open until can someone check your other comments.
Sorry about that.
Comment 13 nm (RETIRED) gentoo-dev 2006-05-01 08:36:20 UTC
Well, neysx's changes look good to me. Opening it back up to the rest of the GDP in case anyone else has any comments.
Comment 14 nm (RETIRED) gentoo-dev 2006-05-12 10:15:13 UTC
Heh, somehow this was missed to be closed again. neysx's fixes were made awhile ago.