Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Releases miss Doxygen files #56

Closed
nschloe opened this issue May 12, 2014 · 7 comments
Closed

Releases miss Doxygen files #56

nschloe opened this issue May 12, 2014 · 7 comments

Comments

@nschloe
Copy link
Contributor

nschloe commented May 12, 2014

When compiling a netCDF release with ENABLE_DOXYGEN set to ON, the build will fail. The reason is that several Doxygen configuration files are missing. (They are present in the master tree though.)

@WardF
Copy link
Member

WardF commented May 12, 2014

I'm not able to duplicate this issue, using either the v4.3.2 or v4.3.1.1 release. With the former, I receive several warnings related to duplicate occurrences of section labels, and a couple of 'obsolete tag' warnings, but no missing configuration files.

I am building using CMake, with the following syntax:

netcdf-c/build$ cmake .. -DENABLE_DOXYGEN=ON

All other options are left with the default values.

Can you provide information about what files are missing specifically? Also, can you tell me which version of doxygen you are using? I recently updated to 1.8.7, it is possible I broke something for earlier versions. I thought I had at least checked against 1.8.6, but I will investigate this.

@nschloe
Copy link
Contributor Author

nschloe commented May 12, 2014

From a clean netcdf-4.3.2 download, and a build

cmake \                                                                         
  -DBUILD_DOCS:BOOL=ON \                                                        
  ../netcdf-4.3.2/

I'm getting the error

[...]
-- Found Doxygen: /usr/bin/doxygen (found version "1.7.6.1") 
CMake Error: File /home/nschloe/software/netcdf-c/4.3.2/netcdf-4.3.2/man4/Doxyfile.guide.in does not exist.
CMake Error at man4/CMakeLists.txt:25 (CONFIGURE_FILE):
  configure_file Problem configuring file


CMake Error: File /home/nschloe/software/netcdf-c/4.3.2/netcdf-4.3.2/man4/Doxyfile.tutorial.in does not exist.
CMake Error at man4/CMakeLists.txt:27 (CONFIGURE_FILE):
  configure_file Problem configuring file

This is reproducible on another system with Doxygen 1.8.6.

@WardF
Copy link
Member

WardF commented May 12, 2014

Thanks; I see the issue now. I'm correcting this in the packaging scripts for the next version, and so will mark this issue closed. I'm typically loathe to amend a release, especially after this much time has passed as I don't want to cause any confusion with any third-party package maintainers (as has happened in the past, I understand). Let me talk it over with Russ. Thank you for reporting the issue; this is a side-effect of our document reorganization, and maintaining two release systems in parallel.

@WardF WardF closed this as completed May 12, 2014
@WardF
Copy link
Member

WardF commented May 12, 2014

Note: I'm also updating my internal 'validate release' script. It checks for missing Makefiles and such, but had not been checking documentation. Now it will.

@nschloe
Copy link
Contributor Author

nschloe commented May 12, 2014

Sounds good!
If you want to release this, I'd go for a point release 4.3.2.1. (If only for this sequence of numbers. ;)

@WardF
Copy link
Member

WardF commented May 13, 2014

I am sorely tempted to do just that, actually :). I'm a sucker for 'neat' coincidental sequences of numbers.

@nschloe
Copy link
Contributor Author

nschloe commented May 17, 2014

I just saw on ftp://ftp.unidata.ucar.edu/pub/netcdf/ that point releases aren't even that unusual with netCDF.

@rojinsafavi rojinsafavi mentioned this issue Feb 14, 2017
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants