Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jimklimov opened this issue Apr 27, 2024 · 0 comments
Labels
documentation enhancement impacts-release-2.8.2 Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks) Low-hanging fruit A proposal or issue that is good for newcomers to codebase or otherwise a quick win nutconf NUT configuration library and tool refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings
Milestone

Comments

@jimklimov
Copy link
Member

jimklimov commented Apr 27, 2024

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.

@jimklimov jimklimov added enhancement documentation refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings nutconf NUT configuration library and tool impacts-release-2.8.2 Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks) labels Apr 27, 2024
@jimklimov jimklimov added this to the 2.8.3 milestone Apr 27, 2024
@jimklimov jimklimov added the Low-hanging fruit A proposal or issue that is good for newcomers to codebase or otherwise a quick win label Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement impacts-release-2.8.2 Issues reported against NUT release 2.8.2 (maybe vanilla or with minor packaging tweaks) Low-hanging fruit A proposal or issue that is good for newcomers to codebase or otherwise a quick win nutconf NUT configuration library and tool refactor/fightwarn PR or issue proposal to improve code maintainability without functional changes, or to fix warnings
Projects
None yet
Development

No branches or pull requests

1 participant