thesofproject / sof-docs

Documentation for SOF
Other
18 stars 73 forks source link

Makefile: stop recommending users to build doxygen in SOF source dir #422

Closed marc-hb closed 2 years ago

marc-hb commented 2 years ago

CMake is all about "out of source" build directories which among others make it super easy to clean: just delete the build directory, done. So stop recommending users to build doxygen inside their SOF source tree which pollutes it with many files they have to delete one by one.

Before this commit:

  git -C ../sof/ status --ignored

  Untracked/Ignored files:
  (use "git add <file>..." to include in what will be committed)
    doc/.ninja_log
    doc/CMakeCache.txt
    doc/CMakeFiles/
    doc/build.ninja
    doc/cmake_install.cmake
    doc/doxygen/
    doc/sof.doxygen

After this commit:

  git -C ../sof/ status --ignored

  Ignored files:
  (use "git add -f <file>..." to include in what will be committed)
    build_doxygen/

Signed-off-by: Marc Herbert marc.herbert@intel.com