Frama-C Bug Tracking System - Frama-C
View Issue Details
0000754Frama-CKernel > Makefilepublic2011-03-16 10:162014-02-12 16:59
Anne 
virgile 
normalminorhave not tried
closedfixed 
 
Frama-C Nitrogen-20111001Frama-C Nitrogen-20111001 
0000754: Dynamic plugin doc
The command : make xxx_DOC (where xxx is a dynamic plugin name) fails with the message :
Pas de règle pour fabriquer la cible « /kernel-doc.ocamldoc »

This is because $(DOC_DIR) is not defined, which seems normal (I far as I know, the compilation of dynamic plugin refers to the installed files, not to the source repository).

The easiest fix would probably be that a plugin internal documentation doesn't depend on the kernel documentation...
No tags attached.
Issue History
2011-03-16 10:16AnneNew Issue
2011-03-16 10:16AnneStatusnew => assigned
2011-03-16 10:16AnneAssigned To => signoles
2011-03-16 12:00signolesStatusassigned => acknowledged
2011-03-16 13:39AnneNote Added: 0001602
2011-03-16 17:00AnneNote Added: 0001603
2011-03-16 17:01AnneNote Edited: 0001603
2011-03-17 10:37signolesRelationship addedrelated to 0000742
2011-03-17 10:38signolesNote Added: 0001606
2011-03-17 10:46AnneNote Added: 0001607
2011-03-24 15:05signolesTarget Version => Frama-C Nitrogen-20110901
2011-03-24 15:06signolesStatusacknowledged => assigned
2011-03-24 15:06signolesAssigned Tosignoles => virgile
2011-03-24 15:06signolesNote Added: 0001629
2011-03-24 15:08virgileStatusassigned => acknowledged
2011-03-25 13:49svnCheckin
2011-03-25 13:49svnStatusacknowledged => resolved
2011-03-25 13:49svnResolutionopen => fixed
2011-03-25 14:20AnneNote Added: 0001639
2011-03-25 14:20AnneStatusresolved => feedback
2011-03-25 14:20AnneResolutionfixed => reopened
2011-03-25 16:01virgileNote Added: 0001641
2011-03-25 16:02svnCheckin
2011-03-25 16:02svnStatusfeedback => resolved
2011-03-25 16:02svnResolutionreopened => fixed
2011-10-10 14:13signolesFixed in Version => Frama-C Nitrogen-20111001
2011-10-10 14:14signolesStatusresolved => closed
2014-02-12 16:59Note Added: 0004820
2014-02-12 16:59Statusclosed => resolved

Notes
(0001602)
Anne   
2011-03-16 13:39   
Another (maybe easier) way of fixing the problem would be to put the file [doc/code/kernel-doc.ocamldoc] (and probably [doc/code/style.css]) in the distribution (in [share/frama-c/] for instance). But there still would be a problem because of the frama-c specific ocamldoc generator...

I don't know if it is related, but I have seen that there is a file [Makefile.dynamic_config.external] which I guess is for external plugins, but I didn't understand how it is used (and even if it is the case...)
(0001603)
Anne   
2011-03-16 17:00   
(edited on: 2011-03-16 17:01)
I have done a little workaround in [genassigns] plugin Makefile: it is quiet ugly (it has to define FRAMAC_HOME), but might be useful to wait for a better solution...

(0001606)
signoles   
2011-03-17 10:38   
If you are satisfied with your local workaround, it will be probably done at the same time than task #742.
(0001607)
Anne   
2011-03-17 10:46   
Ok for me. Thanks.
(0001629)
signoles   
2011-03-24 15:06   
Virgile is looking forward the issue.
(0001639)
Anne   
2011-03-25 14:20   
[genassigns]$ make doc
Frama-C kernel was not installed with code documentation support. Cannot compile API documentation.
make: *** [plugin-doc/Genassigns] Erreur 1

I didn't find any configure option to have the code documentation support...
What do I have to do ?
(0001641)
virgile   
2011-03-25 16:01   
You have to generate and install kernel doc:
make doc install-doc-code
in Frama-C source dir
Next commit will document that.
(0004820)
   
2014-02-12 16:59   
Fix committed to stable/neon branch.