Permalink
Browse files

Update text concerning remote repositories and repository catalogues.

Fixes Issue #298
  • Loading branch information...
1 parent 2286938 commit d5a67a1acae9ca7b91f69af605a4ed42dea0ea39 @infracaninophile infracaninophile committed Jul 7, 2012
Showing with 40 additions and 38 deletions.
  1. +5 −5 README.md
  2. +3 −3 docs/GOALS
  3. +15 −15 pkg/main.c
  4. +1 −1 pkg/pkg-fetch.8
  5. +4 −4 pkg/pkg-update.8
  6. +2 −2 pkg/pkg-upgrade.8
  7. +2 −3 pkg/pkg.8
  8. +8 −5 pkg/update.c
View
@@ -152,12 +152,12 @@ show pkg-message, ...
`pkg add` can install a package archive from the local disk, or from a
remote FTP/HTTP server.
-If only a package name is given, it will search the remote repository
+If only a package name is given, it will search the repository catalogue
and download and install the package if it exists. The dependencies will be
downloaded and installed first.
This is possible because we have the dependency information in the
-remote repository database.
+catalogue of the remote repository.
`pkg add` will check if the user attempts to install a package built for another
arch or release.
@@ -292,7 +292,7 @@ your remote server with packages, like for example (or use ${LOCALBASE}/etc/pkg.
# export PACKAGESITE=http://example.org/pkgng-repo/
-Then fetch the remote repository using the below command:
+Then fetch the repository catalogue using the command:
# pkg update
@@ -308,7 +308,7 @@ pkgng is also able to work with multiple remote repositories. In the previous se
we are using only a single remote repository, which is defined by the _PACKAGESITE_ option.
In order to be able to work with multiple remote repositories and instead of changing
-each time _PACKAGESITE_, you can tell *pkg(1)* to work in multi-repos mode as well.
+_PACKAGESITE_ each time, you can tell *pkg(1)* to work in multi-repos mode as well.
To do this, simply enable multi-repos in *pkg.conf(5)* like this:
@@ -327,7 +327,7 @@ the *default* repository.
It is important that you always define a *default* repository - this is the repository that is being
used when no remote repositories are specified via the `-r <repo>` flag.
-Next, fetch the remote repositories:
+Next, fetch all the repository catalogues:
# pkg update
View
@@ -62,7 +62,7 @@ Table of Contents:
- search:
- - Will search the remote repository to provide information
+ - Will search the repository catalogue to provide information
to the users.
- info:
@@ -87,8 +87,8 @@ Table of Contents:
- upgrade:
- - Will compute the remote repository to check if there are new upgrades
- available and apply them.
+ - Will examine the repository catalogue to check if there are
+ any upgrades available and apply them.
- update:
View
@@ -62,29 +62,29 @@ static struct commands {
{ "add", "Registers a package and installs it on the system", exec_add, usage_add},
{ "audit", "Reports vulnerable packages", exec_audit, usage_audit},
{ "autoremove", "Removes orphan packages", exec_autoremove, usage_autoremove},
- { "backup", "Backup and restore the local package database", exec_backup, usage_backup},
- { "check", "Check for missing dependencies and database consistency", exec_check, usage_check},
+ { "backup", "Backs-up and restores the local package database", exec_backup, usage_backup},
+ { "check", "Checks for missing dependencies and database consistency", exec_check, usage_check},
{ "clean", "Cleans old packages from the cache", exec_clean, usage_clean},
{ "create", "Creates software package distributions", exec_create, usage_create},
{ "delete", "Deletes packages from the database and the system", exec_delete, usage_delete},
{ "fetch", "Fetches packages from a remote repository", exec_fetch, usage_fetch},
{ "help", "Displays help information", exec_help, usage_help},
- { "info", "Displays information for installed packages", exec_info, usage_info},
+ { "info", "Displays information about installed packages", exec_info, usage_info},
{ "install", "Installs packages from remote package repositories", exec_install, usage_install},
- { "query", "Query information for installed packages", exec_query, usage_query},
- { "search", "Performs a search in remote package repositories", exec_search, usage_search},
- { "set", "Modify local database informations", exec_set, usage_set},
- { "register", "Registers a package into the local package database", exec_register, usage_register},
+ { "query", "Queries information about installed packages", exec_query, usage_query},
+ { "search", "Performs a search of package repository catalogues", exec_search, usage_search},
+ { "set", "Modifies information about packages in the local database", exec_set, usage_set},
+ { "register", "Registers a package into the local database", exec_register, usage_register},
{ "remove", "Deletes packages from the database and the system", exec_delete, usage_delete},
- { "repo", "Creates a package database repository", exec_repo, usage_repo},
- { "rquery", "Query information from the remote repository", exec_rquery, usage_rquery},
- { "shell", "Open a debug shell", exec_shell, usage_shell},
- { "shlib", "Displays which package links against a specific shared library", exec_shlib, usage_shlib},
- { "stats", "Display package database statistics", exec_stats, usage_stats},
- { "update", "Updates remote package repository databases", exec_update, usage_update},
+ { "repo", "Creates a package repository catalogue", exec_repo, usage_repo},
+ { "rquery", "Queries information in repository catalogues", exec_rquery, usage_rquery},
+ { "shell", "Opens a debug shell", exec_shell, usage_shell},
+ { "shlib", "Displays which packages link against a specific shared library", exec_shlib, usage_shlib},
+ { "stats", "Displays package database statistics", exec_stats, usage_stats},
+ { "update", "Updates package repository catalogues", exec_update, usage_update},
{ "updating", "Displays UPDATING information for a package", exec_updating, usage_updating},
- { "upgrade", "Performs upgrades of package software distributions", exec_upgrade, usage_upgrade},
- { "version", "Summarize installed versions of packages", exec_version, usage_version},
+ { "upgrade", "Performs upgrades of packaged software distributions", exec_upgrade, usage_upgrade},
+ { "version", "Displays the versions of installed packages", exec_version, usage_version},
{ "which", "Displays which package installed a specific file", exec_which, usage_which},
};
View
@@ -33,7 +33,7 @@ is used to download binary packages from a remote repository.
.Pp
One or more packages, or patterns can be specified.
.Pp
-The remote repository will automatically be updated using
+Repository catalogues will be updated automatically using
.Xr pkg-update 8 .
This can be disabled with the
.Fl L
View
@@ -33,20 +33,20 @@ Updates to catalogues are normally downloaded
only when the master copy on the remote package repository is newer than the
local copy.
.Pp
-The remote repository catalogues to be updated are defined in the
+The repository catalogues to be updated are defined in the
.Xr pkg.conf 5
file.
.Pp
-It is always a good idea to update your remote package
-repository catalogues before doing a remote install via
+It is always a good idea to update your package repository catalogues
+before doing a remote install via
.Xr pkg-install 8
or upgrades via
.Xr pkg-upgrade 8 .
.Pp
.Ss Signed repositories
If the repository catalogue is signed and
.Ev PUBKEY
-is defined, it will be verified after being downloaded.
+is defined, the signature will be verified after download.
See
.Xr pkg.conf 5
for more information.
View
@@ -28,15 +28,15 @@
.Nm
is used for upgrading of package software distributions.
.Pp
-Currently only one remote package repository database can be
+Currently only one package repository can be
used during package upgrades as defined by the environment variable
.Ev PACKAGESITE .
.Pp
Soon enough
.Nm
will be able to perform package upgrades from multiple repositories.
.Pp
-The remote repository will automatically be updated using
+Repository catalogues will automatically be updated using
.Xr pkg-update 8 .
This can be disabled with the
.Fl L
View
@@ -111,9 +111,8 @@ Display information about installed packages.
Install a package from a remote package repository.
If a package is found in more than one remote repository,
then installation happens from the first one.
-If a package
-fails to fetch from the remote repository, the next one in
-the list is tried, until the package is fetched.
+Downloading a package is tried from each package repository in turn,
+until the package is successfully fetched.
.It Ic query
Query information about installed packages.
.It Ic register
View
@@ -41,7 +41,7 @@
#include "pkgcli.h"
/**
- * Fetch remote databases.
+ * Fetch repository calalogues.
*/
int
pkgcli_update(bool force) {
@@ -52,7 +52,7 @@ pkgcli_update(bool force) {
int retcode;
if (!quiet)
- printf("Updating remote repository\n");
+ printf("Updating repository catalogue\n");
pkg_config_bool(PKG_CONFIG_MULTIREPOS, &multi_repos);
@@ -72,7 +72,8 @@ pkgcli_update(bool force) {
retcode = pkg_update("repo", packagesite, force);
if (retcode == EPKG_UPTODATE) {
if (!quiet)
- printf("Remote repository up-to-date, no need to upgrade\n");
+ printf("Repository catalogue is up-to-date, "
+ "no need to fetch fresh copy\n");
retcode = EPKG_OK;
}
} else {
@@ -84,7 +85,9 @@ pkgcli_update(bool force) {
retcode = pkg_update(repo_name, packagesite, force);
if (retcode == EPKG_UPTODATE) {
if (!quiet)
- printf("%s repository up-to-date, no need to upgrade\n", repo_name);
+ printf("%s repository catalogue is "
+ "up-to-date, no need to fetch "
+ "fresh copy\n", repo_name);
retcode = EPKG_OK;
}
}
@@ -130,7 +133,7 @@ exec_update(int argc, char **argv)
}
if (geteuid() != 0) {
- warnx("Updating the remote database can only be done as root");
+ warnx("Updating repository catalogues can only be done as root");
return (EX_NOPERM);
}

0 comments on commit d5a67a1

Please sign in to comment.