search

lucab / zbus_systemd

A pure-Rust library to interact with systemd DBus services
https://docs.rs/zbus_systemd
27 stars 7 forks source link

Documentation #8

Open blueforesticarus opened 2 years ago

blueforesticarus commented 2 years ago

Is there any systemd documentation we can automatically pull from to add rustdoc to the generated methods?

blueforesticarus commented 2 years ago

https://www.freedesktop.org/software/systemd/man/org.freedesktop.systemd1.html some of the info here looks scrap-able but it isn't ideal

blueforesticarus commented 2 years ago

Kind-of a side-note but I notice that the systemd source does have these tables: https://github.com/systemd/systemd/blob/main/src/core/job.c#L1587-L1596

And those Enums do have documentation. https://github.com/systemd/systemd/blob/main/src/core/job.h#L73-L85

So it might be possible to make some of the string interfaces into documented enums.