doxygen --version shows GIT-NOTFOUND

[duncan-roe]

Doing an out-of-tree build as per #10630
After installing, I see

11:47:39$ doxygen --version
1.11.0 (GIT-NOTFOUND)

Workaround

For now I edit line 110 of cmake/git_watcher.cmake to be the actual hash, but it would be nice if the watcher actually worked.

[albert-github]

So far we have not seen problems with it.

In the build environment, i.e. the environment where you make the build not the system, is there the git executable available, i.e what is the value of ${GIT_EXECUTABLE}?
Maybe you can write at the mentioned line 110 something like:

message(STATUS "Using git executable${GIT_EXECUTABLE}")

[duncan-roe]

On Sat, Feb 10, 2024 at 02:55:38AM -0800, albert-github wrote: So far we have not seen problems with it. In the build environment, i.e. the environment where you make the build not the system, is there the git executable available, i.e what is the value of `${GIT_EXECUTABLE}`? Maybe you can write at the mentioned line 110 something like: ``` message(STATUS "Using git executable${GIT_EXECUTABLE}") ```

OK I did that. And in the build log I see this: ``` [ 4%] Building CXX object deps/spdlog/CMakeFiles/spdlog.dir/src/cfg.cpp.o [ 4%] Checking the doxygen version for changes... [ 4%] Building CXX object deps/spdlog/CMakeFiles/spdlog.dir/src/bundled_fmtlib_format.cpp.o -- Using git executable/usr/bin/git [ 4%] Built target check_doxygen_version [ 4%] Built target check_git_repository [ 4%] Building CXX object libxml/CMakeFiles/xml.dir/__/generated_src/xml.cpp.o ``` The thing is, I previously ran ``` cd /tmp rm -r build mkdir build cd build cmake /usr/src/doxygen/ make -j package_source ``` This created `doxygen-1.11.0-Source.tar.xz` which the package builder restored to /tmp and built there. That tar.gz does not have .git/ in it, so how would git find the latest hash? I think this is how most distributors would build doxygen. Perhaps you don't have a problem because you build in the source tree? Cheers ... Duncan.

[albert-github]

cmake /usr/src/doxygen/

• so the version in /usr/src/doxygen/ has a .git directory?
  (when so this should have been used).

I had a quick look in the cmake/git_watcher.cmake and here I see:

CheckGit("${GIT_WORKING_DIR}" did_change state)

and in the documentation of function(CheckGit _working_dir _state_changed _state) we see:

#   _working_dir    (in)  string; the directory from which git commands will be ran.

so I will have to do a few tests to see what is in this variable when I use the construct as you use (your answer to the question about /usr/src/doxygen/ has a .git directory still would be valuable).

Perhaps you don't have a problem because you build in the source tree?

I normally run from a directory build which is parallel to the src directory

[albert-github]

I ran some tests and I can reproduce the problem in case the .git directory is not present.
I thought that in case there was no .git directory the GIT-NOTFOUND would have been filtered out (as there is not git information available), but looking at the code of gitversion.cpp.in it looks like the commit:

Commit: e29c4a5e86941ed6b6c2437fcdf82263a2679268 [e29c4a5]
Date: Monday, November 13, 2023 9:07:08 PM

Refactoring: Modernize libversion

has the unwanted side effect that the result is not filtered properly.
(Typo "GIT_NOTFOUND" has to be "GIT-NOTFOUND")

I've just pushed a proposed patch, pull request #10646

[duncan-roe]

- so the version in `/usr/src/doxygen/` has a `.git` directory? (when so this should have been used).

Indeed it does.

[duncan-roe]

I applied your patch. Now I see

10:21:46$ doxygen --version
1.11.0

But
I'm running a different doxygen from the official Slackware version, so I want to see the hash. To this end, I tried modifying the local build script:

*** 81,86 ****
--- 81,87 ----
  cd build
    cmake \
      -DPYTHON_EXECUTABLE=/usr/bin/python3 \
+     -DGIT_WORKING_DIR=/usr/src/doxygen \
      -DCMAKE_C_FLAGS:STRING="$SLKCFLAGS" \
      -DCMAKE_CXX_FLAGS:STRING="$SLKCFLAGS" \
      -DCMAKE_INSTALL_PREFIX=/usr \

But doxygen --version output was unchanged. What else do I have to do?
BTW I have run git clean -x -f in /usr/src/doxygen

[albert-github]

Good that the result with the patch does not contain the (GIT-NOTFOUND) anymore

I'm running a different doxygen from the official Slackware version, so I want to see the hash

Yes this should indeed be the case as the .git directory is present as you reported and thus the hash should be found.
I never used git clean -x -f but I assume that the .git directory is still present.

Lets try a step by step approach.
I think best way to start is to write some debug statements in libversion/gitversion.cpp.in like

fprintf(stderr,"==> %d: '%s'\n",__LINE__,gitVersion.c_str());

I placed a few print statements in my repository and build out of tree on /tmp/build.

• cd /tmp/build
• cmake <path to my repository>
• make

I don't see any strange things with your setup, unless after the line

-DCMAKE_INSTALL_PREFIX=/usr \

there is something strange (as there is a continuation sign).

When running:

/tmp/build/bin/doxygen -v

I get:

==> 15: ''
==> 17: 'ee1d4b592f123616a47d318cf0fb872b89ea7a0b'
==> 28: 'ee1d4b592f123616a47d318cf0fb872b89ea7a0b*'
1.11.0 (ee1d4b592f123616a47d318cf0fb872b89ea7a0b*)

(my tree is not clean).

Adjusted code: adj_ver.tar.gz

[duncan-roe]

cmake <path to my repository> is always going to display a git version, because my repository has a .git directory.
To see my problem, can you try this: untar one of the doxygen-1.11.0-Source.tar.* archives generated by make package_source then:

cd /tmp
rm -rf build
mkdir build
cd build
cmake <path to newly restored source package>

There is no possibility that the resulting doxygen will display a git hash. The question is: what extra arguments to cmake are needed to make a hash appear again?
This is the complete cmake line here:

cmake -DPYTHON_EXECUTABLE=/usr/bin/python3 -DGIT_WORKING_DIR=/usr/src/doxygen '-DCMAKE_C_FLAGS:STRING=-O2 -fPIC' '-DCMAKE_CXX_FLAGS:STRING=-O2 -fPIC' -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DDOC_INSTALL_DIR:STRING=/doc/doxygen-1.11.0 -DBUILD_SHARED_LIBS=OFF -Dbuild_app=ON -Dbuild_doc=ON -Dbuild_parse=ON -Dbuild_search=ON -Dbuild_wizard=ON -Dbuild_xmlparser=ON -Duse_sqlite3=ON -G 'Unix Makefiles' ..

(The build is done in a subdirectory of the restored archive).
git clean -x -f removes files unknown to git and (with -x) files in .gitignore
I'll try your suggested diags later but I have to get on with other stuff right now.

[albert-github]

Original problem: Code has been integrated in master on GitHub