aboutsummaryrefslogtreecommitdiff
path: root/docs/cpt.org
diff options
context:
space:
mode:
authormerakor <cem@ckyln.com>2021-03-24 14:14:13 +0000
committermerakor <cem@ckyln.com>2021-03-24 14:14:13 +0000
commite14c9753fd878fef8e7caa670cb2feae139ba417 (patch)
treed38f900e7788e8ea1db2285fc71fce5edf52c635 /docs/cpt.org
parent63e3a1277c6c9705853197c058fb23f5fc6eaa3a (diff)
downloadcpt-e14c9753fd878fef8e7caa670cb2feae139ba417.tar.gz
docs: add pkg_build() documentation
FossilOrigin-Name: ad53d4a9b1bb065a017b65dd1f5a7c32575df62aaec44807b5e2d3f59b4f05d4
Diffstat (limited to 'docs/cpt.org')
-rw-r--r--docs/cpt.org15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/cpt.org b/docs/cpt.org
index 0e59114..8f96981 100644
--- a/docs/cpt.org
+++ b/docs/cpt.org
@@ -941,6 +941,21 @@ Obviously, package functions are the most important ones for =cpt-lib=, those
are the ones you will use to build, to query, to manipulate, or to otherwise
interact with packages.
+*** =pkg_build()=
+
+This function builds all given packages. It resolves dependencies for the given
+packages, lints the package, extracts its sources and runs the ~build~ script.
+
+#+begin_src sh
+# 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_src
+
*** =pkg_owner()=
:PROPERTIES:
:DESCRIPTION: Check which package owns the given file