From: Michael Schroeder <mls@suse.de>
Date: Mon, 12 Dec 2022 14:55:20 +0000 (+0100)
Subject: Document pool.solvableset2str and pool.solvidset2str
X-Git-Tag: 0.7.23~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d276840b586ca38c4a81e2377d64ef78160403f6;p=thirdparty%2Flibsolv.git

Document pool.solvableset2str and pool.solvidset2str
---

diff --git a/doc/gen/libsolv-bindings.3 b/doc/gen/libsolv-bindings.3
index 97d16e40..837927d6 100644
--- a/doc/gen/libsolv-bindings.3
+++ b/doc/gen/libsolv-bindings.3
@@ -1215,6 +1215,21 @@ my \fI@ids\fR \fB=\fR \fI$pool\fR\fB\->get_disabled_list()\fR;
 .\}
 .sp
 Get/set the list of solvables that are not eligible for installation\&. This is basically the inverse of the \(lqconsidered\(rq methods above, i\&.e\&. calling \(lqset_disabled_list()\(rq with an empty list will make all solvables eligible for installation\&. Note you need to recreate the whatprovides hash after changing the list\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+\fBconst char *solvableset2str(Solvable *\fR\fIsolvables\fR\fB)\fR
+my \fI$str\fR \fB=\fR \fI$pool\fR\fB\->solvableset2str(\fR\fI$solvables\fR\fB)\fR;
+\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvableset2str(\fR\fIsolvables\fR\fB)\fR
+\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvableset2str(\fR\fIsolvables\fR\fB)\fR
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Return a string describing a list of solvables\&. The method tries to reduce the output by using version ranges if possible\&.
 .SS "DATA RETRIEVAL METHODS"
 .sp
 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,
@@ -1405,6 +1420,21 @@ Return a string describing the Solvable with the specified id\&. The string cons
 .RS 4
 .\}
 .nf
+\fBconst char *solvidset2str(Id *\fR\fIsolvids\fR\fB)\fR
+my \fI$str\fR \fB=\fR \fI$pool\fR\fB\->solvidset2str(\e\fR\fI@solvids\fR\fB)\fR;
+\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvidset2str(\fR\fIsolvids\fR\fB)\fR
+\fIstr\fR \fB=\fR \fIpool\fR\fB\&.solvidset2str(\fR\fIsolvids\fR\fB)\fR
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Return a string describing a list of solvables\&. The method tries to reduce the output by using version ranges if possible\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
 \fBId str2id(const char *\fR\fIstr\fR\fB, bool\fR \fIcreate\fR \fB= 1)\fR
 my \fI$id\fR \fB=\fR \fIpool\fR\fB\->str2id(\fR\fI$string\fR\fB)\fR;
 \fIid\fR \fB=\fR \fIpool\fR\fB\&.str2id(\fR\fIstring\fR\fB)\fR
diff --git a/doc/libsolv-bindings.txt b/doc/libsolv-bindings.txt
index e1e5a66c..a72a8aee 100644
--- a/doc/libsolv-bindings.txt
+++ b/doc/libsolv-bindings.txt
@@ -688,6 +688,14 @@ basically the inverse of the ``considered'' methods above, i.e. calling
 installation. Note you need to recreate the whatprovides hash after changing the
 list.
 
+	const char *solvableset2str(Solvable *solvables)
+	my $str = $pool->solvableset2str($solvables);
+	str = pool.solvableset2str(solvables)
+	str = pool.solvableset2str(solvables)
+
+Return a string describing a list of solvables. The method tries to reduce
+the output by using version ranges if possible.
+
 === DATA RETRIEVAL METHODS ===
 
 In the following functions, the _keyname_ argument describes what to retrieve.
@@ -781,6 +789,14 @@ Lookup an existing Repository by id. You can also do this by using the
 Return a string describing the Solvable with the specified id. The string
 consists of the name, version, and architecture of the Solvable.
 
+	const char *solvidset2str(Id *solvids)
+	my $str = $pool->solvidset2str(\@solvids);
+	str = pool.solvidset2str(solvids)
+	str = pool.solvidset2str(solvids)
+
+Return a string describing a list of solvables. The method tries to reduce
+the output by using version ranges if possible.
+
 	Id str2id(const char *str, bool create = 1)
 	my $id = pool->str2id($string);
 	id = pool.str2id(string)