From e14c9753fd878fef8e7caa670cb2feae139ba417 Mon Sep 17 00:00:00 2001
From: merakor <cem@ckyln.com>
Date: Wed, 24 Mar 2021 14:14:13 +0000
Subject: docs: add pkg_build() documentation

FossilOrigin-Name: ad53d4a9b1bb065a017b65dd1f5a7c32575df62aaec44807b5e2d3f59b4f05d4
---
 docs/cpt.texi | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'docs/cpt.texi')

diff --git a/docs/cpt.texi b/docs/cpt.texi
index 71b4e69..bd397ec 100644
--- a/docs/cpt.texi
+++ b/docs/cpt.texi
@@ -127,6 +127,7 @@ System Functions
 
 Package Functions
 
+* @samp{pkg_build()}::
 * @samp{pkg_owner()}::           Check which package owns the given file
 * @samp{pkg_isbuilt()}::         Check whether the given package is built
 * @samp{pkg_lint()}::            Check whether a package directory fits the standards
@@ -1096,6 +1097,7 @@ are the ones you will use to build, to query, to manipulate, or to otherwise
 interact with packages.
 
 @menu
+* @samp{pkg_build()}::
 * @samp{pkg_owner()}::           Check which package owns the given file
 * @samp{pkg_isbuilt()}::         Check whether the given package is built
 * @samp{pkg_lint()}::            Check whether a package directory fits the standards
@@ -1104,6 +1106,22 @@ interact with packages.
 * @samp{pkg_gentree}::           Generate a dependency tree for the given package
 @end menu
 
+@node @samp{pkg_build()}
+@subsection @samp{pkg_build()}
+
+This function builds all given packages. It resolves dependencies for the given
+packages, lints the package, extracts its sources and runs the @code{build} script.
+
+@example
+# Example
+
+# Create the cache directories first, this is where the package will be built.
+create_cache
+
+# Build the package(s) you want to build.
+pkg_build cpt
+@end example
+
 @node @samp{pkg_owner()}
 @subsection @samp{pkg_owner()}
 
-- 
cgit v1.2.3