From 34442e381a2c4e4f6a5c6290b8dbf43f69737f0e Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:06:23 +0100 Subject: [PATCH 01/22] add doc generation action --- .github/workflows/sourcedoc.yaml | 41 ++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/workflows/sourcedoc.yaml diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml new file mode 100644 index 00000000..2e2cf715 --- /dev/null +++ b/.github/workflows/sourcedoc.yaml @@ -0,0 +1,41 @@ +name: Publish doc + +on: + push: + branches: + - jmspit + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - name: Checkout 🛎️ + uses: actions/checkout@v2.3.1 + + + - name: Create Build Environment + # Some projects don't allow in-source building, so create a separate build directory + # We'll use this as our working directory for all subsequent commands + run: cmake -E make_directory ${{github.workspace}}/build + + - name: Configure CMake + # Use a bash shell so we can use the same syntax for environment variable + # access regardless of the host operating system + shell: bash + working-directory: ${{github.workspace}}/build + # Note the current convention is to use the -S and -B options here to specify source + # and build directories, but this is only available with CMake 3.13 and higher. + # The CMake binaries on the Github Actions machines are (as of this writing) 3.12 + run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE + + - name: Build docs + working-directory: ${{github.workspace}}/build + shell: bash + # Execute the build. You can specify a specific target with "--target " + run: cmake --build . --config $BUILD_TYPE --target doc + + - name: Deploy docs 🚀 + uses: JamesIves/github-pages-deploy-action@4.0.0 + with: + branch: gh-pages # The branch the action should deploy to. + folder: build/html # The folder the action should deploy. \ No newline at end of file From a827e22f00e7f2ca4b426c960f17ba6a1c9b51c1 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:27:51 +0100 Subject: [PATCH 02/22] doc publishing --- CMakeLists.txt | 23 ++--- cmake/MunkeiVersionFromGit.cmake | 167 ------------------------------- 2 files changed, 11 insertions(+), 179 deletions(-) delete mode 100644 cmake/MunkeiVersionFromGit.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index 079528bd..fd0fdece 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -11,18 +11,17 @@ execute_process( OUTPUT_VARIABLE GIT_TAG OUTPUT_STRIP_TRAILING_WHITESPACE ) -message( STATUS "GIT_TAG : ${GIT_TAG}") -include( cmake/MunkeiVersionFromGit.cmake ) - -version_from_git( - LOG ON - TIMESTAMP "%Y%m%d%H%M%S" -) +if( GIT_TAG MATCHES "^v(0|[1-9][0-9]*)[.](0|[1-9][0-9]*)[.](0|[1-9][0-9]*)(-[.0-9A-Za-z-]+).*$" ) + set( ${PROJECT}_VERSION_MAJOR "${CMAKE_MATCH_1}" ) + set( ${PROJECT}_VERSION_MINOR "${CMAKE_MATCH_2}" ) + set( ${PROJECT}_VERSION_PATCH "${CMAKE_MATCH_3}" ) + set( ${PROJECT}_VERSION_SNAP "${CMAKE_MATCH_4}" ) +else() + message( STATUS "Git tag not valid [${git_tag}]" ) +endif() -set( ${PROJECT}_VERSION_MAJOR "${VERSION_MAJOR}" ) -set( ${PROJECT}_VERSION_MINOR "${VERSION_MINOR}" ) -set( ${PROJECT}_VERSION_PATCH "${VERSION_PATCH}" ) +message( STATUS "GIT_TAG : ${GIT_TAG}") # options option(EXAMPLE_TEST "set to ON to build examples and tests" "OFF") @@ -46,8 +45,8 @@ message( STATUS "CMAKE_CXX_COMPILER : ${CMAKE_CXX_COMPILER}") message( STATUS "CMAKE_HOST_SYSTEM : ${CMAKE_HOST_SYSTEM}") message( STATUS "CMAKE_VERSION : ${CMAKE_VERSION}") -set(${PROJECTUC}_VERSION_STR "${SEMVER}") -set(${PROJECT}_VERSION_STR "${SEMVER}") +set(${PROJECTUC}_VERSION_STR "${GIT_TAG}") +set(${PROJECT}_VERSION_STR "${GIT_TAG}") message( STATUS "${PROJECTUC} BUILD VERSION : ${${PROJECTUC}_VERSION_STR}") set(${PROJECT}_LIB_NAME "${PROJECT}-${${PROJECT}_VERSION_STR}") message( STATUS "examples and tests : ${EXAMPLE_TEST}") diff --git a/cmake/MunkeiVersionFromGit.cmake b/cmake/MunkeiVersionFromGit.cmake deleted file mode 100644 index 2348ae59..00000000 --- a/cmake/MunkeiVersionFromGit.cmake +++ /dev/null @@ -1,167 +0,0 @@ -# The MIT License (MIT) -# -# Copyright (c) 2016-2017 Theo Willows -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in all -# copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -# SOFTWARE. - -#cmake_minimum_required( VERSION 3.0.0 ) - -include( CMakeParseArguments ) - -function( version_from_git ) - # Parse arguments - set( options OPTIONAL FAST ) - set( oneValueArgs - GIT_EXECUTABLE - INCLUDE_HASH - LOG - TIMESTAMP - ) - set( multiValueArgs ) - cmake_parse_arguments( ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) - - # Defaults - if( NOT DEFINED ARG_INCLUDE_HASH ) - set( ARG_INCLUDE_HASH ON ) - endif() - - if( DEFINED ARG_GIT_EXECUTABLE ) - set( GIT_EXECUTABLE "${ARG_GIT_EXECUTABLE}" ) - else () - # Find Git or bail out - find_package( Git ) - if( NOT GIT_FOUND ) - message( FATAL_ERROR "[MunkeiVersionFromGit] Git not found" ) - endif( NOT GIT_FOUND ) - endif() - - # Git describe - execute_process( - COMMAND "${GIT_EXECUTABLE}" describe --tags --always - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" - RESULT_VARIABLE git_result - OUTPUT_VARIABLE git_describe - ERROR_VARIABLE git_error - OUTPUT_STRIP_TRAILING_WHITESPACE - ERROR_STRIP_TRAILING_WHITESPACE - ) - if( NOT git_result EQUAL 0 ) - message( FATAL_ERROR - "[MunkeiVersionFromGit] Failed to execute Git: ${git_error}" - ) - endif() - - # Get Git tag - execute_process( - COMMAND "${GIT_EXECUTABLE}" describe --tags --always - WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" - RESULT_VARIABLE git_result - OUTPUT_VARIABLE git_tag - ERROR_VARIABLE git_error - OUTPUT_STRIP_TRAILING_WHITESPACE - ERROR_STRIP_TRAILING_WHITESPACE - ) - if( NOT git_result EQUAL 0 ) - message( FATAL_ERROR - "[MunkeiVersionFromGit] Failed to execute Git: ${git_error}" - ) - endif() - - if( git_tag MATCHES "^v(0|[1-9][0-9]*)[.](0|[1-9][0-9]*)[.](0|[1-9][0-9]*)(-[.0-9A-Za-z-]+)?([+][.0-9A-Za-z-]+)?$" ) - set( version_major "${CMAKE_MATCH_1}" ) - set( version_minor "${CMAKE_MATCH_2}" ) - set( version_patch "${CMAKE_MATCH_3}" ) - set( identifiers "${CMAKE_MATCH_4}" ) - set( metadata "${CMAKE_MATCH_5}" ) - else() - message( FATAL_ERROR - "[MunkeiVersionFromGit] Git tag isn't valid semantic version: [${git_tag}]" - ) - endif() - - if( "${git_tag}" STREQUAL "${git_describe}" ) - set( git_at_a_tag ON ) - endif() - - if( NOT git_at_a_tag ) - # Extract the Git hash (if one exists) - string( REGEX MATCH "g[0-9a-f]+$" git_hash "${git_describe}" ) - endif() - - # Construct the version variables - set( version ${version_major}.${version_minor}.${version_patch} ) - set( semver ${version} ) - - # Identifiers - if( identifiers MATCHES ".+" ) - string( SUBSTRING "${identifiers}" 1 -1 identifiers ) - set( semver "${semver}-${identifiers}") - endif() - - # Metadata - # TODO Split and join (add Git hash inbetween) - if( metadata MATCHES ".+" ) - string( SUBSTRING "${metadata}" 1 -1 metadata ) - # Split - string( REPLACE "." ";" metadata "${metadata}" ) - endif() - - if( NOT git_at_a_tag ) - - if( ARG_INCLUDE_HASH ) - list( APPEND metadata "${git_hash}" ) - endif( ARG_INCLUDE_HASH ) - - # Timestamp - if( DEFINED ARG_TIMESTAMP ) - string( TIMESTAMP timestamp "${ARG_TIMESTAMP}" ${ARG_UTC} ) - list( APPEND metadata "${timestamp}" ) - endif( DEFINED ARG_TIMESTAMP ) - - endif() - - # Join - string( REPLACE ";" "." metadata "${metadata}" ) - - if( metadata MATCHES ".+" ) - set( semver "${semver}+${metadata}") - endif() - - # Log the results - if( ARG_LOG ) - message( STATUS - "[MunkeiVersionFromGit] Version: ${version} - Git tag: [${git_tag}] - Git hash: [${git_hash}] - Decorated: [${git_describe}] - Identifiers: [${identifiers}] - Metadata: [${metadata}] - SemVer: [${semver}]" - ) - endif( ARG_LOG ) - - # Set parent scope variables - set( GIT_TAG ${git_tag} PARENT_SCOPE ) - set( SEMVER ${semver} PARENT_SCOPE ) - set( VERSION ${version} PARENT_SCOPE ) - set( VERSION_MAJOR ${version_major} PARENT_SCOPE ) - set( VERSION_MINOR ${version_minor} PARENT_SCOPE ) - set( VERSION_PATCH ${version_patch} PARENT_SCOPE ) - -endfunction( version_from_git ) \ No newline at end of file From bdf8b4cd7d3639c8d4cfbe059a5d606f916ffc33 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:29:43 +0100 Subject: [PATCH 03/22] doc publishing --- .github/workflows/sourcedoc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index 2e2cf715..9a3850b0 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -32,7 +32,7 @@ jobs: working-directory: ${{github.workspace}}/build shell: bash # Execute the build. You can specify a specific target with "--target " - run: cmake --build . --config $BUILD_TYPE --target doc + run: make doc - name: Deploy docs 🚀 uses: JamesIves/github-pages-deploy-action@4.0.0 From c0ed00a04e3948d3f8ebbf206c9d48841a38b5cf Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:32:35 +0100 Subject: [PATCH 04/22] publish docs --- .github/workflows/sourcedoc.yaml | 22 +++------------------- 1 file changed, 3 insertions(+), 19 deletions(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index 9a3850b0..dd77d28b 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -9,32 +9,16 @@ jobs: publish: runs-on: ubuntu-latest steps: - - name: Checkout 🛎️ + - name: Checkout uses: actions/checkout@v2.3.1 - - name: Create Build Environment - # Some projects don't allow in-source building, so create a separate build directory - # We'll use this as our working directory for all subsequent commands - run: cmake -E make_directory ${{github.workspace}}/build - - - name: Configure CMake - # Use a bash shell so we can use the same syntax for environment variable - # access regardless of the host operating system - shell: bash - working-directory: ${{github.workspace}}/build - # Note the current convention is to use the -S and -B options here to specify source - # and build directories, but this is only available with CMake 3.13 and higher. - # The CMake binaries on the Github Actions machines are (as of this writing) 3.12 - run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE - - name: Build docs - working-directory: ${{github.workspace}}/build shell: bash # Execute the build. You can specify a specific target with "--target " - run: make doc + run: mkdir build && cd build && cmake .. && make doc - - name: Deploy docs 🚀 + - name: Deploy docs uses: JamesIves/github-pages-deploy-action@4.0.0 with: branch: gh-pages # The branch the action should deploy to. From 5e0257840bc99f7495b468e928719199f2b47a8f Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:34:49 +0100 Subject: [PATCH 05/22] publish docs --- .github/workflows/sourcedoc.yaml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index dd77d28b..e51ae29b 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -12,11 +12,30 @@ jobs: - name: Checkout uses: actions/checkout@v2.3.1 + - name Install doxygen + run: sudo apt-get install doxygen + + + - name: Create Build Environment + # Some projects don't allow in-source building, so create a separate build directory + # We'll use this as our working directory for all subsequent commands + run: cmake -E make_directory ${{github.workspace}}/build + + - name: Configure CMake + # Use a bash shell so we can use the same syntax for environment variable + # access regardless of the host operating system + shell: bash + working-directory: ${{github.workspace}}/build + # Note the current convention is to use the -S and -B options here to specify source + # and build directories, but this is only available with CMake 3.13 and higher. + # The CMake binaries on the Github Actions machines are (as of this writing) 3.12 + run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE - name: Build docs + working-directory: ${{github.workspace}}/build shell: bash # Execute the build. You can specify a specific target with "--target " - run: mkdir build && cd build && cmake .. && make doc + run: make doc - name: Deploy docs uses: JamesIves/github-pages-deploy-action@4.0.0 From dcadbccc8e589ef60ee769bc6393795c22294219 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:35:35 +0100 Subject: [PATCH 06/22] publish docs --- .github/workflows/sourcedoc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index e51ae29b..808e5ef0 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -12,7 +12,7 @@ jobs: - name: Checkout uses: actions/checkout@v2.3.1 - - name Install doxygen + - name: Install doxygen run: sudo apt-get install doxygen From afd214f5eecc4f70aeea011e7822753f352fd6f6 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:47:23 +0100 Subject: [PATCH 07/22] fake From dc469eab2d0d4d7d1d3eb4d1ad74692a337fb3a9 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 19:55:10 +0100 Subject: [PATCH 08/22] fake From 0fa2358f1f678cd37ddf25dd072be280b07c95b8 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:04:24 +0100 Subject: [PATCH 09/22] auto github pages --- .github/workflows/sourcedoc.yaml | 6 +- CMakeLists.txt | 6 + README.md | 17 +-- leanux.doxygen | 229 +++++++++++++++++++++---------- 4 files changed, 171 insertions(+), 87 deletions(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index 808e5ef0..392e3a11 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -10,10 +10,10 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v2.3.1 + uses: actions/checkout@v1 - name: Install doxygen - run: sudo apt-get install doxygen + run: sudo apt-get install doxygen graphviz - name: Create Build Environment @@ -41,4 +41,4 @@ jobs: uses: JamesIves/github-pages-deploy-action@4.0.0 with: branch: gh-pages # The branch the action should deploy to. - folder: build/html # The folder the action should deploy. \ No newline at end of file + folder: build/doc # The folder the action should deploy. \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt index fd0fdece..4f3d177d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -409,6 +409,12 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}-config.hpp.in ${CMAKE_CURR # Doxygen source code documentation find_package(Doxygen) if(DOXYGEN_FOUND) +execute_process( COMMAND mkdir -p ${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen ) + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/README.md ${CMAKE_CURRENT_BINARY_DIR}/doc @ONLY) +configure_file(${CMAKE_CURRENT_BINARY_DIR}/lmon.1 ${CMAKE_CURRENT_BINARY_DIR}/doc @ONLY) + + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}.doxygen ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY) add_custom_target(doc diff --git a/README.md b/README.md index d96b4022..0a750a4a 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,21 @@ Leanux is a C++ API to Linux performance and configuration data and includes a few tools utilizing this API. -The C++ API eases access to system configuration data provided by the `/sysfs` pseudo filesystem, so including CPUs, block devices, network devices and so on. Additionally, the C++ API exposes performance data from the `/proc` pseudo fillesystem. +The C++ API eases access to system configuration data provided by the `/sys` pseudo filesystem, so including CPUs, block devices, network devices and so on. Additionally, the C++ API exposes performance data from the `/proc` pseudo fillesystem. The (C++) binaries produced by this repository are | component | purpose | |------|---------| | libleanux.so | Shared library backing the leanux C++ API, required by the below tools | -| [lard](https://www.o-rho.com/leanux/lard) | daemon that logs performance and base configuration data to a SQLite database file | -| [lmon](doc/lmon.md) | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | -| [lrep](https://www.o-rho.com/leanux/lrep) | generates html reports on lard data | -| [lsys](https://www.o-rho.com/leanux/lsys) | command-line tool to retrieve sysfs info for administrative use | -| [lblk](https://www.o-rho.com/leanux/lblk) | command-line tool to retrieve block device and filesystem info for administrative use | -| [labbix](https://www.o-rho.com/leanux/labbix) | Zabbix disk discovery and disk performance statistics for GNU/Linux | - +| lard | daemon that logs performance and base configuration data to a SQLite database file | +| lmon | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | +| lrep | generates html reports on lard data | +| lsys | command-line tool to retrieve sysfs info for administrative use | +| lblk | command-line tool to retrieve block device and filesystem info for administrative use | +| labbix | Zabbix disk discovery and disk performance statistics for GNU/Linux | + +See [leanux on github pages](https://jmspit.github.io/leanux) for more and source code documentation. ## Building from source Builds should work on any Linux host that satisfies diff --git a/leanux.doxygen b/leanux.doxygen index 74b7f376..759ad4a9 100644 --- a/leanux.doxygen +++ b/leanux.doxygen @@ -1,4 +1,4 @@ -# Doxyfile 1.8.12 +# Doxyfile 1.8.17 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -17,11 +17,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/doc/doxygen # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = # performance problems for the file system. # The default value is: NO. -CREATE_SUBDIRS = NO +CREATE_SUBDIRS = YES # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII @@ -93,6 +93,14 @@ ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. @@ -179,6 +187,16 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = YES +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus @@ -226,7 +244,12 @@ TAB_SIZE = 2 # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) ALIASES = "root=\xrefitem root_access \"root access required\" \"Requiring root access\"" @@ -264,17 +287,26 @@ OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: -# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: -# Fortran. In the later case the parser tries to guess whether the code is fixed -# or free formatted code, this is the default for Fortran type files), VHDL. For -# instance to make doxygen treat .inc files as Fortran files (default is PHP), -# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # @@ -285,7 +317,7 @@ EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. +# documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. @@ -297,7 +329,7 @@ MARKDOWN_SUPPORT = YES # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 0. +# Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 @@ -327,7 +359,7 @@ BUILTIN_STL_SUPPORT = YES CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. @@ -433,6 +465,12 @@ EXTRACT_ALL = YES EXTRACT_PRIVATE = YES +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. @@ -487,8 +525,8 @@ HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO, these declarations will be -# included in the documentation. +# declarations. If set to NO, these declarations will be included in the +# documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO @@ -511,7 +549,7 @@ INTERNAL_DOCS = YES # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. +# (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = YES @@ -698,7 +736,7 @@ LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. @@ -743,7 +781,8 @@ WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = YES @@ -794,7 +833,7 @@ INPUT = @CMAKE_CURRENT_SOURCE_DIR@ \ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. @@ -811,8 +850,10 @@ INPUT_ENCODING = UTF-8 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, -# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = @@ -970,7 +1011,7 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. +# entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = YES @@ -1002,12 +1043,12 @@ SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version +# (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # @@ -1147,7 +1188,7 @@ HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. @@ -1183,6 +1224,17 @@ HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = YES +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. @@ -1206,13 +1258,13 @@ HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1251,7 +1303,7 @@ DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output @@ -1327,7 +1379,7 @@ QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1335,7 +1387,7 @@ QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1344,7 +1396,7 @@ QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1352,7 +1404,7 @@ QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1360,7 +1412,7 @@ QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = @@ -1453,7 +1505,7 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # @@ -1464,8 +1516,14 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering +# https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path @@ -1492,8 +1550,8 @@ MATHJAX_FORMAT = HTML-CSS # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest @@ -1535,7 +1593,7 @@ MATHJAX_CODEFILE = SEARCHENGINE = NO # When the SERVER_BASED_SEARCH tag is enabled the search engine will be -# implemented using a web server instead of a web client using Javascript. There +# implemented using a web server instead of a web client using JavaScript. There # are two flavors of web server based searching depending on the EXTERNAL_SEARCH # setting. When disabled, doxygen will generate a PHP script for searching and # an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing @@ -1554,7 +1612,7 @@ SERVER_BASED_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). +# Xapian (see: https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1567,7 +1625,7 @@ EXTERNAL_SEARCH = NO # # Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Xapian (see: https://xapian.org/). See the section "External Indexing and # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1619,21 +1677,35 @@ LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. # -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate # index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). # The default file is: makeindex. # This tag requires that the tag GENERATE_LATEX is set to YES. MAKEINDEX_CMD_NAME = makeindex +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = makeindex + # If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. @@ -1754,7 +1826,7 @@ LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. # The default value is: plain. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1768,6 +1840,14 @@ LATEX_BIB_STYLE = plain LATEX_TIMESTAMP = NO +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- @@ -1807,9 +1887,9 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# configuration file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the # default style sheet that doxygen normally uses. @@ -1818,8 +1898,8 @@ RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. +# similar to doxygen's configuration file. A template extensions file can be +# generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = @@ -1905,6 +1985,13 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_NS_MEMB_FILE_SCOPE = NO + #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- @@ -1937,9 +2024,9 @@ DOCBOOK_PROGRAMLISTING = NO #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sf.net) file that captures the -# structure of the code including all documentation. Note that this feature is -# still experimental and incomplete at the moment. +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO @@ -2106,12 +2193,6 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- @@ -2125,15 +2206,6 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2361,6 +2433,11 @@ DIAFILE_DIRS = PLANTUML_JAR_PATH = +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block. From ad5438ec487f31dcc853f62c3cc6d9a748f87e0e Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:26:17 +0100 Subject: [PATCH 10/22] add man pages in pdf format --- CMakeLists.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 4f3d177d..d5035296 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -419,6 +419,11 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}.doxygen ${CMAKE_CURRENT_BI configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY) add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.txt WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) From bfd6aa97b20cd815f7094856ebafed4c838250d4 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:26:34 +0100 Subject: [PATCH 11/22] add refernce to github pages --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a750a4a..655cc595 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ The (C++) binaries produced by this repository are | lblk | command-line tool to retrieve block device and filesystem info for administrative use | | labbix | Zabbix disk discovery and disk performance statistics for GNU/Linux | -See [leanux on github pages](https://jmspit.github.io/leanux) for more and source code documentation. +See [leanux on github pages](https://jmspit.github.io/leanux) for more documentation. If you are on github pages now, +you can view the doxygen code documentation as [here](doxygen/html/index.html). ## Building from source Builds should work on any Linux host that satisfies From 094ebe89601b177a766e74e63b250d9e40532a5c Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:34:43 +0100 Subject: [PATCH 12/22] explictly install groff --- .github/workflows/sourcedoc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index 392e3a11..113ec2c7 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -13,7 +13,7 @@ jobs: uses: actions/checkout@v1 - name: Install doxygen - run: sudo apt-get install doxygen graphviz + run: sudo apt-get install doxygen graphviz groff - name: Create Build Environment From 47743b7d0f6cd67332a6ead6d5fef3a12fb9b16c Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:45:45 +0100 Subject: [PATCH 13/22] test display of ascii man pages --- CMakeLists.txt | 10 +++++----- README.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index d5035296..0afdc3df 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -419,11 +419,11 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}.doxygen ${CMAKE_CURRENT_BI configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY) add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tascii-man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.txt WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) diff --git a/README.md b/README.md index 655cc595..1cbd2b4f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The (C++) binaries produced by this repository are |------|---------| | libleanux.so | Shared library backing the leanux C++ API, required by the below tools | | lard | daemon that logs performance and base configuration data to a SQLite database file | -| lmon | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | +| [lmon](man_lmon.txt) | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | | lrep | generates html reports on lard data | | lsys | command-line tool to retrieve sysfs info for administrative use | | lblk | command-line tool to retrieve block device and filesystem info for administrative use | From 06fcf589e569091e9b5f0b3ebe90a2d018e15c58 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:52:51 +0100 Subject: [PATCH 14/22] groff not working --- .github/workflows/sourcedoc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index 113ec2c7..691a3439 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -13,7 +13,7 @@ jobs: uses: actions/checkout@v1 - name: Install doxygen - run: sudo apt-get install doxygen graphviz groff + run: sudo apt-get -f install doxygen graphviz groff gropdf - name: Create Build Environment From 01786ba230b591484fd52c633ca9d9c952d3c28b Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:54:18 +0100 Subject: [PATCH 15/22] groff not working --- .github/workflows/sourcedoc.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index 691a3439..d585ba63 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -12,8 +12,8 @@ jobs: - name: Checkout uses: actions/checkout@v1 - - name: Install doxygen - run: sudo apt-get -f install doxygen graphviz groff gropdf + - name: Install doxygen graphiz and groff + run: sudo apt-get -f install doxygen graphviz groff - name: Create Build Environment From 52ee2d2591dd714399648180845fe05a254603e8 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 21:57:34 +0100 Subject: [PATCH 16/22] fix typo --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 0afdc3df..baacaab9 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -420,7 +420,7 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINAR add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tascii-man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.txt COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.txt COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.txt COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.txt From c4cb52821cddd1ab1dcc337950642427ec9d4833 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 22:01:47 +0100 Subject: [PATCH 17/22] github pages does not like ascii with terminal escape sequences --- CMakeLists.txt | 10 +++++----- README.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index baacaab9..ed5b73bd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -419,11 +419,11 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}.doxygen ${CMAKE_CURRENT_BI configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY) add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.txt -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tascii -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.txt +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.pdf WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) diff --git a/README.md b/README.md index 1cbd2b4f..81e515d5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The (C++) binaries produced by this repository are |------|---------| | libleanux.so | Shared library backing the leanux C++ API, required by the below tools | | lard | daemon that logs performance and base configuration data to a SQLite database file | -| [lmon](man_lmon.txt) | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | +| [lmon](man_lmon.pdf) | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | | lrep | generates html reports on lard data | | lsys | command-line tool to retrieve sysfs info for administrative use | | lblk | command-line tool to retrieve block device and filesystem info for administrative use | From 7147d720cfd142914a764d8cb8a8aab745ecd86d Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 22:07:05 +0100 Subject: [PATCH 18/22] sigh --- CMakeLists.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ed5b73bd..9ce17729 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -419,11 +419,11 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}.doxygen ${CMAKE_CURRENT_BI configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY) add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tpfd -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.pdf +COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.pdf WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) From 0cd4aae72387f30b2cd84f308f4bb6ab51dcc5c5 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 22:10:58 +0100 Subject: [PATCH 19/22] use configured man pages --- CMakeLists.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9ce17729..61073b5c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -419,11 +419,11 @@ configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT}.doxygen ${CMAKE_CURRENT_BI configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY) add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lmon/lmon.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lsys/lsys.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lblk/lblk.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lard/lard.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.pdf -COMMAND cat ${CMAKE_CURRENT_SOURCE_DIR}/tools/lrep/lrep.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.pdf +COMMAND cat ${CMAKE_CURRENT_BINARY_DIR}/lmon.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lmon.pdf +COMMAND cat ${CMAKE_CURRENT_BINARY_DIR}/lsys.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lsys.pdf +COMMAND cat ${CMAKE_CURRENT_BINARY_DIR}/lblk.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lblk.pdf +COMMAND cat ${CMAKE_CURRENT_BINARY_DIR}/lard.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lard.pdf +COMMAND cat ${CMAKE_CURRENT_BINARY_DIR}/lrep.1 | groff -Tpdf -man > ${CMAKE_CURRENT_BINARY_DIR}/doc/man_lrep.pdf WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generating API documentation with Doxygen" VERBATIM ) From 9a60d1699309435a7e267dcc204703efbd7b57fc Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 22:14:11 +0100 Subject: [PATCH 20/22] doc update --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 81e515d5..a0fd1bfd 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,15 @@ The (C++) binaries produced by this repository are | component | purpose | |------|---------| | libleanux.so | Shared library backing the leanux C++ API, required by the below tools | -| lard | daemon that logs performance and base configuration data to a SQLite database file | +| [lard](man_lard.pdf) | daemon that logs performance and base configuration data to a SQLite database file | | [lmon](man_lmon.pdf) | ncurses (tty) based performance viewer, both real-time and browsing historic data from the lard daemon, with colors, dynamic screen resizing | -| lrep | generates html reports on lard data | -| lsys | command-line tool to retrieve sysfs info for administrative use | -| lblk | command-line tool to retrieve block device and filesystem info for administrative use | +| [lrep](man_lrep.pdf) | generates html reports on lard data | +| [lsys](man_lsys.pdf) | command-line tool to retrieve sysfs info for administrative use | +| [lblk](man_lblk.pdf) | command-line tool to retrieve block device and filesystem info for administrative use | | labbix | Zabbix disk discovery and disk performance statistics for GNU/Linux | See [leanux on github pages](https://jmspit.github.io/leanux) for more documentation. If you are on github pages now, -you can view the doxygen code documentation as [here](doxygen/html/index.html). +you can view the doxygen code documentation as [here](doxygen/html/index.html), and the links in the above table will link to pdf documents. ## Building from source Builds should work on any Linux host that satisfies From a17b72c29d62eec2ae59c6409f47f17c3eaa8aa9 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 22:22:13 +0100 Subject: [PATCH 21/22] fix typo --- tools/lrep/lrep.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/lrep/lrep.1 b/tools/lrep/lrep.1 index 8869dcdc..ac83e302 100644 --- a/tools/lrep/lrep.1 +++ b/tools/lrep/lrep.1 @@ -46,7 +46,7 @@ generates reports from a lard sqlite \fIdatabase\fR (file). the report range can be specified as either a trail of the last \fIminutes\fR minutes, or by specifying a full time range with \fIbegin\fR and \fIend\fR. .PP -The lard daemon creates ad samples to a lard database file, which is a SQLite3 +The lard daemon creates and samples to a lard database file, which is a SQLite3 database, so it can be queried with sqlite3 as well. .PP Note that to create the report, the euid must have write access to the From 50b406877592a071e507bab064f3d357a23393b1 Mon Sep 17 00:00:00 2001 From: Jan-Marten Spit Date: Wed, 3 Mar 2021 22:25:26 +0100 Subject: [PATCH 22/22] github pages update on push to master --- .github/workflows/sourcedoc.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/sourcedoc.yaml b/.github/workflows/sourcedoc.yaml index d585ba63..4cd5ed2c 100644 --- a/.github/workflows/sourcedoc.yaml +++ b/.github/workflows/sourcedoc.yaml @@ -3,7 +3,7 @@ name: Publish doc on: push: branches: - - jmspit + - master jobs: publish: