aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cpt.org16
-rw-r--r--docs/cpt.texi12
-rw-r--r--docs/cpt.txt50
3 files changed, 57 insertions, 21 deletions
diff --git a/docs/cpt.org b/docs/cpt.org
index caa35c9..9107604 100644
--- a/docs/cpt.org
+++ b/docs/cpt.org
@@ -495,7 +495,6 @@ license: MIT
maintainer: Linux User <linux-user@example.com>
#+end_example
-
** post-install
:PROPERTIES:
:DESCRIPTION: The post-installation script
@@ -925,7 +924,7 @@ This function was taken from [[https://github.com/ko1nksm/readlinkf][POSIX sh re
=readlink= is also not defined by POSIX, so this function uses =ls= to follow
symbolic links until it reaches the actual file.
-** TODO System Functions
+** System Functions
:PROPERTIES:
:DESCRIPTION: Functions to manipulate your system
:END:
@@ -947,7 +946,7 @@ following order:
The program called for this operation can be overridden using the ~$CPT_SU~
variable.
-** TODO Package Functions
+** Package Functions
:PROPERTIES:
:DESCRIPTION: Manipulate, or query anything related to packages
:END:
@@ -971,7 +970,16 @@ create_cache
pkg_build cpt
#+end_src
-*** TODO =pkg_depends()=
+*** =pkg_depends()=
+
+This function calculates the dependencies for the requested package, returning
+the variable ~$deps~. This variable can then be passed to [[=pkg_order()=][pkg_order()]] in order
+to generate an ordered list for building packages.
+
+*** =pkg_order()=
+
+This function receives package names and returns ~$order~ and ~$redro~ variables
+that can be used for building and removing packages.
*** =pkg_owner()=
:PROPERTIES:
diff --git a/docs/cpt.texi b/docs/cpt.texi
index 7b04cbb..a25b622 100644
--- a/docs/cpt.texi
+++ b/docs/cpt.texi
@@ -130,6 +130,7 @@ Package Functions
* @samp{pkg_build()}::
* @samp{pkg_depends()}::
+* @samp{pkg_order()}::
* @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
@@ -1118,6 +1119,7 @@ interact with packages.
@menu
* @samp{pkg_build()}::
* @samp{pkg_depends()}::
+* @samp{pkg_order()}::
* @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
@@ -1146,6 +1148,16 @@ pkg_build cpt
@node @samp{pkg_depends()}
@subsection @samp{pkg_depends()}
+This function calculates the dependencies for the requested package, returning
+the variable @code{$deps}. This variable can then be passed to @ref{@samp{pkg_order()}, , pkg@math{_order}()} in order
+to generate an ordered list for building packages.
+
+@node @samp{pkg_order()}
+@subsection @samp{pkg_order()}
+
+This function receives package names and returns @code{$order} and @code{$redro} variables
+that can be used for building and removing packages.
+
@node @samp{pkg_owner()}
@subsection @samp{pkg_owner()}
diff --git a/docs/cpt.txt b/docs/cpt.txt
index 57e8c79..c04a52f 100644
--- a/docs/cpt.txt
+++ b/docs/cpt.txt
@@ -60,13 +60,14 @@ _________________
.. 7. Package Functions
..... 1. `pkg_build()'
..... 2. `pkg_depends()'
-..... 3. `pkg_owner()'
-..... 4. `pkg_isbuilt()'
-..... 5. `pkg_lint()'
-..... 6. `pkg_find()'
-..... 7. `pkg_get_base()'
-..... 8. `pkg_gentree()'
-..... 9. `pkg_query_meta()'
+..... 3. `pkg_order()'
+..... 4. `pkg_owner()'
+..... 5. `pkg_isbuilt()'
+..... 6. `pkg_lint()'
+..... 7. `pkg_find()'
+..... 8. `pkg_get_base()'
+..... 9. `pkg_gentree()'
+..... 10. `pkg_query_meta()'
This is a reference document containing both the user-guide and the
@@ -579,7 +580,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
`----
-[pkg_query_meta()] See section 8.7.9
+[pkg_query_meta()] See section 8.7.10
5.7 post-install
@@ -1065,8 +1066,23 @@ development manual for *Carbs Packaging Tools*. For development logs see
8.7.2 `pkg_depends()'
---------------------
+ This function calculates the dependencies for the requested package,
+ returning the variable `$deps'. This variable can then be passed to
+ [pkg_order()] in order to generate an ordered list for building
+ packages.
+
+
+[pkg_order()] See section 8.7.3
-8.7.3 `pkg_owner()'
+
+8.7.3 `pkg_order()'
+-------------------
+
+ This function receives package names and returns `$order' and `$redro'
+ variables that can be used for building and removing packages.
+
+
+8.7.4 `pkg_owner()'
-------------------
This function can be used to determine the owner of a package. The
@@ -1087,7 +1103,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
`----
-8.7.4 `pkg_isbuilt()'
+8.7.5 `pkg_isbuilt()'
---------------------
This function returns with success when the given package has a built
@@ -1095,7 +1111,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
repository.
-8.7.5 `pkg_lint()'
+8.7.6 `pkg_lint()'
------------------
This function checks whether a given package fits the proper package
@@ -1103,7 +1119,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
outright* if it fails.
-8.7.6 `pkg_find()'
+8.7.7 `pkg_find()'
------------------
`pkg_find()' is the tool for searching packages. It accepts up to 3
@@ -1136,7 +1152,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
`----
-8.7.7 `pkg_get_base()'
+8.7.8 `pkg_get_base()'
----------------------
This function returns the base packages as defined in
@@ -1146,7 +1162,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
packages.
-8.7.8 `pkg_gentree()'
+8.7.9 `pkg_gentree()'
---------------------
This function generates a dependency tree for the given package. The
@@ -1166,7 +1182,7 @@ development manual for *Carbs Packaging Tools*. For development logs see
line.
-* 8.7.8.1 Examples
+* 8.7.9.1 Examples
This example uses the `cpt' package for Carbs Linux. The package
itself is listed to depend on `curl' and `rsync'. Here is the output
@@ -1192,8 +1208,8 @@ development manual for *Carbs Packaging Tools*. For development logs see
`----
-8.7.9 `pkg_query_meta()'
-------------------------
+8.7.10 `pkg_query_meta()'
+-------------------------
This function is used to query the [meta file] inside package
directories. It can be used to retrieve information on a package that