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

Standardize nut_ser_addvars() for common code and documentation #2748

Open
jimklimov opened this issue Jan 3, 2025 · 0 comments
Open

Standardize nut_ser_addvars() for common code and documentation #2748

jimklimov opened this issue Jan 3, 2025 · 0 comments
Labels
documentation enhancement portability We want NUT to build and run everywhere possible serial port
Milestone

Comments

@jimklimov
Copy link
Member

We have a number of serial-port communications capable drivers, each of which reinvents the wheel about the set and names of parameters involved in the connection set-up (speed, parity, stop-bits, etc.)

There is a nice precedent with nut_usb_addvars() adopted by most USB-capable drivers (with a couple exceptions at the moment), which standardizes and simplifies both the code (drivers themselves, C++ parser bindings, augeas lenses...) and man page documentation inlays.

This issue is to track a similar idea for serial-port drivers (including multiple-capability programs like nutdrv_qx or *modbus drivers), deprecating obscure option names where needed (still accepting them as aliases though).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement portability We want NUT to build and run everywhere possible serial port
Projects
None yet
Development

No branches or pull requests

1 participant