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

man: substantially update the docs regarding hooking sd-bus objects u… #11127

Merged
merged 1 commit into from Dec 13, 2018

Conversation

poettering
Copy link
Member

…p with external event loops

Prompted by https://lists.freedesktop.org/archives/systemd-devel/2018-December/041817.html

This also drops all references to select() from our manpages. It's 2018
after all, people should use poll(), or ppoll() or epoll().

Copy link
Member

@keszybz keszybz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very nice. Some minor type-proofing comments. Do you have a local definition of fill-column? It seems 119 is still being used in those patches.

man/sd_bus_get_fd.xml Outdated Show resolved Hide resolved
man/sd_bus_get_fd.xml Outdated Show resolved Hide resolved
man/sd_bus_get_fd.xml Outdated Show resolved Hide resolved
man/sd_bus_get_fd.xml Outdated Show resolved Hide resolved
man/sd_bus_process.xml Outdated Show resolved Hide resolved
man/sd_bus_wait.xml Outdated Show resolved Hide resolved

<para>Note that <function>sd_bus_wait()</function> is suitable only for simple programs as it does not permit
waiting for other I/O events than the ones of the bus connection itself. For more complex programs either connect
the bus connection object to an external or manual event loop using
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"external or manual" → "external"

…p with external event loops

Prompted by https://lists.freedesktop.org/archives/systemd-devel/2018-December/041817.html

This also drops all references to select() from our manpages. It's 2018
after all, people should use poll(), or ppoll() or epoll().
@poettering
Copy link
Member Author

Force pushed a new version. Only changes were the ones @keszybz pointed out (though I replicated the same ECHILD fix to the other two man pages). Taking liberty to set green label, given how minor the fixes are and given that documentation is generally pretty riskless.

@poettering poettering added the good-to-merge/waiting-for-ci 👍 PR is good to merge, but CI hasn't passed at time of review. Please merge if you see CI has passed label Dec 13, 2018
@poettering poettering merged commit ffd1a3f into systemd:master Dec 13, 2018
@keszybz keszybz removed the good-to-merge/waiting-for-ci 👍 PR is good to merge, but CI hasn't passed at time of review. Please merge if you see CI has passed label Dec 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants