aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile10
-rw-r--r--docs/cpt.org28
-rw-r--r--docs/cpt.texi55
-rw-r--r--docs/cpt.txt30
4 files changed, 111 insertions, 12 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 344bd70..3a7dbf0 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,5 +1,5 @@
# Carbs Packaging Tools Documentation
-include ../config.mk
+-include ../config.mk
INSTALL_SH = ../tools/install.sh
all: cpt.txt cpt.texi cpt.info
@@ -22,12 +22,4 @@ clean:
all-clean: clean
rm -f cpt.texi cpt.txt
-install: all
- ${INSTALL_SH} -Dm644 cpt.txt ${DESTDIR}${CPTDOC}/cpt.txt
- ${INSTALL_SH} -Dm644 cpt.info ${DESTDIR}${INFODIR}/cpt.info
-
-uninstall:
- rm -rf ${DESTDIR}${CPTDOC}
- rm -f ${DESTDIR}${INFODIR}/cpt.info
-
.PHONY: all clean all-clean install uninstall
diff --git a/docs/cpt.org b/docs/cpt.org
index 7496ec9..263c547 100644
--- a/docs/cpt.org
+++ b/docs/cpt.org
@@ -184,6 +184,11 @@ to provide detailed information.
#+VINDEX: CPT_DEBUG
If set to 1, temporary directories will not be removed after the operation.
+- ~CPT_DOWNLOADER~ ::
+
+ The tool to be used to download package sources. One of =curl=, =wget=,
+ =wget2=, =axel=, =aria2c=. Defaults to the first one found in that order.
+
- ~CPT_FETCH~ ::
#+VINDEX: CPT_FETCH
@@ -433,6 +438,21 @@ of the package maintainer. Everything in the package directory will also be
added to the package database that is located on =/var/db/cpt/installed=. These
can be patches, configuration files, etc.
+Below is a table that provides a small summary for each file, see the relevant
+section to learn detailed information on each of them.
+
+| File | Language | Executable | Mandatory |
+|--------------+------------------------------------+------------+-----------|
+| build | any | yes | yes |
+| checksums | generated by =cpt-checksum= | no | no |
+| meta | key-value pairs as in RFC822[fn:1] | no | no[fn:2] |
+| depends | custom format | no | no |
+| sources | custom format | no | no |
+| version | custom format | no | yes |
+| message | plaintext | no | no |
+| post-install | any | yes | no |
+| test | any | yes | no |
+
** build
:PROPERTIES:
:DESCRIPTION: The build script
@@ -506,7 +526,7 @@ the sha256 algorithm.
** version
:PROPERTIES:
-:DESCRIPTION: The file containing the version and the release numbers of a package
+:DESCRIPTION: The file containing version information for a package
:END:
The version file includes the version of the software and the release number of
@@ -1233,3 +1253,9 @@ MIT
* {{{index(Concept, cp)}}}
* {{{index(Variable,vr)}}}
+
+* Footnotes
+
+[fn:1] https://datatracker.ietf.org/doc/html/rfc822#section-3.2
+[fn:2] Not mandatory for the packaging system, but mandatory for inclusion in
+the repositories
diff --git a/docs/cpt.texi b/docs/cpt.texi
index 8bdcd99..7487209 100644
--- a/docs/cpt.texi
+++ b/docs/cpt.texi
@@ -77,7 +77,7 @@ Packaging System
* build:: The build script
* sources:: The file containing package sources
* checksums:: The file containing sha256sum of the sources
-* version:: The file containing the version and the release numbers of a package
+* version:: The file containing version information for a package
* depends:: The file containing the dependencies of a package
* meta:: File containing more information on packages
* post-install:: The post-installation script
@@ -299,6 +299,10 @@ set to 0, they will be forced to display them without colours. Otherwise,
@vindex CPT_DEBUG
If set to 1, temporary directories will not be removed after the operation.
+@item @code{CPT_DOWNLOADER}
+The tool to be used to download package sources. One of @samp{curl}, @samp{wget},
+@samp{wget2}, @samp{axel}, @samp{aria2c}. Defaults to the first one found in that order.
+
@item @code{CPT_FETCH}
@vindex CPT_FETCH
If set to 0, @code{cpt-update} will not fetch repositories.
@@ -559,11 +563,58 @@ of the package maintainer. Everything in the package directory will also be
added to the package database that is located on @samp{/var/db/cpt/installed}. These
can be patches, configuration files, etc.
+Below is a table that provides a small summary for each file, see the relevant
+section to learn detailed information on each of them.
+
+@multitable {aaaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa} {aaaaaaaaaa} {aaaaaaaaa}
+@headitem File
+@tab Language
+@tab Executable
+@tab Mandatory
+@item build
+@tab any
+@tab yes
+@tab yes
+@item checksums
+@tab generated by @samp{cpt-checksum}
+@tab no
+@tab no
+@item meta
+@tab key-value pairs as in RFC822@footnote{@uref{https://datatracker.ietf.org/doc/html/rfc822#section-3.2}}
+@tab no
+@tab no@footnote{Not mandatory for the packaging system, but mandatory for inclusion in
+the repositories}
+@item depends
+@tab custom format
+@tab no
+@tab no
+@item sources
+@tab custom format
+@tab no
+@tab no
+@item version
+@tab custom format
+@tab no
+@tab yes
+@item message
+@tab plaintext
+@tab no
+@tab no
+@item post-install
+@tab any
+@tab yes
+@tab no
+@item test
+@tab any
+@tab yes
+@tab no
+@end multitable
+
@menu
* build:: The build script
* sources:: The file containing package sources
* checksums:: The file containing sha256sum of the sources
-* version:: The file containing the version and the release numbers of a package
+* version:: The file containing version information for a package
* depends:: The file containing the dependencies of a package
* meta:: File containing more information on packages
* post-install:: The post-installation script
diff --git a/docs/cpt.txt b/docs/cpt.txt
index 550a6a3..8934c15 100644
--- a/docs/cpt.txt
+++ b/docs/cpt.txt
@@ -244,6 +244,11 @@ development manual for *Carbs Packaging Tools*. For development logs see
If set to 1, temporary directories will not be removed after the
operation.
+ `CPT_DOWNLOADER'
+ The tool to be used to download package sources. One of `curl',
+ `wget', `wget2', `axel', `aria2c'. Defaults to the first one
+ found in that order.
+
`CPT_FETCH'
If set to 0, `cpt-update' will not fetch repositories.
@@ -480,6 +485,21 @@ development manual for *Carbs Packaging Tools*. For development logs see
on `/var/db/cpt/installed'. These can be patches, configuration files,
etc.
+ Below is a table that provides a small summary for each file, see the
+ relevant section to learn detailed information on each of them.
+
+ File Language Executable Mandatory
+ ----------------------------------------------------------------------
+ build any yes yes
+ checksums generated by `cpt-checksum' no no
+ meta key-value pairs as in RFC822[1] no no[2]
+ depends custom format no no
+ sources custom format no no
+ version custom format no yes
+ message plaintext no no
+ post-install any yes no
+ test any yes no
+
5.1 build
~~~~~~~~~
@@ -1300,3 +1320,13 @@ development manual for *Carbs Packaging Tools*. For development logs see
[meta file] See section 5.6
+
+
+
+Footnotes
+_________
+
+[1] <https://datatracker.ietf.org/doc/html/rfc822#section-3.2>
+
+[2] Not mandatory for the packaging system, but mandatory for
+inclusion in the repositories