Re: [Axiom-developer] Misleading documentation

[Waldek Hebisch]

Gabriel Dos Reis wrote:
> Waldek Hebisch <address@hidden> writes:
> 
> | src/interp/Makfile.pamphlet contains misleading information about
> | the TRANOBJS group of files. The following patch (at least partially)
> | correct this information:
> 
> Sweet!
> 
> Please check in with appropriate ChangeLog; send the final patch to
> the list.
> 

Commited.  As requested the send the patch second time to the list:

Index: src/interp/Makefile.pamphlet
===================================================================
--- src/interp/Makefile.pamphlet        (wersja 185)
+++ src/interp/Makefile.pamphlet        (kopia robocza)
@@ -308,9 +308,19 @@
 autoload_objects += $(BFOBJS)
 
 @
-The {\bf TRANOBJS} list contains files only used by the {\bf boot}
+The {\bf TRANOBJS} list contains files used by Spad to Aldor convertor.
+The files probably are also used by the {\bf boot}
 to Common Lisp translator and are probably never used by anyone
-but the developers. These files should probably be autoloaded.
+but the developers.
+
+When a user requests converting a file from Spad to Aldor the
+function
+[[spad2AsTranslatorAutoloadOnceTrigger]] is called triggering
+load of this group of files. Loading [[$TRANOBJS]] in turn replaces
+many compiler functions by versions contain in this files.
+ These files should probably be autoloaded
+(at least [[${AUTO}/wi1.$(OBJEXT)]] and [[${AUTO}/wi2.$(OBJEXT)]]
+(which replace compiler functions) {\em must} be autoloaded).
 <<environment>>=
 TRANOBJS= ${AUTO}/wi1.$(OBJEXT) ${AUTO}/wi2.$(OBJEXT) ${AUTO}/pspad1.$(OBJEXT) 
\
          ${AUTO}/pspad2.$(OBJEXT) ${AUTO}/mark.$(OBJEXT) 
${AUTO}/nspadaux.$(OBJEXT) \
Index: ChangeLog.build-improvements
===================================================================
--- ChangeLog.build-improvements        (wersja 185)
+++ ChangeLog.build-improvements        (kopia robocza)
@@ -1,3 +1,9 @@
+2006-10-20  Waldek Hebisch  <address@hidden>
+
+       * src/interp/Makefile.pamphlet: correct misleading information
+       about TRANOBJS
+       
+       
 2006-10-20  Gabriel Dos Reis  <address@hidden>
 
        * config/setup-dep.mk: Tidy.


-- 
                              Waldek Hebisch
address@hidden