diff options
| -rw-r--r-- | doc/Makefile | 8 | ||||
| -rw-r--r-- | doc/libsolv-bindings.3 | 62 | ||||
| -rw-r--r-- | doc/libsolv-bindings.txt | 66 | ||||
| -rw-r--r-- | doc/libsolv-constantids.3 | 20 | ||||
| -rw-r--r-- | doc/libsolv-constantids.txt | 16 | ||||
| -rw-r--r-- | doc/libsolv-history.3 | 6 | ||||
| -rw-r--r-- | doc/libsolv-history.txt | 2 | ||||
| -rw-r--r-- | doc/libsolv.3 | 6 | ||||
| -rw-r--r-- | doc/libsolv.txt | 2 |
9 files changed, 98 insertions, 90 deletions
diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..eb6005a --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,8 @@ + +man: libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 + +.SUFFIXES: .3 .txt + +.txt.3: + a2x -f manpage $< + diff --git a/doc/libsolv-bindings.3 b/doc/libsolv-bindings.3 index a44fc0f..07e8024 100644 --- a/doc/libsolv-bindings.3 +++ b/doc/libsolv-bindings.3 @@ -2,12 +2,12 @@ .\" Title: libsolv-bindings .\" Author: [see the "Author" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> -.\" Date: 06/07/2013 +.\" Date: 06/10/2013 .\" Manual: LIBSOLV .\" Source: libsolv .\" Language: English .\" -.TH "LIBSOLV\-BINDINGS" "3" "06/07/2013" "libsolv" "LIBSOLV" +.TH "LIBSOLV\-BINDINGS" "3" "06/10/2013" "libsolv" "LIBSOLV" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -87,7 +87,7 @@ my \fI$iter\fR \fB=\fR \fI$pool\fR\fB\->solvables_iter()\fR; .sp As a downside of this approach, iterator objects can have no attributes\&. .sp -If an array needs to be passwd to a method it is usually done by reference, if a method returns an array it returns it on the stack: +If an array needs to be passed to a method it is usually done by reference, if a method returns an array it returns it on the stack: .sp .if n \{\ .RS 4 @@ -461,7 +461,7 @@ Promote the epoch of the providing dependency to the requesting dependency if it .PP \fBPOOL_FLAG_FORBIDSELFCONFLICTS\fR .RS 4 -Disallow the installation of packages that conflict with themselfs\&. Debian always allowd self\-conflicting packages, rpm used to forbid them but switched to also allowing them recently\&. +Disallow the installation of packages that conflict with themselves\&. Debian always allows self\-conflicting packages, rpm used to forbid them but switched to also allowing them recently\&. .RE .PP \fBPOOL_FLAG_OBSOLETEUSESPROVIDES\fR @@ -486,7 +486,7 @@ Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if packages of the sa .PP \fBPOOL_FLAG_NOINSTALLEDOBSOLETES\fR .RS 4 -New versions of rpm consider the obsoletes of installed packages when checking for dependency, thus you may not install a package that is obsoleted by some other installed package, unless you also deinstall the other package\&. +New versions of rpm consider the obsoletes of installed packages when checking for dependency, thus you may not install a package that is obsoleted by some other installed package, unless you also erase the other package\&. .RE .PP \fBPOOL_FLAG_HAVEDISTEPOCH\fR @@ -619,7 +619,7 @@ Set the architecture for your system\&. The architecture is used to determine wh .RE .\} .sp -Add a Repository with the specified name to the pool\&. The reposiory is empty on creation, use the repository methods to populate it with packages\&. +Add a Repository with the specified name to the pool\&. The repository is empty on creation, use the repository methods to populate it with packages\&. .sp .if n \{\ .RS 4 @@ -707,7 +707,7 @@ Some package managers like rpm allow dependencies on files contained in other pa .RE .\} .sp -Create the internal \(lqwhatprovides\(rq hash over all of the provides of all packages\&. This method must be called before doing any lookups on provides\&. It\(cqs encuraged to do it right after all repos are set up, usually right after the call to addfileprovides()\&. +Create the internal \(lqwhatprovides\(rq hash over all of the provides of all packages\&. This method must be called before doing any lookups on provides\&. It\(cqs encouraged to do it right after all repos are set up, usually right after the call to addfileprovides()\&. .sp .if n \{\ .RS 4 @@ -767,7 +767,7 @@ my \fI$bool\fR \fB=\fR \fI$pool\fR\fB\->isknownarch(\fR\fI$id\fR\fB)\fR; .RE .\} .sp -Return true if the specified Id describs a known architecture\&. +Return true if the specified Id describes a known architecture\&. .sp .if n \{\ .RS 4 @@ -888,7 +888,7 @@ Get/Set fixed jobs stored in the pool\&. Those jobs are automatically appended t Set the callback function called when repository metadata needs to be loaded on demand\&. To make use of this feature, you need to create repodata stubs that tell the library which data is available but not loaded\&. If later on the data needs to be accessed, the callback function is called with a repodata argument\&. You can then load the data (maybe fetching it first from an remote server)\&. The callback should return true if the data has been made available\&. .SS "DATA RETRIEVAL METHODS" .sp -In the following functions, the \fIkeyname\fR argument describes what to retrive\&. For the standard cases you can use the available Id constants\&. For example, +In the following functions, the \fIkeyname\fR argument describes what to retrieve\&. For the standard cases you can use the available Id constants\&. For example, .sp .if n \{\ .RS 4 @@ -1272,7 +1272,7 @@ Same as calling the str() method\&. The dependencies are equal if they are part of the same pool and have the same ids\&. .SH "THE REPOSITORY CLASS" .sp -A Repository describes a group of packages, normally comming from the same source\&. Repositories are created by the Pool\(cqs add_repo() method\&. +A Repository describes a group of packages, normally coming from the same source\&. Repositories are created by the Pool\(cqs add_repo() method\&. .SS "ATTRIBUTES" .sp .if n \{\ @@ -1324,7 +1324,7 @@ The repositories name\&. To libsolv, the name is just a string with no specific .RS 4 .\} .nf -\fBint prioprity;\fR /* read/write */ +\fBint priority;\fR /* read/write */ \fI$repo\fR\fB\->{priority}\fR \fIrepo\fR\fB\&.priority\fR \fIrepo\fR\fB\&.priority\fR @@ -1339,7 +1339,7 @@ The priority of the repository\&. A higher number means that packages of this re .RS 4 .\} .nf -\fBint subprioprity;\fR /* read/write */ +\fBint subpriority;\fR /* read/write */ \fI$repo\fR\fB\->{subpriority}\fR \fIrepo\fR\fB\&.subpriority\fR \fIrepo\fR\fB\&.subpriority\fR @@ -1398,7 +1398,7 @@ Return a Datapos object of the repodata\(cqs metadata\&. You can use the lookup .PP \fBREPO_REUSE_REPODATA\fR .RS 4 -Reuse the last repository data aera (\(lqrepodata\(rq) instead of creating a new one\&. +Reuse the last repository data area (\(lqrepodata\(rq) instead of creating a new one\&. .RE .PP \fBREPO_NO_INTERNALIZE\fR @@ -1590,7 +1590,7 @@ my \fI$repodata\fR \fB=\fR \fI$repo\fR\fB\->first_repodata()\fR; .RE .\} .sp -Checks if all repodatas but the first repodata are extensions, and return the first repodata if this is the case\&. Useful if you want to do a store/retrive sequence on the repository to reduce the memory using and enable paging, as this does not work if the rpository contains multiple non\-extension repodata areas\&. +Checks if all repodatas but the first repodata are extensions, and return the first repodata if this is the case\&. Useful if you want to do a store/retrieve sequence on the repository to reduce the memory using and enable paging, as this does not work if the repository contains multiple non\-extension repodata areas\&. .sp .if n \{\ .RS 4 @@ -2240,7 +2240,7 @@ my \fI@deps\fR \fB=\fR \fI$solvable\fR\fB\->lookup_deparray(\fR\fI$keyname\fR\fB .RE .\} .sp -Generic lookup methods\&. Retrieve data stored for the specific keyname\&. The lookup_idarray() method will return an array of Ids, use lookup_deparray if you want an array of Dependency objects instead\&. Some Id arrays contain two parts of data divided by a specific marker, for example the provides array uses the SOLVABLE_FILEMARKER id to store both the ids provided by the package and the ids added by the addfileprovides method\&. The default, \-1, translates to the correct marker for the keyname and returns the first part of the array, use 1 to select the second part or 0 to retrive all ids including the marker\&. +Generic lookup methods\&. Retrieve data stored for the specific keyname\&. The lookup_idarray() method will return an array of Ids, use lookup_deparray if you want an array of Dependency objects instead\&. Some Id arrays contain two parts of data divided by a specific marker, for example the provides array uses the SOLVABLE_FILEMARKER id to store both the ids provided by the package and the ids added by the addfileprovides method\&. The default, \-1, translates to the correct marker for the keyname and returns the first part of the array, use 1 to select the second part or 0 to retrieve all ids including the marker\&. .sp .if n \{\ .RS 4 @@ -2997,7 +2997,7 @@ Fix dependency problems of matching installed packages\&. The default is to igno .PP \fBSOLVER_USERINSTALLED\fR .RS 4 -The matching installed packages are considered to be installed by a user, thus not installed to fulfil some dependency\&. This is needed input for the calculation of unneeded packages for jobs that have the SOLVER_CLEANDEPS flag set\&. +The matching installed packages are considered to be installed by a user, thus not installed to fulfill some dependency\&. This is needed input for the calculation of unneeded packages for jobs that have the SOLVER_CLEANDEPS flag set\&. .RE .PP \fBSOLVER_JOBMASK\fR @@ -3009,7 +3009,7 @@ Action modifier constants: .PP \fBSOLVER_WEAK\fR .RS 4 -Makes the job a weak job\&. The solver tries to fulfil weak jobs, but does not report a problem if it is not possible to do so\&. +Makes the job a weak job\&. The solver tries to fulfill weak jobs, but does not report a problem if it is not possible to do so\&. .RE .PP \fBSOLVER_ESSENTIAL\fR @@ -3211,7 +3211,7 @@ So if a package "screen\-1\-1" is installed for the x86_64 architecture and vers Dependency solving is what this library is about\&. A solver object is needed for solving to store the result of the solver run\&. The solver object can be used multiple times for different jobs, reusing it allows the solver to re\-use the dependency rules it already computed\&. .SS "CONSTANTS" .sp -Flags to modify some of the solver\(cqs behaviour: +Flags to modify some of the solver\(cqs behavior: .PP \fBSOLVER_FLAG_ALLOW_DOWNGRADE\fR .RS 4 @@ -3235,7 +3235,7 @@ Allow the solver to change the name of an installed package, i\&.e\&. install a .PP \fBSOLVER_FLAG_ALLOW_UNINSTALL\fR .RS 4 -Allow the solver to deinstall installed packages to fulfil the jobs\&. This flag also includes the above flags\&. You may want to set this flag if you only have SOLVER_ERASE jobs, as in that case it\(cqs better for the user to check the transaction overview instead of approving every single package that needs to be deinstalled\&. +Allow the solver to erase installed packages to fulfill the jobs\&. This flag also includes the above flags\&. You may want to set this flag if you only have SOLVER_ERASE jobs, as in that case it\(cqs better for the user to check the transaction overview instead of approving every single package that needs to be erased\&. .RE .PP \fBSOLVER_FLAG_NO_UPDATEPROVIDE\fR @@ -3255,7 +3255,7 @@ Do not process optional (aka weak) dependencies\&. .PP \fBSOLVER_FLAG_ADD_ALREADY_RECOMMENDED\fR .RS 4 -Install recommened or supplemented packages even if they have no connection to the current transaction\&. You can use this feature to implement a simple way for the user to install new recommended packages that were not available in the past\&. +Install recommended or supplemented packages even if they have no connection to the current transaction\&. You can use this feature to implement a simple way for the user to install new recommended packages that were not available in the past\&. .RE .PP \fBSOLVER_FLAG_NO_INFARCHCHECK\fR @@ -3292,7 +3292,7 @@ A rule to implement the update policy of installed packages\&. Every installed p .PP \fBSOLVER_RULE_FEATURE\fR .RS 4 -Feature rules are fallback rules used when a update rule is disabled\&. They include all packages that may replace the installed package ignoring the update policy, i\&.e\&. they contain downgrades, arch changes and so on\&. Without them, the solver would simply deinstall installed packages if their update rule gets disabled\&. +Feature rules are fallback rules used when a update rule is disabled\&. They include all packages that may replace the installed package ignoring the update policy, i\&.e\&. they contain downgrades, arch changes and so on\&. Without them, the solver would simply erase installed packages if their update rule gets disabled\&. .RE .PP \fBSOLVER_RULE_JOB\fR @@ -3312,7 +3312,7 @@ Infarch rules are also negative assertions, they disallow the installation of pa .PP \fBSOLVER_RULE_CHOICE\fR .RS 4 -Choice rules are used to make sure that the solver preferes updating to installing different packages when some dependency is provided by multiple packages with different names\&. The solver may always break choice rules, so you will not see them when a problem is found\&. +Choice rules are used to make sure that the solver prefers updating to installing different packages when some dependency is provided by multiple packages with different names\&. The solver may always break choice rules, so you will not see them when a problem is found\&. .RE .PP \fBSOLVER_RULE_LEARNT\fR @@ -3329,7 +3329,7 @@ This rule was added to prevent the installation of a package of an architecture .PP \fBSOLVER_RULE_RPM_NOTHING_PROVIDES_DEP\fR .RS 4 -The package contanis a required dependency which was not provided by any package\&. +The package contains a required dependency which was not provided by any package\&. .RE .PP \fBSOLVER_RULE_RPM_PACKAGE_REQUIRES\fR @@ -3406,7 +3406,7 @@ The solver ask for permission before changing the vendor of installed packages\& .PP \fBPOLICY_ILLEGAL_NAMECHANGE\fR .RS 4 -The solver ask for permission before replacing an installed packages with a packge that has a different name\&. +The solver ask for permission before replacing an installed packages with a package that has a different name\&. .RE .sp Solution element type constants @@ -3589,7 +3589,7 @@ my \fI$probrule\fR \fB=\fR \fI$problem\fR\fB\->findproblemrule()\fR; .RE .\} .sp -Return the rule that caused the problem\&. Of cource in most situations there is no single responsible rule, but many rules that interconnect with each created the problem\&. Nevertheless, the solver uses some heuristic approch to find a rule that somewhat describes the problem best to the user\&. +Return the rule that caused the problem\&. Of course in most situations there is no single responsible rule, but many rules that interconnect with each created the problem\&. Nevertheless, the solver uses some heuristic approach to find a rule that somewhat describes the problem best to the user\&. .sp .if n \{\ .RS 4 @@ -3903,7 +3903,7 @@ my \fI@solutionelements\fR \fB=\fR \fI$solution\fR\fB\->elements()\fR; .RE .\} .sp -Return an array containing the elements describing what neeeds to be done to implement the specific solution\&. If expandreplaces is true, elements of type SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace elements describing the policy mismatches\&. +Return an array containing the elements describing what needs to be done to implement the specific solution\&. If expandreplaces is true, elements of type SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace elements describing the policy mismatches\&. .sp .if n \{\ .RS 4 @@ -4118,7 +4118,7 @@ This element does nothing\&. Used to map element types that do not match the vie .PP \fBSOLVER_TRANSACTION_INSTALL\fR .RS 4 -This element installes a package\&. +This element installs a package\&. .RE .PP \fBSOLVER_TRANSACTION_ERASE\fR @@ -4454,7 +4454,7 @@ erase B .RE .\} .sp -in active mode\&. If the mode containes SOLVER_TRANSACTION_SHOW_ALL, the passive mode list will be unchanged but the active mode list will just contain A\-2\-1\&. +in active mode\&. If the mode contains SOLVER_TRANSACTION_SHOW_ALL, the passive mode list will be unchanged but the active mode list will just contain A\-2\-1\&. .SH "THE TRANSACTIONCLASS CLASS" .sp Objects of this type are returned by the classify() Transaction method\&. @@ -4861,7 +4861,7 @@ Flush the file\&. Returns false if there was an error\&. Flushing a closed file Close the file\&. This is needed for languages like Ruby, that do not destruct objects right after they are no longer referenced\&. In that case, it is good style to close open files so that the file descriptors are freed right away\&. Returns false if there was an error\&. .SH "THE REPODATA CLASS" .sp -The Repodata stores attrinbutes for packages and the repository itself, each repository can have multiple repodata areas\&. You normally only need to directly access them if you implement lazy downloading of repository data\&. Repodata areas are created by calling the repository\(cqs add_repodata() method or by using repo_add methods without the REPO_REUSE_REPODATA or REPO_USE_LOADING flag\&. +The Repodata stores attributes for packages and the repository itself, each repository can have multiple repodata areas\&. You normally only need to directly access them if you implement lazy downloading of repository data\&. Repodata areas are created by calling the repository\(cqs add_repodata() method or by using repo_add methods without the REPO_REUSE_REPODATA or REPO_USE_LOADING flag\&. .SS "ATTRIBUTES" .sp .if n \{\ @@ -5025,7 +5025,7 @@ my \fI$chksum\fR \fB=\fR \fI$data\fR\fB\->lookup_checksum(\fR\fI$solvid\fR\fB,\f .RE .\} .sp -Lookup functions\&. Return the data element stored in the specified solvable\&. The methods probably only make sense to retrive data from the special SOLVID_META solvid that stores repodata meta information\&. +Lookup functions\&. Return the data element stored in the specified solvable\&. The methods probably only make sense to retrieve data from the special SOLVID_META solvid that stores repodata meta information\&. .SS "DATA STORAGE METHODS" .sp .if n \{\ @@ -5122,7 +5122,7 @@ my \fI$handle\fR \fB=\fR \fI$data\fR\fB\->new_handle()\fR; Data storage methods\&. Probably only useful to store data in the special SOLVID_META solvid that stores repodata meta information\&. Note that repodata areas can have their own Id pool (see the REPO_LOCALPOOL flag), so be careful if you need to store ids\&. Arrays are created by calling the add function for every element\&. A flexarray is an array of sub\-structures, call new_handle to create a new structure, use the handle as solvid to fill the structure with data and call add_flexarray to put the structure in an array\&. .SH "THE DATAPOS CLASS" .sp -Datapos objects describe a specific position in the repository data area\&. Thus they are only valid until the repository is modified in some way\&. Datapos objects can be created by the pos() and parentpos() methods of a Datamatch object or by accesing the \(lqmeta\(rq attribute of a repository\&. +Datapos objects describe a specific position in the repository data area\&. Thus they are only valid until the repository is modified in some way\&. Datapos objects can be created by the pos() and parentpos() methods of a Datamatch object or by accessing the \(lqmeta\(rq attribute of a repository\&. .SS "ATTRIBUTES" .sp .if n \{\ diff --git a/doc/libsolv-bindings.txt b/doc/libsolv-bindings.txt index 840214e..3d1f65a 100644 --- a/doc/libsolv-bindings.txt +++ b/doc/libsolv-bindings.txt @@ -44,7 +44,7 @@ tied arrays so that it is possible to iterate with a for() statement: As a downside of this approach, iterator objects can have no attributes. -If an array needs to be passwd to a method it is usually done by reference, +If an array needs to be passed to a method it is usually done by reference, if a method returns an array it returns it on the stack: my @problems = $solver->solve(\@jobs); @@ -243,8 +243,8 @@ Define which repository contains all the installed packages. in old rpm versions, modern systems should never need this. *POOL_FLAG_FORBIDSELFCONFLICTS*:: - Disallow the installation of packages that conflict with themselfs. - Debian always allowd self-conflicting packages, rpm used to forbid + Disallow the installation of packages that conflict with themselves. + Debian always allows self-conflicting packages, rpm used to forbid them but switched to also allowing them recently. *POOL_FLAG_OBSOLETEUSESPROVIDES*:: @@ -277,7 +277,7 @@ Define which repository contains all the installed packages. New versions of rpm consider the obsoletes of installed packages when checking for dependency, thus you may not install a package that is obsoleted by some other installed package, unless you - also deinstall the other package. + also erase the other package. *POOL_FLAG_HAVEDISTEPOCH*:: Mandriva added a new field called distepoch that gets checked in @@ -360,7 +360,7 @@ which packages are installable. It defaults to the result of ``uname -m''. repo = pool.add_repo(name) repo = pool.add_repo(name) -Add a Repository with the specified name to the pool. The reposiory is empty +Add a Repository with the specified name to the pool. The repository is empty on creation, use the repository methods to populate it with packages. Repoiterator repos_iter() @@ -413,7 +413,7 @@ repository is loaded and addfileprovides is called. Create the internal ``whatprovides'' hash over all of the provides of all packages. This method must be called before doing any lookups on provides. -It's encuraged to do it right after all repos are set up, usually right after +It's encouraged to do it right after all repos are set up, usually right after the call to addfileprovides(). Solvable *whatprovides(DepId dep) @@ -446,7 +446,7 @@ for more information. bool = pool.isknownarch(id) bool = pool.isknownarch?(id) -Return true if the specified Id describs a known architecture. +Return true if the specified Id describes a known architecture. Solver Solver() my $solver = $pool->Solver(); @@ -517,7 +517,7 @@ The callback should return true if the data has been made available. === DATA RETRIEVAL METHODS === -In the following functions, the _keyname_ argument describes what to retrive. +In the following functions, the _keyname_ argument describes what to retrieve. For the standard cases you can use the available Id constants. For example, $solv::SOLVABLE_SUMMARY @@ -723,7 +723,7 @@ ids. THE REPOSITORY CLASS -------------------- -A Repository describes a group of packages, normally comming from the same +A Repository describes a group of packages, normally coming from the same source. Repositories are created by the Pool's add_repo() method. === ATTRIBUTES === @@ -750,7 +750,7 @@ The id of the repository. The repositories name. To libsolv, the name is just a string with no specific meaning. - int prioprity; /* read/write */ + int priority; /* read/write */ $repo->{priority} repo.priority repo.priority @@ -759,7 +759,7 @@ The priority of the repository. A higher number means that packages of this repository will be chosen over other repositories, even if they have a greater package version. - int subprioprity; /* read/write */ + int subpriority; /* read/write */ $repo->{subpriority} repo.subpriority repo.subpriority @@ -795,7 +795,7 @@ timestamp. === CONSTANTS === *REPO_REUSE_REPODATA*:: - Reuse the last repository data aera (``repodata'') instead of creating a new + Reuse the last repository data area (``repodata'') instead of creating a new one. *REPO_NO_INTERNALIZE*:: @@ -916,9 +916,9 @@ no holes, i.e. they have consecutive ids. repodata = repo.first_repodata() Checks if all repodatas but the first repodata are extensions, and return the -first repodata if this is the case. Useful if you want to do a store/retrive +first repodata if this is the case. Useful if you want to do a store/retrieve sequence on the repository to reduce the memory using and enable paging, as -this does not work if the rpository contains multiple non-extension repodata +this does not work if the repository contains multiple non-extension repodata areas. Selection Selection(int setflags = 0) @@ -1258,7 +1258,7 @@ for example the provides array uses the SOLVABLE_FILEMARKER id to store both the ids provided by the package and the ids added by the addfileprovides method. The default, -1, translates to the correct marker for the keyname and returns the first part of the -array, use 1 to select the second part or 0 to retrive all ids +array, use 1 to select the second part or 0 to retrieve all ids including the marker. const char *lookup_location(unsigned int *OUTPUT); @@ -1742,7 +1742,7 @@ Action constants: *SOLVER_USERINSTALLED*:: The matching installed packages are considered to be installed by a user, thus - not installed to fulfil some dependency. This is needed input for the calculation + not installed to fulfill some dependency. This is needed input for the calculation of unneeded packages for jobs that have the SOLVER_CLEANDEPS flag set. *SOLVER_JOBMASK*:: @@ -1751,7 +1751,7 @@ Action constants: Action modifier constants: *SOLVER_WEAK*:: - Makes the job a weak job. The solver tries to fulfil weak jobs, but does not + Makes the job a weak job. The solver tries to fulfill weak jobs, but does not report a problem if it is not possible to do so. *SOLVER_ESSENTIAL*:: @@ -1926,7 +1926,7 @@ re-use the dependency rules it already computed. === CONSTANTS === -Flags to modify some of the solver's behaviour: +Flags to modify some of the solver's behavior: *SOLVER_FLAG_ALLOW_DOWNGRADE*:: Allow the solver to downgrade packages without asking for confirmation @@ -1950,11 +1950,11 @@ Flags to modify some of the solver's behaviour: package. This option is on by default. *SOLVER_FLAG_ALLOW_UNINSTALL*:: - Allow the solver to deinstall installed packages to fulfil the jobs. + Allow the solver to erase installed packages to fulfill the jobs. This flag also includes the above flags. You may want to set this flag if you only have SOLVER_ERASE jobs, as in that case it's better for the user to check the transaction overview instead of - approving every single package that needs to be deinstalled. + approving every single package that needs to be erased. *SOLVER_FLAG_NO_UPDATEPROVIDE*:: If multiple packages obsolete an installed package, the solver checks @@ -1974,7 +1974,7 @@ Flags to modify some of the solver's behaviour: Do not process optional (aka weak) dependencies. *SOLVER_FLAG_ADD_ALREADY_RECOMMENDED*:: - Install recommened or supplemented packages even if they have no + Install recommended or supplemented packages even if they have no connection to the current transaction. You can use this feature to implement a simple way for the user to install new recommended packages that were not available in the past. @@ -2014,7 +2014,7 @@ Basic rule types: Feature rules are fallback rules used when a update rule is disabled. They include all packages that may replace the installed package ignoring the update policy, i.e. they contain downgrades, arch - changes and so on. Without them, the solver would simply deinstall + changes and so on. Without them, the solver would simply erase installed packages if their update rule gets disabled. *SOLVER_RULE_JOB*:: @@ -2030,7 +2030,7 @@ Basic rule types: architecture. *SOLVER_RULE_CHOICE*:: - Choice rules are used to make sure that the solver preferes updating to + Choice rules are used to make sure that the solver prefers updating to installing different packages when some dependency is provided by multiple packages with different names. The solver may always break choice rules, so you will not see them when a problem is found. @@ -2048,7 +2048,7 @@ Special dependency rule types: architecture that does not work on the system. *SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP*:: - The package contanis a required dependency which was not provided by + The package contains a required dependency which was not provided by any package. *SOLVER_RULE_RPM_PACKAGE_REQUIRES*:: @@ -2116,7 +2116,7 @@ Policy error constants *POLICY_ILLEGAL_NAMECHANGE*:: The solver ask for permission before replacing an installed packages with - a packge that has a different name. + a package that has a different name. Solution element type constants @@ -2233,9 +2233,9 @@ Id of the problem. The first problem has Id 1, they are numbered consecutively. probrule = problem.findproblemrule() probrule = problem.findproblemrule() -Return the rule that caused the problem. Of cource in most situations there is no +Return the rule that caused the problem. Of course in most situations there is no single responsible rule, but many rules that interconnect with each created the -problem. Nevertheless, the solver uses some heuristic approch to find a rule +problem. Nevertheless, the solver uses some heuristic approach to find a rule that somewhat describes the problem best to the user. Rule *findallproblemrules(bool unfiltered = 0) @@ -2410,7 +2410,7 @@ Id of the solution. The first solution has Id 1, they are numbered consecutively solutionelements = solution.elements() solutionelements = solution.elements() -Return an array containing the elements describing what neeeds to be done to +Return an array containing the elements describing what needs to be done to implement the specific solution. If expandreplaces is true, elements of type SOLVER_SOLUTION_REPLACE will be replaced by one or more elements replace elements describing the policy mismatches. @@ -2549,7 +2549,7 @@ Transaction element types, both active and passive match the view mode. *SOLVER_TRANSACTION_INSTALL*:: - This element installes a package. + This element installs a package. *SOLVER_TRANSACTION_ERASE*:: This element erases a package. @@ -2777,7 +2777,7 @@ in passive mode, but update A-2-1 (other: A-1-1) erase B -in active mode. If the mode containes SOLVER_TRANSACTION_SHOW_ALL, the +in active mode. If the mode contains SOLVER_TRANSACTION_SHOW_ALL, the passive mode list will be unchanged but the active mode list will just contain A-2-1. @@ -3007,7 +3007,7 @@ Returns false if there was an error. THE REPODATA CLASS ------------------ -The Repodata stores attrinbutes for packages and the repository itself, each +The Repodata stores attributes for packages and the repository itself, each repository can have multiple repodata areas. You normally only need to directly access them if you implement lazy downloading of repository data. Repodata areas are created by calling the repository's add_repodata() method @@ -3100,7 +3100,7 @@ the same id. chksum = data.lookup_checksum(solvid, keyname) Lookup functions. Return the data element stored in the specified solvable. -The methods probably only make sense to retrive data from the special +The methods probably only make sense to retrieve data from the special SOLVID_META solvid that stores repodata meta information. === DATA STORAGE METHODS === @@ -3155,7 +3155,7 @@ THE DATAPOS CLASS Datapos objects describe a specific position in the repository data area. Thus they are only valid until the repository is modified in some way. Datapos objects can be created by the pos() and parentpos() methods of -a Datamatch object or by accesing the ``meta'' attribute of a repository. +a Datamatch object or by accessing the ``meta'' attribute of a repository. === ATTRIBUTES === diff --git a/doc/libsolv-constantids.3 b/doc/libsolv-constantids.3 index cb35aeb..31a9e3b 100644 --- a/doc/libsolv-constantids.3 +++ b/doc/libsolv-constantids.3 @@ -2,12 +2,12 @@ .\" Title: libsolv-constantids .\" Author: [see the "Author" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> -.\" Date: 06/07/2013 +.\" Date: 06/10/2013 .\" Manual: LIBSOLV .\" Source: libsolv .\" Language: English .\" -.TH "LIBSOLV\-CONSTANTIDS" "3" "06/07/2013" "libsolv" "LIBSOLV" +.TH "LIBSOLV\-CONSTANTIDS" "3" "06/10/2013" "libsolv" "LIBSOLV" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,7 @@ The name of the always installed "system" solvable\&. .RE .SH "SOLVABLE ATTRIBUTES" .sp -These are Ids for keyname of attributes\&. They can be used in the lookup and storage functions to select the correct attribute in the solvable\&. The describtions below describe the intended semantics of the values stored in the attribute with the keyname\&. +These are Ids for keyname of attributes\&. They can be used in the lookup and storage functions to select the correct attribute in the solvable\&. The descriptions below describe the intended semantics of the values stored in the attribute with the keyname\&. .PP \fBSOLVABLE_NAME "solvable:name"\fR .RS 4 @@ -149,7 +149,7 @@ list of keyword string IDs used for tagging this package\&. .PP \fBSOLVABLE_LICENSE "solvable:license"\fR .RS 4 -The jicense of this package\&. +The license of this package\&. .RE .PP \fBSOLVABLE_BUILDTIME "solvable:buildtime"\fR @@ -305,12 +305,12 @@ The category field for patch solvables\&. Should be named \(lqupdate:category\(r .PP \fBUPDATE_REBOOT "update:reboot"\fR .RS 4 -If this attribute is present the sytem should be rebooted after the update is installed\&. +If this attribute is present the system should be rebooted after the update is installed\&. .RE .PP \fBUPDATE_RESTART "update:restart"\fR .RS 4 -If this attribute is present the software managemer should be run again after the update is installed\&. +If this attribute is present the software manager should be run again after the update is installed\&. .RE .PP \fBUPDATE_RELOGIN "update:relogin"\fR @@ -440,12 +440,12 @@ A release string for proudct registering\&. .PP \fBPUBKEY_KEYID "pubkey:keyid"\fR .RS 4 -The keyid of a pubkey, consiting of 8 bytes in hex\&. +The keyid of a pubkey, consisting of 8 bytes in hex\&. .RE .PP \fBPUBKEY_FINGERPRINT "pubkey:fingerprint"\fR .RS 4 -The fingerprint of a pubkey, usualy a sha1sum in hex\&. Old V3 RSA keys use an md5sum instead\&. +The fingerprint of a pubkey, usually a sha1sum in hex\&. Old V3 RSA keys use an md5sum instead\&. .RE .PP \fBPUBKEY_EXPIRES "pubkey:expires"\fR @@ -508,7 +508,7 @@ Used for binary packages that contain the package sources\&. .PP \fBARCH_NOSRC "nosrc"\fR .RS 4 -Used for binary packages that contain some of thepackage sources, but not all files (because of restrictions)\&. +Used for binary packages that contain some of the package sources, but not all files (because of restrictions)\&. .RE .PP \fBARCH_NOARCH "noarch"\fR @@ -568,7 +568,7 @@ This is a another hack to implement the SUSE product buddy system\&. Please igno .PP \fBSOLVABLE_PREREQMARKER "solvable:prereqmarker"\fR .RS 4 -This marker partitions the normal require dependencies from the prerequires\&. It is not needed for dependency solving, but it is used by the transaction ordering algorthim when a dependency cycle needs to be broken (non\-prereq deps get broken first)\&. +This marker partitions the normal require dependencies from the prerequires\&. It is not needed for dependency solving, but it is used by the transaction ordering algorithm when a dependency cycle needs to be broken (non\-prereq deps get broken first)\&. .RE .PP \fBSOLVABLE_FILEMARKER "solvable:filemarker"\fR diff --git a/doc/libsolv-constantids.txt b/doc/libsolv-constantids.txt index f4d59a9..22badc1 100644 --- a/doc/libsolv-constantids.txt +++ b/doc/libsolv-constantids.txt @@ -33,7 +33,7 @@ SOLVABLE ATTRIBUTES ------------------- These are Ids for keyname of attributes. They can be used in the lookup and storage functions to select the correct attribute in the -solvable. The describtions below describe the intended semantics +solvable. The descriptions below describe the intended semantics of the values stored in the attribute with the keyname. *SOLVABLE_NAME "solvable:name"*:: @@ -118,7 +118,7 @@ of the values stored in the attribute with the keyname. list of keyword string IDs used for tagging this package. *SOLVABLE_LICENSE "solvable:license"*:: - The jicense of this package. + The license of this package. *SOLVABLE_BUILDTIME "solvable:buildtime"*:: The seconds since the unix epoch when the binary package was created. @@ -237,11 +237,11 @@ SPECIAL SOLVABLEATTRIBUTES ``update:category'' instead. *UPDATE_REBOOT "update:reboot"*:: - If this attribute is present the sytem should be rebooted after + If this attribute is present the system should be rebooted after the update is installed. *UPDATE_RESTART "update:restart"*:: - If this attribute is present the software managemer should be run + If this attribute is present the software manager should be run again after the update is installed. *UPDATE_RELOGIN "update:relogin"*:: @@ -322,10 +322,10 @@ SPECIAL SOLVABLEATTRIBUTES A release string for proudct registering. *PUBKEY_KEYID "pubkey:keyid"*:: - The keyid of a pubkey, consiting of 8 bytes in hex. + The keyid of a pubkey, consisting of 8 bytes in hex. *PUBKEY_FINGERPRINT "pubkey:fingerprint"*:: - The fingerprint of a pubkey, usualy a sha1sum in hex. Old V3 RSA keys + The fingerprint of a pubkey, usually a sha1sum in hex. Old V3 RSA keys use an md5sum instead. *PUBKEY_EXPIRES "pubkey:expires"*:: @@ -371,7 +371,7 @@ Predefined architecture values for commonly used architectures. Used for binary packages that contain the package sources. *ARCH_NOSRC "nosrc"*:: - Used for binary packages that contain some of thepackage sources, + Used for binary packages that contain some of the package sources, but not all files (because of restrictions). *ARCH_NOARCH "noarch"*:: @@ -427,7 +427,7 @@ different semantics. *SOLVABLE_PREREQMARKER "solvable:prereqmarker"*:: This marker partitions the normal require dependencies from the prerequires. It is not needed for dependency solving, but it is - used by the transaction ordering algorthim when a dependency cycle + used by the transaction ordering algorithm when a dependency cycle needs to be broken (non-prereq deps get broken first). *SOLVABLE_FILEMARKER "solvable:filemarker"*:: diff --git a/doc/libsolv-history.3 b/doc/libsolv-history.3 index 103d415..ff22f86 100644 --- a/doc/libsolv-history.3 +++ b/doc/libsolv-history.3 @@ -2,12 +2,12 @@ .\" Title: libsolv-history .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> -.\" Date: 06/07/2013 +.\" Date: 06/10/2013 .\" Manual: LIBSOLV .\" Source: libsolv .\" Language: English .\" -.TH "LIBSOLV\-HISTORY" "3" "06/07/2013" "libsolv" "LIBSOLV" +.TH "LIBSOLV\-HISTORY" "3" "06/10/2013" "libsolv" "LIBSOLV" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,7 +28,7 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -libsolv-history \- how the libsolv library came into existance +libsolv-history \- how the libsolv library came into existence .SH "HISTORY" .sp This project was started in May 2007 when the zypp folks decided to switch to a database to speed up installation\&. As I am not a big fan of databases, I (mls) wondered if there would be really some merit of using one for solving, as package dependencies of all packages have to be read in anyway\&. diff --git a/doc/libsolv-history.txt b/doc/libsolv-history.txt index 67b1d5c..73b65ab 100644 --- a/doc/libsolv-history.txt +++ b/doc/libsolv-history.txt @@ -5,7 +5,7 @@ LIBSOLV-HISTORY(3) NAME ---- -libsolv-history - how the libsolv library came into existance +libsolv-history - how the libsolv library came into existence HISTORY ------- diff --git a/doc/libsolv.3 b/doc/libsolv.3 index f29fb58..36b9680 100644 --- a/doc/libsolv.3 +++ b/doc/libsolv.3 @@ -2,12 +2,12 @@ .\" Title: libsolv .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/> -.\" Date: 06/07/2013 +.\" Date: 06/10/2013 .\" Manual: LIBSOLV .\" Source: libsolv .\" Language: English .\" -.TH "LIBSOLV" "3" "06/07/2013" "libsolv" "LIBSOLV" +.TH "LIBSOLV" "3" "06/10/2013" "libsolv" "LIBSOLV" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -35,7 +35,7 @@ The libsolv documentation is split into multiple parts: .PP \fBlibsolv\-history\fR .RS 4 -how the libsolv library came into existance +how the libsolv library came into existence .RE .PP \fBlibsolv\-constantids\fR diff --git a/doc/libsolv.txt b/doc/libsolv.txt index 502e134..d7d5b39 100644 --- a/doc/libsolv.txt +++ b/doc/libsolv.txt @@ -12,7 +12,7 @@ DOCUMENTATION The libsolv documentation is split into multiple parts: *libsolv-history*:: - how the libsolv library came into existance + how the libsolv library came into existence *libsolv-constantids*:: fixed Ids for often used strings |