Project

General

Profile

Slug #991

make htmldoc always recreates everything (even if no change was made)

Added by John Abbott over 7 years ago. Updated about 4 years ago.

Status:
Closed
Priority:
Low
Assignee:
John Abbott
Category:
Manual/documentation
Target version:
CoCoA-5.3.0
Start date:
08 Dec 2016
Due date:
% Done:

100%

Estimated time:
3.33 h
Spent time:
3.60 h

Description

It is mildly annoying that the htmldoc target is always rebuilt even if there was no change to the file CoCoAHelp.xml.

Can it be fixed so that rebuilding occurs only if CoCoAHelp.xml has changed (or a previous build did not complete)?

History

#1 Updated by John Abbott over 7 years ago

It may be enough to create (using touch?) two sentinel files: one immediately before producing all the HTML files, and one after.
I'll call them BEFORE and AFTER.
Rebuilding does not occur if (BEFORE and AFTER both exist and) CoCoAHelp.xml is older than BEFORE and BEFORE is older than AFTER; in all other cases the HTML files are rebuilt (as far as I can tell, either they are all created, or none is created).

(Re)Building implies: touch BEFORE; make all the HTML files; touch AFTER

NOTE we could add a sleep 1 before touching BEFORE and AFTER just to make sure that their timestamps are different...

#2 Updated by Anna Maria Bigatti over 7 years ago

The files to check for changes should be CoCoAHelp.xml, aux-files/GUI_help.xsl, and the files in aux-files/GUI-extra-files

#3 Updated by John Abbott about 4 years ago

  • Status changed from New to Resolved
  • Assignee set to John Abbott
  • Target version changed from CoCoA-5.?.? to CoCoA-5.3.0
  • % Done changed from 0 to 80
  • Estimated time set to 2.80 h

I think that this has already been done (don't recall when).

In the Makefile in src/CoCoA-5/CoCoAManual/ there is a target for TimeStamp in the HTML directory which seems to do the right thing.

Much the same mechanism is used for the PDF version of the documentation.

Close?

#4 Updated by John Abbott about 4 years ago

I have just now added dependencies for the generation of the LaTeX version; it now depends also on aux-files/TeX.xsl aux-files/TeX-extra-files/mybook.cls

Not sure who uses aux-files/GUI-extra-files/* as mentioned in comment 2. Anna???

#5 Updated by Anna Maria Bigatti about 4 years ago

John Abbott wrote:

Not sure who uses aux-files/GUI-extra-files/* as mentioned in comment 2. Anna???

html. It was first made for the old GUI.

#6 Updated by John Abbott about 4 years ago

I made the directory aux-files/GUI-extra_files/ unreadable using chmod. Then make veryclean followed by make.
Everything worked. So those files are not needed at the moment.

Perhaps we can just leave them there for the time being, in case they are every useful for a future GUI?

#7 Updated by John Abbott about 4 years ago

  • Status changed from Resolved to Closed
  • % Done changed from 80 to 100
  • Estimated time changed from 2.80 h to 3.33 h

Also available in: Atom PDF