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

systemd-stdio-bridge is not documented #4784

Closed
fsateler opened this issue Dec 1, 2016 · 4 comments

Comments

@fsateler
Copy link
Member

commented Dec 1, 2016

Submission type

  • Bug report

systemd version the issue has been seen with

git master

In case of bug report: Expected behaviour you didn't see

A man page for all binaries installed into /usr/bin

In case of bug report: Unexpected behaviour you saw

systemd-stdio-bridge is missing a manpage.

@poettering

This comment has been minimized.

Copy link
Member

commented Dec 1, 2016

it's an internal tool, it's never supposed to be called directly. The only reason it's in $PATH, is that we invoke it on a remote system for the ssh dbus transport, where we don't know whether systemd's private directory is /usr/lib/systemd or /lib/systemd or anything else, and hence prefer relying on the search path.

I don't think this should have a man page. It's really not user-facing, and we generally don't document all internal files of systemd via man pages.

@fsateler

This comment has been minimized.

Copy link
Member Author

commented Dec 1, 2016

I think it should be moved to $rootlibdir/systemd then, and always invoked via /lib/systemd/systemd-stdio-bridge. Or does systemd want to support systems with merged-usr but where /lib does not point to /usr/lib ?

I don't think this should have a man page. It's really not user-facing, and we generally don't document all internal files of systemd via man pages.

By virtue of placing it in a public path, you make it user-facing.

@boucman

This comment has been minimized.

Copy link
Contributor

commented Dec 31, 2016

would it be possible to mention in --help that it's an internal systemd tool ?

@madscientist42

This comment has been minimized.

Copy link

commented Sep 6, 2017

Even internal use tools need DOCUMENTATION, guys.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
You can’t perform that action at this time.