amd / esmi_ib_library

E-SMI: EPYC™ System management Interface In-band Library
Other
23 stars 8 forks source link

make doc failed with errors #10

Closed hj72chung closed 1 month ago

hj72chung commented 3 months ago

Here is the stdout with warning and errors. amd@josephcfae1:~/esmi_ib_library/build$ make doc /usr/bin/cmake -S/home/amd/esmi_ib_library -B/home/amd/esmi_ib_library/build --check-build-system CMakeFiles/Makefile.cmake 0 make -f CMakeFiles/Makefile2 doc make[1]: Entering directory '/home/amd/esmi_ib_library/build' /usr/bin/cmake -S/home/amd/esmi_ib_library -B/home/amd/esmi_ib_library/build --check-build-system CMakeFiles/Makefile.cmake 0 /usr/bin/cmake -E cmake_progress_start /home/amd/esmi_ib_library/build/CMakeFiles 5 make -f CMakeFiles/Makefile2 CMakeFiles/doc.dir/all make[2]: Entering directory '/home/amd/esmi_ib_library/build' make -f CMakeFiles/doc.dir/build.make CMakeFiles/doc.dir/depend make[3]: Entering directory '/home/amd/esmi_ib_library/build' cd /home/amd/esmi_ib_library/build && /usr/bin/cmake -E cmake_depends "Unix Makefiles" /home/amd/esmi_ib_library /home/amd/esmi_ib_library /home/amd/esmi_ib_library/build /home/amd/esmi_ib_library/build /home/amd/esmi_ib_library/build/CMakeFiles/doc.dir/DependInfo.cmake --color= make[3]: Leaving directory '/home/amd/esmi_ib_library/build' make -f CMakeFiles/doc.dir/build.make CMakeFiles/doc.dir/build make[3]: Entering directory '/home/amd/esmi_ib_library/build' [ 20%] Generating latex/refman.tex /usr/bin/doxygen /home/amd/esmi_ib_library/build/Doxyfile warning: Tag 'TCL_SUBST' at line 237 of file '/home/amd/esmi_ib_library/build/Doxyfile' has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1034 of file '/home/amd/esmi_ib_library/build/Doxyfile' has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" warning: Tag 'PERL_PATH' at line 2099 of file '/home/amd/esmi_ib_library/build/Doxyfile' has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" warning: Tag 'MSCGEN_PATH' at line 2121 of file '/home/amd/esmi_ib_library/build/Doxyfile' has become obsolete. To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u" Doxygen version used: 1.9.1 Searching for include files... Searching for example files... Searching for images... Searching for dot files... Searching for msc files... Searching for dia files... Searching for files to exclude Searching INPUT for files to process... Reading and parsing tag files Parsing files Reading /home/amd/esmi_ib_library/docs/README.md... Preprocessing /home/amd/esmi_ib_library/include/e_smi/e_smi.h... Parsing file /home/amd/esmi_ib_library/include/e_smi/e_smi.h... Building macro definition list... Building group list... Building directory list... Building namespace list... Building file list... Building class list... Computing nesting relations for classes... Associating documentation with classes... Building example list... Searching for enumerations... Searching for documented typedefs... Searching for members imported via using declarations... Searching for included using directives... Searching for documented variables... Building interface member list... Building member list... Searching for friends... Searching for documented defines... Computing class inheritance relations... Computing class usage relations... Flushing cached template relations that have become invalid... Computing class relations... Add enum values to enums... Searching for member function documentation... Creating members for template instances... Building page list... Search for main page... Computing page relations... Determining the scope of groups... Sorting lists... Determining which enums are documented Computing member relations... Building full member lists recursively... Adding members to member groups. Computing member references... Inheriting documentation... Generating disk names... Adding source references... Adding xrefitems... Sorting member lists... Setting anonymous enum type... Computing dependencies between directories... Generating citations page... Counting members... Counting data structures... Resolving user defined references... Finding anchors and sections in the documentation... Transferring function references... Combining using relations... Adding members to index pages... Correcting members for VHDL... Computing tooltip texts... Generating style sheet... Generating search indices... Generating example documentation... Generating file sources... Generating code for file e_smi.h... Generating file documentation... Generating docs for file e_smi.h... Generating page documentation... Generating docs for page md__home_amd_esmi_ib_library_docs_README... Generating group documentation... /home/amd/esmi_ib_library/include/e_smi/e_smi.h:1102: warning: argument 'in' of command @param is not found in the argument list of esmi_test_hsmp_mailbox(uint8_t sock_ind, uint32_t data) /home/amd/esmi_ib_library/include/e_smi/e_smi.h:1102: warning: argument 'out' of command @param is not found in the argument list of esmi_test_hsmp_mailbox(uint8_t sock_ind, uint32_t data) /home/amd/esmi_ib_library/include/e_smi/e_smi.h:1110: warning: The following parameter of esmi_test_hsmp_mailbox(uint8_t sock_ind, uint32_t *data) is not documented: parameter 'data' Generating class documentation... Generating docs for compound ddr_bw_metrics... Generating docs for compound dimm_power... Generating docs for compound dimm_thermal... Generating docs for compound dpm_level... Generating docs for compound link_id_bw_type... Generating docs for compound smu_fw_version... Generating docs for compound temp_range_refresh_rate... Generating namespace index... Generating graph info page... Generating directory documentation... Generating index page... Generating page index... Generating module index... Generating namespace index... Generating namespace member index... Generating annotated compound index... Generating alphabetical compound index... Generating hierarchical class index... Generating member index... Generating file index... Generating file member index... Generating example index... finalizing index lists... writing tag file... Combining RTF output... Running plantuml with JAVA... lookup cache used 77/65536 hits=348 misses=77 finished... [ 40%] Generating latex/refman.pdf cd /home/amd/esmi_ib_library/build/latex && make > /dev/null make[4]: pdflatex: No such file or directory make[4]: [Makefile:8: refman.pdf] Error 127 make[3]: [CMakeFiles/doc.dir/build.make:78: latex/refman.pdf] Error 2 make[3]: Leaving directory '/home/amd/esmi_ib_library/build' make[2]: [CMakeFiles/Makefile2:169: CMakeFiles/doc.dir/all] Error 2 make[2]: Leaving directory '/home/amd/esmi_ib_library/build' make[1]: [CMakeFiles/Makefile2:176: CMakeFiles/doc.dir/rule] Error 2 make[1]: Leaving directory '/home/amd/esmi_ib_library/build' make: *** [Makefile:231: doc] Error 2

sumachidanand commented 3 months ago

Hi, From the log, looks to me that pdflatex is not installed. Can you install pdflatex and try make doc again?

Thanks and Regards, Suma

nchatrad commented 1 month ago

Please install pdflatex package for make doc to work. closing as no response from the requests for over a month.