Skip to content

Conversation

@air5551
Copy link

@air5551 air5551 commented Jan 27, 2026

Sanity check list

  • This PR is named to help easy searches (identify the vendor, device...)

  • Data dump file name follows this pattern (safely using ASCII characters):
    <manufacturer>__<model>__<driver-name>__<nut-version>__<report-number>.<extension>
    (more nuances are documented on site).

  • This file is placed into a sub-directory named same as the manufacturer.

  • Was this content prepared with nut-ddl-dump.sh script?

  • Information from upsc discovered fields is provided un-commented.

  • Additional data about supported RW variables and/or instant commands
    is provided (as comments)...

  • ...prefixed with standardized comment mark-up as documented on site,
    e.g.:

#RW:<var.name>:<type>:<options>

and

#CMD:<command.name>
  • Mark-up for other structured comments is followed (for fields, vars,
    etc. as documented on site), where applicable.

  • For devices supported only with special settings in their ups.conf
    configuration section (e.g. vendorid and productid required along
    with a USB subdriver), example section content is welcome as a comment.

  • For a newly discovered supported device, a sibling PR for the main
    NUT codebase (at least
    docs/driver.list.in,
    or possibly VID/PID and other auto-detection mapping tables in the driver
    sources) is welcome.

  • This PR is linked to relevant issue(s) and/or PRs in the NUT project,
    if applicable (new driver submissions, bug fixes/discussions, etc.).

air5551 added 2 commits January 26, 2026 20:11
Signed-off-by: air5551 <Air@example.org>
Signed-off-by: air5551 <Air@example.org>
jimklimov and others added 7 commits January 27, 2026 08:56
Signed-off-by: Jim Klimov <jimklimov+nut@gmail.com>
…s in comment [networkupstools#57]

Signed-off-by: Jim Klimov <jimklimov@gmail.com>
Signed-off-by: Jim Klimov <jimklimov@gmail.com>
…l.py too

Signed-off-by: Jim Klimov <jimklimov@gmail.com>
Signed-off-by: Jim Klimov <jimklimov@gmail.com>
… DEVICE:COMMENT-BLOCK:UPSCONF; there should be no TABs in it [networkupstools#57]

Signed-off-by: Jim Klimov <jimklimov@gmail.com>
… inline #COMMENT for one data point [networkupstools#57]

Signed-off-by: Jim Klimov <jimklimov@gmail.com>
@jimklimov
Copy link
Member

Thanks! The PR got a bit mired in our syntax expectations (and checks for those) as needed for further parsing into the web pages, but I've hopefully fixed both sides of that equation :)

@jimklimov jimklimov added DDL Report for NUT Device Data/Dumps Library CI = tools + scripts + recipes labels Jan 27, 2026
@jimklimov jimklimov merged commit 29cfb81 into networkupstools:master Jan 27, 2026
2 checks passed
@air5551
Copy link
Author

air5551 commented Jan 27, 2026

Thanks! The PR got a bit mired in our syntax expectations (and checks for those) as needed for further parsing into the web pages, but I've hopefully fixed both sides of that equation :)

Tried to read to docs as best I could but It really needs to be changed

@jimklimov
Copy link
Member

Well, one part was that for the PRs from new contributors the GHA checks do not run (must be approved by a team member) so the automated stuff did not complain to you early enough.

The other part about docs - PRs to those are welcome too. Newcomers are much better at seeing which edges are rough :)

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants