summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-10-22 16:32:07 +0000
committerng0 <ng0@n0.is>2019-10-22 16:32:07 +0000
commitdd8a253d1a3cc778410eeca48a763d106a396c44 (patch)
treeb07c5b7f8baa9d9cba1ba541885f69ecac2018e1 /README
parentaae7f00662634db4c314acfa6d8008e0322a21f5 (diff)
downloadbuild-common-dd8a253d1a3cc778410eeca48a763d106a396c44.tar.gz
build-common-dd8a253d1a3cc778410eeca48a763d106a396c44.tar.bz2
build-common-dd8a253d1a3cc778410eeca48a763d106a396c44.zip
start to make sh code reusable.
hope the configure doesn't blow up, locally tested. this now requires readlink(1) and so far only serves the purpose to get to call python indepent of setting a python version in a Makefile for which with the current layout we'd have to run configure which would require python. Or we just record the location or name of the python executable in config.mk...
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
index 2b2e5a5..ee915fc 100644
--- a/README
+++ b/README
@@ -12,3 +12,20 @@ A repository using these build-system files should be structured as follows:
Makefile and configure.py can also be placed directly into the root of the
repository. However, this might lead to errors when "make" can be invoked
before bootstrap and configure has been done.
+
+
+directory structure:
+--------------------
+
+conf:
+- contains mixed configuration data, mostly for linters and editors
+
+sh:
+- contains shell script code in reusable, importable pieces,
+ usually one function per file and files named after their
+ function.
+ the sh/lib.sh folder contains library code.
+ the sh/bin.sh folder contains executable scripts which can be
+ used for various functions.
+ Current caveat: the files all have to be included. shell independent
+ detection of real pathnames is tricky.