STR #2983

GitHub FLTK Project   FLTK News RSS Feed  
  FLTK Apps      FLTK Library      Forums      Links     Login 
 Home  |  Articles & FAQs  |  Bugs & Features  |  Documentation  |  Download  |  Screenshots  ]
 

Return to Bugs & Features | Roadmap 1.3 | Post Text | Post File | Prev | Next ]

STR #2983

Application:FLTK Library
Status:5 - New
Priority:2 - Low, e.g. a documentation error or undocumented side-effect
Scope:2 - Specific to an operating system
Subsystem:Build Files
Summary:Documentation isn't built correctly.
Version:1.3.2
Created By:mtiernan
Assigned To:Unassigned
Fix Version:Unassigned
Update Notification:

Receive EMails Don't Receive EMails

Trouble Report Files:

Post File ]

No files


Trouble Report Comments:

Post Text ]
Name/Time/Date Text top right image
 
#1 mtiernan
16:08 Sep 09, 2013
After performing a configure and build (all) the documentation doesn't get built.

So, if I do a:
$ ./configure
$ make all
$ make native-dist

I get this:
[mtiernan@hprcf001]{fltk-1.3.2}$ make native-dist
ESP Package Manager v4.1
Copyright 1999-2007 by Easy Software Products.

EPM is free software and comes with ABSOLUTELY NO WARRANTY; for details
see the GNU General Public License in the file COPYING or at
"http://www.fsf.org/gpl.html".  Report all problems to "epm@easysw.com".

Searching for product information...
epm: Unable to open directory "documentation/html" - No such file or directory
epm: Unable to open directory "documentation/html" - No such file or directory
epm: Unable to open directory "documentation/html" - No such file or directory
Stripping executables in distribution...

Going into documentation I can then do:
$ cd documentation
$ make all

Nothing happens.
But if I do a:
$ make html

I get:
 make html
Generating HTML documentation...

Which then works properly.

As a side note, I find it odd that I can do a make {html|pdf} in the documentation directory twice and it doesn't recognize the dependencies so it builds it again.
 
 
#2 greg.ercolano
17:01 Sep 09, 2013
> After performing a configure and build (all)
> the documentation doesn't get built.

This is by design; 'make all' only builds the library, test programs and man pages. This is so that a build will work on machines without doxygen/latex installed.

To build the docs, after doing the 'make all' you can use the following
to build the html docs: ( cd documentation & make html )
to build the pdf docs: ( cd documentation & make pdf )

I've updated the README file (svn current) to reflect the above.

> make native-dist

I'm not familiar with that build target, but I see it referenced in the FLTK CMP (Configuration Management Plan):
http://www.fltk.org/cmp.php

Is this what you were using for reference, or some other documentation?
Are you a package maintainer?

It would appear from the error messages you've included that it seems to have an expectation the documentation/html has been created, so it probably needs a target dependency for that. Will investigate.

> Going into documentation I can then do:
> $ cd documentation
> $ make all
> Nothing happens.

This would be the case if you'd already done a 'make all' in the top level directory, which means the man pages have already been built, which is part of the 'make all' top level target.

To build the html or pdf docs is a separate build request, and requires doxygen for html, and latex for pdf IIRC.

> As a side note, I find it odd that I can do a make {html|pdf}
> in the documentation directory twice and it doesn't recognize
> the dependencies so it builds it again.

I'd agree, and offer that issue should probably be fixed if possible. Thing is, I think the dependency list would need to be much larger, taking into account all source code that doxygen uses for input, which might be a problem to create. So perhaps it's best it always rebuilds the docs until that issue is solved.
 
 
#3 mtiernan
05:45 Sep 10, 2013
Okay, my error. I made a stupid blanket statement and I shouldn't have.
Sorry.

My assumption/statement was based on the seemingly broken make target for native-dist which looks for the HTML docs not the manpages.

The 'native-dist' target and (without looking) the portable-dist target are for repackaging the built components into a distributable entity for specific operating systems using 'epm'

Am I a package maintainer? ;)  Loaded question. ;)
I maintain packages for my own use here and lend a hand any place I can.

BTW, maybe increase the verbosity of the documentation makefile so that it says "Making man pages..." and then exits so we know it did *something*?

On the last issue of the always building the documentation targets (html or pdf) I'd suggest a note in the release notes (not aware if there is or is not one there already) and maybe a message from the makefile saying "Rebuilding docs regardless of age." or something.

Again, thanks for all the time and work!
 
 
#4 greg.ercolano
09:33 Sep 10, 2013
> Okay, my error. I made a stupid blanket statement
> and I shouldn't have. Sorry.

    That's OK; some of the observations need to be corrected:

    o the FLTK 'README' has been updated to show how to build
      the HTML and PDF docs (and removed/updated some stale URLs)
      Fixed in r9971.

    o Makefile announcement msgs should be improved.

    o Arguably, the 'native-dist' target should depend on
      documentation/html/index.html, and make it if it
      hasn't been made. I'll look into that.

      Thanks for the info on 'native-dist'.

      Was wondering if you were one of the linux distro package
      maintainers; we sometimes get bug reports from them.

> BTW, maybe increase the verbosity of the documentation
> makefile so that it says "Making man pages..." and then
> exits so we know it did *something*?

      Agreed, will probably do just that.

> On the last issue of the always building the documentation targets
> (html or pdf) [..] maybe a message from the makefile saying
> "Rebuilding docs regardless of age." or something.

      Yes, will check into adding something like that as well.
      Will follow up when complete.
 
 
#5 AlbrechtS
09:32 Feb 12, 2019
Assigned to "FLTK Library" (version: 1.3.2).

This STR has been "lost" due to wrong assignment of the "Application" field so it didn't show up in our roadmap.

Please check if this still applies (in FLTK 1.4 development), or can we close this STR?
 
bottom left image   bottom right image

Return to Bugs & Features | Post Text | Post File ]

 
 

Comments are owned by the poster. All other content is copyright 1998-2021 by Bill Spitzak and others. This project is hosted by The FLTK Team. Please report site problems to 'erco@seriss.com'.