libdevuansdk

commit afa49d23cea1f8536e73eee0189c62da36face6f
parent a0376ae65be7e973ae0e259e4ea738d5f85461ed
Author: parazyd <parazyd@dyne.org>
Date:   Wed,  8 Jun 2016 14:25:00 +0200

documentation

Diffstat:
A
doc/README-configuration.md
 | 
0

A
doc/README-functions.md
 | 
46
++++++++++++++++++++++++++++++++++++++++++++++
A
doc/WORKFLOW.md
 | 
7
+++++++

3 files changed, 53 insertions(+), 0 deletions(-)
diff --git a/doc/README-configuration.md b/doc/README-configuration.md
diff --git a/doc/README-functions.md b/doc/README-functions.md
@@ -0,0 +1,46 @@
+libdevuansdk functions
+----------------------
+
+# zlibs/helpers
+
+## escalate()
+Acts as a wrapper for escalating user privilege when needed. Takes two
+arguments, user and command in the style of:
+
+```
+escalate root "chroot /somewhere/where/i/want/to"
+```
+
+## mountdevproc()
+Mounts `/dev`, `/dev/pts`, and `/proc` where needed. Takes one argument, which
+is the path containing those. ex:
+
+```
+mountdevproc /path/to/bootstrapped/chroot
+```
+
+## umountdevproc()
+Does the opposite of `mountdevproc`.
+
+# zlibs/sysconf
+NOTE: everything is printed to stdout. Pipe or redirect if you want to write on
+storage.
+
+## conf_print_debconf()
+Prints out the config for console-common setup
+
+## conf_print_fstab()
+Prints the fstab
+
+## conf_print_hostname()
+Prints the hostname. Requires `$os` to be declared.
+
+## conf_print_hosts
+Prints default `/etc/hosts`
+
+## conf_print_networkifaces()
+Prints the `/etc/network/interfaces` file
+
+## conf_print_sourceslist()
+Prints default `/etc/apt/sources.list`
+
diff --git a/doc/WORKFLOW.md b/doc/WORKFLOW.md
@@ -0,0 +1,7 @@
+# STAGE ONE
+Build a basic system ready to be customized/shipped and pack it into a tarball
+for later use.
+
+# STAGE TWO
+
+# STAGE THREE