summaryrefslogtreecommitdiffhomepage
path: root/PORTING
diff options
context:
space:
mode:
authormidipix <writeonce@midipix.org>2021-04-20 22:15:00 +0000
committermidipix <writeonce@midipix.org>2021-04-20 19:27:27 +0000
commit6f24f4acd132670fd7edcaf2d87c4d465ae359ef (patch)
treefd47234f678f496a42dc98029c077f4ceaf3c186 /PORTING
parentd7918a23986d28fe85d4ecb6021b40969036557c (diff)
downloadtpax-6f24f4acd132670fd7edcaf2d87c4d465ae359ef.tar.bz2
tpax-6f24f4acd132670fd7edcaf2d87c4d465ae359ef.tar.xz
internals: added tpax_getdents() and related PORTING document.
Diffstat (limited to 'PORTING')
-rw-r--r--PORTING21
1 files changed, 21 insertions, 0 deletions
diff --git a/PORTING b/PORTING
new file mode 100644
index 0000000..90dccc1
--- /dev/null
+++ b/PORTING
@@ -0,0 +1,21 @@
+PORTING
+=======
+
+* tpax relies on a modern getdents interface. This interface is invoked
+ via a static inlined wrapper named tpax_getdents(), which is provided
+ by the tpax_getdents_impl.h internal header.
+
+ If your system is not currently covered, you can still easily build
+ and use tpax by (1) providing your own version of tpax_getdents() in
+ a linker archive of any name; and (2) adding -DTPAX_GETDENTS_PORTED
+ to CFLAGS, and the full path to the above archive to LDFLAGS_LAST.
+
+ The wrapper's signature shall then be:
+
+ long tpax_getdents(int, struct dirent *, size_t);
+
+ And your ./configure invocation would then look like:
+
+ CFLAGS=-DTPAX_GETDENTS_PORTED \\
+ LDFLAGS_LAST=/path/to/tpax_getdents_impl.a \\
+ ./configure