Mike Gerwitz

Activist for User Freedom

diff options
authorMike Gerwitz <gerwitzm@lovullo.com>2017-07-18 15:31:35 -0400
committerMike Gerwitz <gerwitzm@lovullo.com>2017-07-18 15:31:43 -0400
commit08b9aecc9c5e9fe8fbed8b59ab845f587903eafd (patch)
parentfe7849224dd305477991f25212b51eacd1234d3c (diff)
doc: Some project TODOs
* doc/Makefile.am (tame_TEXINFOS): Add `todo.texi'. * doc/tame.texi: Add reference to todo. * doc/todo.texi: Add file.
3 files changed, 78 insertions, 2 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 889824b..de7283a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -26,8 +26,8 @@ stylesheets := $(shell find "$(path_src)" \
-a \! -path "$(path_src)"/current/\* )
stexi := $(stylesheets:.xsl=.texi)
-info_TEXINFOS = tame.texi
-tame_TEXINFOS = license.texi $(stexi)
+info_TEXINFOS = tame.texi
+tame_TEXINFOS = todo.texi license.texi $(stexi)
diff --git a/doc/tame.texi b/doc/tame.texi
index a392605..a4b1522 100644
--- a/doc/tame.texi
+++ b/doc/tame.texi
@@ -54,6 +54,7 @@ Free Documentation License".
* Preprocessor:: Metaprogramming system
* Dependency Graph:: Dependency processing and flow analysis
* Symbol Table:: Lookup table for all objects
+* Project TODOs:: High-level project tasks
* License:: Document License
@end menu
@@ -121,6 +122,7 @@ TAME
@include ../src/symtable.texi
+@include todo.texi
@include license.texi
diff --git a/doc/todo.texi b/doc/todo.texi
new file mode 100644
index 0000000..fde27e2
--- /dev/null
+++ b/doc/todo.texi
@@ -0,0 +1,74 @@
+@c This document is part of the TAME manual.
+@c Copyright (C) 2017 LoVullo Associates, Inc.
+@c Permission is granted to copy, distribute and/or modify this document
+@c under the terms of the GNU Free Documentation License, Version 1.3 or
+@c any later version published by the Free Software Foundation; with no
+@c Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+@c A copy of the license is included in the section entitled ``GNU Free
+@c Documentation License''.
+@node Project TODOs
+@appendix Project TODOs
+This project has far more TODOs than are listed here, but here are
+ some higher-level goals for the future.
+There are miscellaneous TODOs sprinkled throughout the code,
+ but those are lower-level.
+@section Linker
+The linker should be one of the fastest parts of the system@mdash{
+ }it should just do a topological sort,
+ resolve symbols as necessary,
+ and arrange code blocks.
+ especially due to memory requirements of loading so many packages
+ into memory (using Saxon),
+ this has been a pain point.
+Performance has improved drastically,
+ but we can do better by gutting other parts of the system that were
+ designed as kluges or now have better solutions that alleviates
+ linker work.
+ @item Limit recursion during stack processing.
+ If you look at a stack trace on error,
+ it can be hundreds of levels deep.
+ Instead,
+ use a trampoline-style approach and indicate that additional
+ symbols need to be loaded,
+ but don't do so immediately in a recursive manner.
+ This may or may not improve the memory footprint@mdash{
+ }hopefully Saxon will see that previously generated trees
+ are no longer necessary and GC them.
+ @item Remove concept of classifier vs. rating processes.
+ This distinction was important in the past to work around
+ pulling in too many dependencies,
+ but there's not really much rationale for separate
+ @code{classify} and @code{rate} methods now,
+ and it'll get rid of a decent amount of work.
+@end enumerate
+@section Input/Return Map
+ @item Generate normal packages and use templates rather than a
+ specialized system;
+ it has numerous kluges to work around inconsistencies with
+ other parts of the system,
+ and copies code from portions,
+ particularly for preprocessing.
+@end enumerate
+@section Worksheet
+ @item Implement a symbol table and treat worksheet packages as
+ normal packages.
+ As it stands today,
+ symbols will not be retained by the linker if they are
+ referenced by the worksheet because there is no symbol table;
+ this puts the onus on the developer to manually place
+ it in the return map,
+ which is error-prone.
+@end enumerate