@@ -49,7 +49,7 @@ invalid formatting.
4949# Pkgcraft tooling
5050
5151Pkgcraft provides various command-line tools under the ` pk ` command from the
52- pkgcraft-tools crate with metadata generation support via ` pk repo metadata ` .
52+ pkgcraft-tools crate with metadata generation support via ` pk repo metadata regen ` .
5353
5454### Install
5555
@@ -64,15 +64,15 @@ platforms](https://github.com/pkgcraft/pkgcraft/releases).
6464
6565Incrementally generate metadata for the configured ` gentoo ` repo:
6666
67- - ` pk repo metadata gentoo `
67+ - ` pk repo metadata regen gentoo `
6868
6969Target multiple repos including an external repo:
7070
71- - ` pk repo metadata repo1 path/to/repo2 `
71+ - ` pk repo metadata regen repo1 path/to/repo2 `
7272
7373Force a full regen:
7474
75- - ` pk repo metadata -f path/to/repo `
75+ - ` pk repo metadata regen -f path/to/repo `
7676
7777Note that at least one repo must be specified and either be the name of a
7878configured ebuild repo on the system or an external repo pointed to via a path.
@@ -115,21 +115,21 @@ SSD are as follows:
115115
116116- portage: ` egencache -j16 ` -- approximately 5m
117117- pkgcore: ` pmaint regen -t 16 ` -- approximately 1m20s
118- - pkgcraft: ` pk repo metadata -j16 ` -- approximately 30s
118+ - pkgcraft: ` pk repo metadata regen -j16 ` -- approximately 30s
119119
120120For comparative parallel efficiency, pkgcraft achieves the following when using
121121different amounts of jobs:
122122
123- - pkgcraft: ` pk repo metadata -j8 ` -- approximately 40s
124- - pkgcraft: ` pk repo metadata -j4 ` -- approximately 1m
125- - pkgcraft: ` pk repo metadata -j2 ` -- approximately 2m
126- - pkgcraft: ` pk repo metadata -j1 ` -- approximately 4m
123+ - pkgcraft: ` pk repo metadata regen -j8 ` -- approximately 40s
124+ - pkgcraft: ` pk repo metadata regen -j4 ` -- approximately 1m
125+ - pkgcraft: ` pk repo metadata regen -j2 ` -- approximately 2m
126+ - pkgcraft: ` pk repo metadata regen -j1 ` -- approximately 4m
127127
128128For a valid metadata cache requiring no updates:
129129
130130- portage: ` egencache -j16 ` -- approximately 7s
131131- pkgcore: ` pmaint regen -t 16 ` -- approximately 14s
132- - pkgcraft: ` pk repo metadata -j16 ` -- approximately .2s
132+ - pkgcraft: ` pk repo metadata regen -j16 ` -- approximately .2s
133133
134134Note that these results are approximated averages for multiple runs without
135135flushing memory caches. Initial runs of the same commands will be slower from
@@ -139,7 +139,7 @@ From the results above, the effects from one of portage's design flaws can
139139clearly be seen. Any time the bash side of portage is used, a new bash instance
140140is started. The process spawning overhead is so dominant that running
141141` egencache ` using 16 jobs is roughly equivalent to running ` pmaint regen ` using
142- 2-3 jobs and even slower than ` pk repo metadata ` using a single job. Due to
142+ 2-3 jobs and even slower than ` pk repo metadata regen ` using a single job. Due to
143143this, it's best to avoid portage's metadata generation support if performance
144144is a priority, especially on slower hardware.
145145
@@ -210,7 +210,7 @@ verification.
210210
211211### Language bindings
212212
213- Beyond using ` pk repo metadata ` , language bindings should be able to natively
213+ Beyond using ` pk repo metadata regen ` , language bindings should be able to natively
214214trigger metadata regen for relevant repos. This mainly entails adding support
215215into pkgcraft-c and determining what level of runtime feedback it provides,
216216e.g. it could return an iterator of errors, accept a callback function for
0 commit comments