-
Notifications
You must be signed in to change notification settings - Fork 137
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
CMake infrastructure does not handle documentation #947
Comments
I remember I saved this part for later as we were not clear on how to handle the docs. As we do have Github pages for the manual, we only need the man page from the CMake build, correct?
will do |
No, the Github pages are just copied over from the texinfo build right now, but the commands how to create the docs out of the texinfo source are only in the classic automake files so far. Until we found someone volunteering to setup a better way, we'd thus somehow need to preserve the texinfo toolchain in the CMake infrastructure. Also, it would be great to include all that inside the source tarball, as it used to be the case with automake. That way, people (e.g. like Linux or FreeBSD distributors) could decide to (optionally) compile and install the appropriate documentation locally, rather than only referring to the online docs. For automake, this was achieved by
tnx! |
So the first part seems to work at least on linux. For the second part I am digging into Maybe it would be easiest if you could provide a working command - I have no idea of how that .am stuff works - so I can verify that the cmake part behaves exactly the same. Will pdflatex suffice or do i need some extra magic like sphinx? |
The project moved from cd src
./bootstrap
./configure
cd doc
make version.texi avrdude.pdf |
I have never tried to build the documentation before and the above works fine under Linux. I need to install texlive to build the documentation.
I am not so sure about the |
Thanks. Works like a charm. One question ahead |
This seems to only happen if I creatthened the build director under src and then use build log
|
Using build log
|
main...sbngross:WIP-cmake-docs This is what I came up with so far. The basic idea is to do the actual work in scripts and let How do you build on Windows? WSL or cygwin? I might be able to test both but cygwin with less hazzle. |
The wiki has instructions for MSVC, MSY2 mingw32/64 and Cygwin. I usually use MSYS2 and occassionally use MSVC. Cygwin should work. |
Almost there.
Seems to work on my machine
|
Remaining Tasks (feel free to contribute)
|
Somehow it does not work on my Ubuntu 20.04 system.
|
Well I guessed that could happen but I thought I looked it up in the docs if this works for 3.16.
However this is not the reason it failed though it would have for certain later XD
Hold on a sec =) |
Now the first step is okay but there is a problem with
|
The above seems to be a Ubuntu shell problem (using dash and not bash), a dirty fix (not the right fix) can sort out the above issue but then there is another issue later.
More info with verbose Makefile option (
The above error comes from git.
Adding
|
In summary, under Ubuntu Linux 20.04, I need to use the following dirty fix.
After that it will be okay. The HTML files are inside the
|
Thanks for testing and fixing.
Ah I see what I did there. I wanted to use
Sorry that was moreless just test code for me and was destined to fail if one builts on a fork or from tarball. I shouldn't have pushed that. But good you found a way to fix this. I will add it. I'm now working on the version stuff but I'm not sure how automake gets the 20220508 date. But this is the date of the |
The new CMake infrastructure does not handle documentation:
doc/
avrdude.1
is not installed duringmake install
The text was updated successfully, but these errors were encountered: