Remove lazy_static dependency and fix syslib docs #14
Conversation
isbm
added
documentation
The main use of lazy_static for microhop is to have global Strings to represent mountpoints, but this can bee solved by using &'static str. Some functions however dynamically construct different mountpoints, so make mount_fs() generic, so it accepts both &str and String. In order to further simplify things, introduce a new struct to represent a system directory to be mounted instead of using 3-tuples.
|
@isbm sure. The docstring you've updated will not show up the generated docs though (it needs to start with |
Module-level documentation must start with "//!" and be present before any actual code, even imports.
|
@00xc for whatever reasons clippy was upset on me, so I made it quick-n-dirty to just fix the workflow. 😉 As long as "insanity check" is through — I am fine with anything. As of docs — I usually use readthedocs, but this project was a... hackweek-like quality, so give me some credit on its immaturity! 😆 Microhop was intended to run on embedded machines, where no automatic stuff needed, like typically we have on SUSE/Debians. But I am totally opened for the ideas, as long as it helps keeping initrd damn small and systemd-free 🤣 |
|
Sure, it's just that |
|
@00xc my point is: microhop is really manual yet. It is best cooked with immutable images at the moment and used in Automotive. E.g. updating kernel is still not "automated" as one would e.g. "zypper up", because you would need to regenerate it. But in case you want to add something else — np. 😉 |
I don't see what this has to do with rustdoc-generated documentation. My change is just an useful thing for developers running |
isbm
left a comment
isbm
left a comment
There was a problem hiding this comment.
LGTM though. I would give it a go.
|
@00xc thanks! 👍🏼 |
3 participants
Remove the need for the
lazy_staticdependency by using&'static strinstead ofStringin globals, and fix some docs that were not properly picked up by rustdoc.