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 DDL entries with upsrw/upscmd comments to use RW and CMD keywords #20

Open
jimklimov opened this issue Apr 25, 2022 · 1 comment
Labels
CI = tools + scripts + recipes DDL Report for NUT Device Data/Dumps Library documentation Docs about NUT DDL enhancement

Comments

@jimklimov
Copy link
Member

jimklimov commented Apr 25, 2022

Primarily mea culpa about earlier commits as I was learning this corner of the NUT ecosystem and amassing DDL info from github issues and mailing list posts.

Also check about "Source:" and "Vendor:" headers used in many older files to streamline links to NUT issues and Vendor product pages, maybe document those as a markup standard?

@jimklimov
Copy link
Member Author

After the merge of #33 (as well as networkupstools/nut#2006 to generate and networkupstools/nut-website#42 to handle the new markup), the nut-ddl contents should make it relatively easy to find and fix the "unstructured" variable and command reports.

Note that currently the NUT tools/nut-ddl-dump.sh provides such information as direct dumps from upsrw and upscmd (there are now 3 reports which state that they come from the script, and may more tagged with DEVICE:COMMENT-BLOCK:FIXME:(UPSRW|UPSCMD): overall). If there are later efforts to automate production of #CMD:..., #RW:... and #RO:... comments to convert existing and incoming reports, it may be worthwhile to address them in that script too.

@jimklimov jimklimov added DDL Report for NUT Device Data/Dumps Library documentation Docs about NUT DDL CI = tools + scripts + recipes labels Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI = tools + scripts + recipes DDL Report for NUT Device Data/Dumps Library documentation Docs about NUT DDL enhancement
Projects
Status: Todo
Development

No branches or pull requests

1 participant