search

aarroyoc / doclog

DocLog builds documentation from source code in Prolog
BSD 3-Clause "New" or "Revised" License
22 stars 1 forks source link

error_running_doclog. #5

Open triska opened 7 months ago

triska commented 7 months ago

I followed the steps in the documentation, and also adjusted the configuration file, and now I get:

$ bash doclog.sh scryer.config.pl 
doclog(1,1,0).
error_running_doclog.
aarroyoc commented 7 months ago

The output folder must not exist (make clean). Also, check if you have the latest dependencies (make setup).

triska commented 7 months ago

I have done make setup, and no output folder exists yet, and I still get the same problem. This is from a freshly cloned repository. May I suggest emitting more information about why an error arises? Could an exception be shown? Thank you a lot!

triska commented 7 months ago

I think one reason is that I have temporary files in the lib directory, these are created by Emacs when editing files:

all:user:path_segments(A,[[],"home","markus","scryer-prolog","src","lib",".","a.pl~"]).
exit:user:path_segments("/home/markus/scryer-prolog/src/lib/./a.pl~",[[],"home","markus","scryer-prolog","src","lib",".","a.pl~"]).
call:user:directory_exists("/home/markus/scryer-prolog/src/lib/./a.pl~").
triska commented 7 months ago

The same issue for the .ediprolog file that exists in the library path:

call:user:directory_exists("/home/markus/scryer-prolog/src/lib/./.ediprolog").

Maybe doclog can be made more robust against such files? I think it cauld suffice to process only *.pl files.

aarroyoc commented 6 months ago

Yes, those are good points. File handling in DocLog was an afterthought and it can be improved a lot. I'll keep this issue open until I fix it.