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

Documentation consistency #98

Open
markhindley opened this Issue Nov 23, 2018 · 5 comments

Comments

Projects
None yet
2 participants
@markhindley
Copy link
Contributor

markhindley commented Nov 23, 2018

Hi,

Thanks for v239.2.

As I mentioned on #elogind, I have noticed that there are still quite a few references to systemd in the manpages, that I think should be elogind. I have patched some of them for De[vu|bi]an. The patch is at https://git.devuan.org/devuan-packages/elogind/blob/suites/experimental/debian/patches/manpage-branding.diff if it is useful for you. But I am not sure that it is exhaustive.

There are also some systemd remnants in the documentation that I am not sure are true. For example pam_elogind.xml says "If the system was not booted up with systemd as init system,
this module does nothing and immediately returns PAM_SUCCESS". I hope that isn't true!!!!

I hope this isn't too vague, but just a request that the documentation more clearly reflects what elogind does/doesn't do.

Thanks

Mark

@Yamakuzure

This comment has been minimized.

Copy link
Collaborator

Yamakuzure commented Nov 23, 2018

Yes, that's very helpful, thank you very much!

The documentation is a horror to maintain. I bet there are tons of locations where something is mentioned that isn't even possible.

But that the pam_elogind man page shows bullshit like that is a riddle to me. I am sure I got rid of that section ages ago! Finding out that I either did not, or that it was reverted by some systemd commit migration that went wrong, is just horrible!

I am preparing v238.3 right now. It is already migrated to latest systemd-stable/v238-stable commit. The next step is to backport fixes and additions from master/v239-stable.

Before I get that released, I will overhaul the documentation. If anybody wants to help, I'd be really grateful!
At least the rework can then be forwarded to master/v239-stable, and I hope it'll push us forward a great deal.

@markhindley

This comment has been minimized.

Copy link
Contributor Author

markhindley commented Nov 23, 2018

@Yamakuzure

This comment has been minimized.

Copy link
Collaborator

Yamakuzure commented Nov 24, 2018

I am happy to help, but my knowledge of elogind internals is still patchy at best, so I tend to spot inconsistencies rather than necessarily know if it is correct!

Sounds perfect to me! 😉

I have backported almost all changes and additions from v239 to v238 and will dig into the documentation next.
Well, I have to admit that I do not look forward to it. Documentation, no matter how important, is both stressful and boring as hell. 😠 🤷‍♂️

@Yamakuzure Yamakuzure self-assigned this Nov 24, 2018

@Yamakuzure

This comment has been minimized.

Copy link
Collaborator

Yamakuzure commented Nov 26, 2018

@markhindley : I am currently applying your patch. Great work so far! I never realized how much there really is to do! 🤔

Yamakuzure added a commit that referenced this issue Nov 26, 2018

Prep v238.3: Fix documentation to refer to elogind (#98)
These are changes based on the current patch for De[vu|bi]an.

Bug: #98
Signed-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 26, 2018

Prep v239.3: Fix documentation to refer to elogind (#98)
These are changes based on the current patch for De[vu|bi]an.

Bug: #98
Signed-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 26, 2018

Prep v240: Fix documentation to refer to elogind (#98)
These are changes based on the current patch for De[vu|bi]an.

Bug: #98
Signed-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 27, 2018

Prep v238.3: Make elogind man page refs migration agnostic (#98)
This update masks all references to "man 1 systemd" and substitutes
these with "man 8 elogind", to make the reference migration agnostic.

Bug: #98
Signed-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 29, 2018

Prep v239.3: Make elogind man page refs migration agnostic (#98)
This update masks all references to "man 1 systemd" and substitutes
these with "man 8 elogind", to make the reference migration agnostic.

Bug: #98
Signed-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 29, 2018

Prep v239.3: Update documentation to be more consistent (#98)
These updates try to get rid of most systemd-only parts, and to
substitute systemd specific parts with wordings and descriptions that
fit with elogind.

Bug: #98
Sigend-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 29, 2018

Prep v239.3: Update documentation to be more consistent (#98)
These updates try to get rid of most systemd-only parts, and to
substitute systemd specific parts with wordings and descriptions that
fit with elogind.

Bug: #98
Sigend-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Nov 29, 2018

Prep v238.3: Update documentation to be more consistent (#98)
These updates try to get rid of most systemd-only parts, and to
substitute systemd specific parts with wordings and descriptions that
fit with elogind.

Bug: #98
Sigend-Off-By: Sven Eden <sven.eden@prydeworx.com>

Yamakuzure added a commit that referenced this issue Dec 7, 2018

Version 239.3 Release
This is a service release, bringing the following changes and fixes:

Fixes:
 * Clean up bus_creds_dump()
 * Fix documentation to refer to elogind. (#98)
 * Fixed another Unicode test that has slithered in. (#99)

Changes / Additions:
 * sd_bus_creds_get_[user_]slice() simplified.
 * Updated documentation to be more consistent (#98)
 * Also search machine-id in the dbus default path. (#100)
@Yamakuzure

This comment has been minimized.

Copy link
Collaborator

Yamakuzure commented Dec 13, 2018

In the beginning, when overhauling man/systemd.xml into man/elogind.xml, the whole SIGNALS section got masked.

Those parts, that are relevant for elogind, have to be put back in.
Bug #104 might have been caused somewhat by it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment