openSUSE/libsolv
1
0
Fork 0
mirror of https://github.com/openSUSE/libsolv.git synced 2026-02-05 12:45:46 +01:00
Code Issues Releases Activity

Add documentation for solver.get_decision()

Browse Source 
And no longer document the obsolete describe_decision method.
This commit is contained in:
Michael Schroeder
2022-12-13 09:59:58 +01:00
parent 8ad1ab1b34
commit 0af2e55891
2 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
doc/gen/libsolv-bindings.3
View File

@@ -2,12 +2,12 @@
.\" Title: Libsolv-Bindings
.\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 12/12/2022
.\" Date: 12/13/2022
.\" Manual: LIBSOLV
.\" Source: libsolv
.\" Language: English
.\"
.TH "LIBSOLV\-BINDINGS" "3" "12/12/2022" "libsolv" "LIBSOLV"
.TH "LIBSOLV\-BINDINGS" "3" "12/13/2022" "libsolv" "LIBSOLV"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -4339,21 +4339,6 @@ Return the transaction to implement the calculated package changes\&. A transact
.RS 4
.\}
.nf
\fBint\fR \fIreason\fR \fB= describe_decision(Solvable *\fR\fIs\fR\fB, Rule *\fR\fIOUTPUT\fR\fB)\fR
my \fB(\fR\fI$reason\fR\fB,\fR \fI$rule\fR\fB) =\fR \fI$solver\fR\fB\->describe_decision(\fR\fI$solvable\fR\fB)\fR;
\fB(\fR\fIreason\fR\fB,\fR \fIrule\fR\fB) =\fR \fIsolver\fR\fB\&.describe_decision(\fR\fIsolvable\fR\fB)\fR
\fB(\fR\fIreason\fR\fB,\fR \fIrule\fR\fB) =\fR \fIsolver\fR\fB\&.describe_decision(\fR\fIsolvable\fR\fB)\fR
.fi
.if n \{\
.RE
.\}
.sp
Return the reason why a specific solvable was installed or erased\&. For most of the reasons the rule that triggered the decision is also returned\&.
.sp
.if n \{\
.RS 4
.\}
.nf
\fBSolvable *get_recommended(bool\fR \fInoselected\fR\fB=0)\fR
my \fI@solvables\fR \fB=\fR \fI$solver\fR\fB\->get_recommended()\fR;
\fIsolvables\fR \fB=\fR \fIsolver\fR\fB\&.get_recommended()\fR
@@ -4363,7 +4348,7 @@ my \fI@solvables\fR \fB=\fR \fI$solver\fR\fB\->get_recommended()\fR;
.RE
.\}
.sp
Return all solvables that are recommended by the solver run result\&. This includes solvables included in the result, set noselected if you want to filter those\&.
Return all solvables that are recommended by the solver run result\&. This includes solvables included in the result; set noselected if you want to filter those\&.
.sp
.if n \{\
.RS 4
@@ -4378,7 +4363,22 @@ my \fI@solvables\fR \fB=\fR \fI$solver\fR\fB\->get_suggested()\fR;
.RE
.\}
.sp
Return all solvables that are suggested by the solver run result\&. This includes solvables included in the result, set noselected if you want to filter those\&.
Return all solvables that are suggested by the solver run result\&. This includes solvables included in the result; set noselected if you want to filter those\&.
.sp
.if n \{\
.RS 4
.\}
.nf
\fIDecision\fR \fB= get_decision(Solvable *\fR\fIs\fR\fB)\fR
my \fI$decision\fR \fB=\fR \fI$solver\fR\fB\->get_decision(\fR\fI$solvable\fR\fB)\fR;
\fIdecision\fR \fB=\fR \fIsolver\fR\fB\&.get_decision(\fR\fIsolvable\fR\fB)\fR;
\fIdecision\fR \fB=\fR \fIsolver\fR\fB\&.get_decision(\fR\fIsolvable\fR\fB)\fR;
.fi
.if n \{\
.RE
.\}
.sp
Return a decision object that describes why a specific solvable was installed or erased\&. See the Decision class for more information\&.
.sp
.if n \{\
.RS 4
@@ -4393,7 +4393,7 @@ my \fI@decisions\fR \fB=\fR \fI$solver\fR\fB\->get_decisionlist(\fR\fI$solvable\
.RE
.\}
.sp
Return a list of decisions that caused the specific solvable to be installed or erased\&. This is usually more useful than the describe_decision() method, as it returns every involved decision instead of just a single one\&.
Return a list of decisions that caused the specific solvable to be installed or erased\&. This is usually more useful than the get_decision() method, as it returns every involved decision instead of just a single one\&.
.sp
.if n \{\
.RS 4

22
doc/libsolv-bindings.txt
View File

@@ -2664,21 +2664,13 @@ Return the transaction to implement the calculated package changes. A transactio
is available even if problems were found, this is useful for interactive user
interfaces that show both the job result and the problems.
int reason = describe_decision(Solvable *s, Rule *OUTPUT)
my ($reason, $rule) = $solver->describe_decision($solvable);
(reason, rule) = solver.describe_decision(solvable)
(reason, rule) = solver.describe_decision(solvable)
Return the reason why a specific solvable was installed or erased. For most of
the reasons the rule that triggered the decision is also returned.
Solvable *get_recommended(bool noselected=0)
my @solvables = $solver->get_recommended();
solvables = solver.get_recommended()
solvables = solver.get_recommended()
Return all solvables that are recommended by the solver run result. This includes
solvables included in the result, set noselected if you want to filter those.
solvables included in the result; set noselected if you want to filter those.
Solvable *get_suggested(bool noselected=0)
my @solvables = $solver->get_suggested();
@@ -2686,7 +2678,15 @@ solvables included in the result, set noselected if you want to filter those.
solvables = solver.get_suggested()
Return all solvables that are suggested by the solver run result. This includes
solvables included in the result, set noselected if you want to filter those.
solvables included in the result; set noselected if you want to filter those.
Decision = get_decision(Solvable *s)
my $decision = $solver->get_decision($solvable);
decision = solver.get_decision(solvable);
decision = solver.get_decision(solvable);
Return a decision object that describes why a specific solvable was installed or erased.
See the Decision class for more information.
Decision *get_decisionlist(Solvable *s)
my @decisions = $solver->get_decisionlist($solvable);
@@ -2694,7 +2694,7 @@ solvables included in the result, set noselected if you want to filter those.
decisions = solver.get_decisionlist(solvable)
Return a list of decisions that caused the specific solvable to be installed or
erased. This is usually more useful than the describe_decision() method, as it
erased. This is usually more useful than the get_decision() method, as it
returns every involved decision instead of just a single one.
Alternative *alternatives()