atticus-sullivan
commented
1 year ago Tested this for biblatex+biber for a while now and it works as expected (for my usecase). I added some comments about the processing.
Below is an example showing when what rebuild is triggered (and this is how I expect it)
Running some example cases
I used a long name for the `.bib` file because I wanted to check if in the `.bcf` file long lines are wrapped. And I stripped some paths (using relative paths), in the real output they are absolute of course. ```bash # clean start (due to removing everything in the tex-aux folder) $ rm -r tex-aux/* && cluttex --max-iterations=20 --output-directory="tex-aux" --change-directory --biber -e pdflatex "main.tex" > log [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [INFO] looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong.bib is newer than aux [EXEC] biber --output-directory '.' main.bcf [INFO] New auxiliary file 'main.aux'. [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [INFO] File 'main.aux' was modified (size: 321 -> 389). [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [INFO] File 'main.run.xml' was modified (md5: ad3731e961a59b0834d1c04860e7a055 -> d473f1fbcd04cc7d2b127917cf618dc6). # here this run is not necessary, but the .run.xml changes (checked this) so we need to rerun in general [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [EXEC] cp './main.pdf' '../main.pdf' # just change the timestamp of the bib file $ touch looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong.bib $ cluttex --max-iterations=20 --output-directory="tex-aux" --change-directory --biber -e pdflatex "main.tex" > log [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [INFO] looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong.bib is newer than aux [EXEC] biber --output-directory '.' main.bcf [EXEC] cp './main.pdf' '../main.pdf' # bbl wasn't changed -> no rerun necessary # change the contents of the bib file $ vim looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong.bib $ cluttex --max-iterations=20 --output-directory="tex-aux" --change-directory --biber -e pdflatex "main.tex" > log [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [INFO] looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong.bib is newer than aux [EXEC] biber --output-directory '.' main.bcf [INFO] File 'main.bbl' was modified (md5: ba1c78dc6fdfaf8c19ed24b06cdb2478 -> 3573a4eb35b598b72e8a2d1b0338386b). [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [INFO] File 'main.aux' was modified (md5: c553687ab70ef781212220a1e9a140a3 -> d658b8cebf4f8b2e89840beb41662cba). [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' [EXEC] cp './main.pdf' '../main.pdf' # change biblography unrelated things in the tex file $ vim main.tex $ cluttex --max-iterations=20 --output-directory="tex-aux" --change-directory --biber -e pdflatex "main.tex" > log [EXEC] pdflatex -recorder -halt-on-error -interaction=nonstopmode -file-line-error -jobname='main' '\input"main.tex"' # no biber rerun or so [EXEC] cp './main.pdf' '../main.pdf' ```If you've see any issue with this behavior and/or the changes, please let me know.
EDIT: And I did not work on bibtex further as I'm not that familiar with the workflow with bibtex (I only use biber)
minoki
Supposed to fix #3 if biber is used.
To discussion:
original_wd.."/"..bibalways work? (I'm not quite sure what kind of paths we can encounter in.bcffiles, but as long as they are relative to the directory where the user invokedcluttexit should work)original_wd.."/"..bibis actually a real file (and print a warning if not), since I'm not sure ifbcf:datasourceis surely always a file. This way we also could somehow warn iforiginal_wd.."/"..bibfailed in some way.@minoki Any thoughts on these points? (made this a draft as I'd like to discuss this before merging)
Still to be done is the bibtex support, but as I'm not using bibtex I'm not quite confident in testing this with a common setup. And there is no
bcffile from where we'd get the.bibfile(s) used (there has to be another way, as bibtex has to find these files as well somehow, but I just don't know it).@minoki do you use BibTeX and can do this for the BibTeX option?
Also a small note:
reruncheck.comparefiletime(mainauxfile, output_bbl, auxstatus)is being used in thebibtexoption path (cluttex.lua:383). As far as I tested (tried to use an adapted version of this for thebiberoption), this will always returnfalseasauxstatusworks with absolute paths andmainauxfileappears to be relative. So in effect thebibtexoption only uses the mechanism of comparing the hashes.