aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabian Groffen <grobian@gentoo.org>2018-12-24 17:02:30 +0100
committerFabian Groffen <grobian@gentoo.org>2018-12-24 17:02:30 +0100
commit6cc0db6da1808164e159ad6f0f6fbc8b623f6fb8 (patch)
tree502d4a1e42def40dcfdd805b523e3e1d83ba0c15
parentrm_rf_at: ensure return code makes sense (diff)
downloadportage-utils-6cc0db6da1808164e159ad6f0f6fbc8b623f6fb8.tar.gz
portage-utils-6cc0db6da1808164e159ad6f0f6fbc8b623f6fb8.tar.bz2
portage-utils-6cc0db6da1808164e159ad6f0f6fbc8b623f6fb8.zip
docs: update
Signed-off-by: Fabian Groffen <grobian@gentoo.org>
-rw-r--r--README.md25
-rw-r--r--TODO.md22
2 files changed, 20 insertions, 27 deletions
diff --git a/README.md b/README.md
index 59692a7..8400c68 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,10 @@
| What | How |
| -------- | --------------------------------------------------------- |
-| HOMEPAGE | https://wiki.gentoo.org/wiki/Portage-utils |
-| GIT | git clone git://anongit.gentoo.org/proj/portage-utils.git |
+| HOMEPAGE | https://wiki.gentoo.org/wiki/Q\_applets |
+| GIT | https://anongit.gentoo.org/git/proj/portage-utils.git |
| VIEWVCS | https://gitweb.gentoo.org/proj/portage-utils.git/ |
+| GITHUB | https://github.com/gentoo/portage-utils |
| STATUS | [![Build Status](https://travis-ci.org/gentoo/portage-utils.svg?branch=master)](https://travis-ci.org/gentoo/portage-utils) [![Coverity Status](https://scan.coverity.com/projects/9213/badge.svg)](https://scan.coverity.com/projects/gentoo-portage-utils) |
portage-utils is a small set of utilities for working with Portage, Gentoo
@@ -18,40 +19,41 @@ Alternatively, run `configure` followed by `make`.
## Helping out
-There's a large [TODO](./TODO.md) list with various ideas for improvements.
+There's a large [TODO](./TODO.md) list with various ideas for
+improvements. File a bug on Gentoo's Bugzilla, or use Github's issues
+and pull requests.
There's also a [HACKING](./HACKING.md) doc to help you get started.
## Examples
-* find elf files linking to old openssl<br>
+* find elf files linking to old openssl (using app-misc/pax-utils)<br>
`qlist -ao | scanelf -BqgN libssl.so.0.9.6 -f -`
-* print a package.use<br>
+* produce a package.use file for currently installed packages<br>
`qlist -UCq | grep ' ' > package.use`
* find orphan files not owned by any package in /lib and /usr/lib<br>
`qfile -o {,/usr}/lib/*`
* get PORTDIR<br>
- `DEBUG=: ./q -Ch 2>&1 | grep ^PORTDIR | awk '{print $3}`
+ `env DEBUG=: q -Ch 2>&1 | grep ^PORTDIR | awk '{print $3}`
* Verify all packages<br>
- `qcheck -a`
+ `qcheck`
## Contact
### Bugs
Please file bugs at:
- https://bugs.gentoo.org/enter_bug.cgi?product=Portage%20Development&format=guided
-
-Use Component of "Third-Party Tools".
+ https://bugs.gentoo.org/enter_bug.cgi?product=Portage%20Development&component=Tools&format=guided
### Developers
* solar@gentoo.org
* vapier@gentoo.org
+* grobian@gentoo.org
## Notes
@@ -59,6 +61,9 @@ Use Component of "Third-Party Tools".
Having your PORTDIR and VDB on the right file system helps dramatically
+Nowadays this should rarely matter, but on smaller scale (embedded) or
+older hardware, consider the following.
+
IDE raid with PORTDIR on reiserfs:
```sh
diff --git a/TODO.md b/TODO.md
index 86ebbd7..24e5eca 100644
--- a/TODO.md
+++ b/TODO.md
@@ -1,9 +1,9 @@
# Common
- unify match behavior:
- - default *foo*
+ - default \*foo\*
- -e foo
- - -r (-R ?) regexp foo.*
+ - -r (-R ?) regexp foo.\*
- disable color when tty = NULL; may break less?
@@ -25,10 +25,9 @@
- only 32bit values are supported for revision (-r#)
- only 64bit values are supported in any individual version component
- foo-(1234)_alpha(56789)
+ foo-(1234)\_alpha(56789)
- these limits should not be an issue for all practical purposes
- need to handle USE deps like: cat/pkg-123[foo(+)]
-- show support slots like: qmerge -U automake:1.12
# qmerge
@@ -40,21 +39,14 @@
- gpg sign the packages file (before compression)
- binary vdb (sqlite) ... talk to zmedico
- remote vdb
-- don't bother emitting any "DIR" entries to CONTENTS ?
- - auto rmdir any empty dirs
-- avoid Packages fetching all the damned time
- parallel fetch tbz2s
-- check order of pkg_{pre,post}{inst,rm} during install, unmerge, and upgrade
-- env is not saved/restored between pkg_{pre,post}inst (see portage and REPO_LAYOUT_CONF_WARN)
+- check order of pkg\_{pre,post}{inst,rm} during install, unmerge, and upgrade
+- env is not saved/restored between pkg\_{pre,post}inst (see portage and REPO\_LAYOUT\_CONF\_WARN)
- support installing via path to tbz2 package
- support TTL field in binpkgs file
- merge duplicate atoms on the CLI (`qmerge -Uq nano nano nano`)
- unmerging should clean out @world set
-# qcache
-
-- need to convert it to new metadata/md5 style
-
# qdepends
- support querying uninstalled packages (via metadata/md5 cache)
@@ -71,7 +63,3 @@
# qsync
- rewrite to use new repos.conf standard
-
-# qlist
-
-- support atoms instead of exact matches