From a7a31743a29ca50d1cdac497f61c26a293eafd38 Mon Sep 17 00:00:00 2001 From: Veselin Georgiev Date: Tue, 20 Sep 2016 15:35:24 +0300 Subject: [PATCH] Fix issue #66: Manpage for cpuid_tool The man-page is generated with Doxygen, similar to the lib docs. --- cpuid_tool/cpuid_tool.c | 17 +++++++++-------- libcpuid/Doxyfile.in | 2 +- libcpuid/Makefile.am | 4 +++- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/cpuid_tool/cpuid_tool.c b/cpuid_tool/cpuid_tool.c index 1eb11a1..c5ee6f6 100644 --- a/cpuid_tool/cpuid_tool.c +++ b/cpuid_tool/cpuid_tool.c @@ -25,27 +25,28 @@ */ /** - * @File cpuid_tool.c - * @Date 2008-11-19 - * @Author Veselin Georgiev - * @Brief Command line interface to libcpuid + * @page cpuid_tool + * @date 2008-11-19 + * @author Veselin Georgiev + * @brief Command line interface to libcpuid * + * @details * This file is provides a direct interface to libcpuid. See the usage() * function (or just run the program with the `--help' switch) for a short * command line options reference. * * This file has several purposes: * - * 1) When started with no arguments, the program outputs the RAW and decoded + * 1. When started with no arguments, the program outputs the RAW and decoded * CPU data to files (`raw.txt' and `report.txt', respectively) - this is * intended to be a dumb, doubleclicky tool for non-developer * users, that can provide debug info about unrecognized processors to * libcpuid developers. - * 2) When operated from the terminal with the `--report' option, it is a + * 2. When operated from the terminal with the `--report' option, it is a * generic CPU-info utility. - * 3) Can be used in shell scripts, e.g. to get the name of the CPU, cache + * 3. Can be used in shell scripts, e.g. to get the name of the CPU, cache * sizes, features, with query options like `--cache', `--brandstr', etc. - * 4) Finally, it serves to self-document libcpiud itself :) + * 4. Finally, it serves to self-document libcpiud itself :) */ #include #include diff --git a/libcpuid/Doxyfile.in b/libcpuid/Doxyfile.in index f36f738..cb9ba9f 100644 --- a/libcpuid/Doxyfile.in +++ b/libcpuid/Doxyfile.in @@ -436,7 +436,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @top_srcdir@/libcpuid +INPUT = @top_srcdir@/libcpuid @top_srcdir@/cpuid_tool/cpuid_tool.c # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp diff --git a/libcpuid/Makefile.am b/libcpuid/Makefile.am index 56b2ea9..d1d7001 100644 --- a/libcpuid/Makefile.am +++ b/libcpuid/Makefile.am @@ -44,12 +44,14 @@ dist_man_MANS = $(directory)/cpu_id_t.3 \ $(directory)/cpu_list_t.3 \ $(directory)/cpu_mark_t.3 \ $(directory)/cpu_raw_data_t.3 \ - $(directory)/libcpuid.3 + $(directory)/libcpuid.3 \ + $(directory)/cpuid_tool.3 $(directory)/cpu_id_t.3: doxyfile.stamp $(directory)/cpu_list_t.3: doxyfile.stamp $(directory)/cpu_mark_t.3: doxyfile.stamp $(directory)/cpu_raw_data_t.3: doxyfile.stamp $(directory)/libcpuid.3: doxyfile.stamp +$(directory)/cpuid_tool.3: doxyfile.stamp doxyfile.stamp: $(DOXYGEN) Doxyfile