Skip to content

Revise driver man pages to include all known options (and their data types)Β #2422

Open

Description

@jimklimov

Absence of documentation uncovered during work on #2294 (note also subsequent issues about proposed change of some option names and data types).

Some values seem to have been reserved in original development but are not implemented (check if they are commented-away; maybe use block comments /* ... */ with * prefix in each internal line for grep findings to be better visible - maybe update gen-nutupsconf-aug.py.in accordingly to ignore such lines).

Work on this issue (to update docs) can benefit from research done for #2294 and codified in the UpsConfiguration class of nutconf codebase.

One helpful data extraction scriptlet (just search for !!! in the less viewer session):

:; ( cd scripts/augeas && python ./gen-nutupsconf-aug.py.in )

:; grep -E '[=|] "' scripts/augeas/nutupsconf.aug.in | awk '{print $NF}' | tr -d '"' \
  | while read O ; do echo "=== $O :" ; \
    grep -w '"'"$O"'"' ./include/nutconf.hpp ; \
    grep -A10 -w "$O" ./docs/man/*.txt || echo '!!! UNDOCUMENTED !!!' ; \
    echo "-----"; grep -A10 -w '"'"$O"'"' ./drivers/*.{c,h} || echo '!!! NOT USED IN CODE !!!' ; \
    echo "-----"; echo "" ; done | less

NOTE: I'm sure there were other logged issues for man page revision but could not find them now. Maybe github ate some - there are certainly some issue numbers referenced from others and from code/commit comments that can not open now.

Activity

  1. added
    refactor/fightwarnPR or issue proposal to improve code maintainability without functional changes, or to fix warnings
    nutconfNUT configuration library and tool
    impacts-release-2.8.2Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks)
    on Apr 27, 2024
  2. added this to the 2.8.3 milestone on Apr 27, 2024
  3. added
    Low-hanging fruitA proposal or issue that is good for newcomers to codebase or otherwise a quick win
    on Apr 27, 2024
  4. modified the milestones: 2.8.3, 2.8.4 on Jan 8, 2025
  5. modified the milestones: 2.8.4, 2.8.5 on Jul 29, 2025
  6. modified the milestones: 2.8.5, 2.8.6 on Feb 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Low-hanging fruitA proposal or issue that is good for newcomers to codebase or otherwise a quick windocumentationenhancementimpacts-release-2.8.2Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks)nutconfNUT configuration library and toolrefactor/fightwarnPR or issue proposal to improve code maintainability without functional changes, or to fix warnings

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions