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

Obsolete references to quadlet(5) #25063

Closed
tangentsoft opened this issue Jan 21, 2025 · 7 comments · Fixed by #25077
Closed

Obsolete references to quadlet(5) #25063

tangentsoft opened this issue Jan 21, 2025 · 7 comments · Fixed by #25077
Labels
documentation Issue or fix is in project documentation kind/bug Categorizes issue or PR as related to a bug.

Comments

@tangentsoft
Copy link
Contributor

Issue Description

This man page at least needs to have the references to quadlet(5) replaced with podman-systemd.unit(5).

More broadly, the term "Quadlet" is becoming confusing by being still-used yet officially semi-deprecated in favor of bland systemd terminology.

Steps to reproduce the issue

  1. $ man podman-auto-update
  2. Despair. 😉

Describe the results you received

Aren't mandatory fields fun?

Describe the results you expected

I mean, I'm just aswim in endorphins from being made to fill all this out.

podman info output

Please, sir, may I have _another_ form?

Podman in a container

No

Privileged Or Rootless

None

Upstream Latest Release

Yes

Additional environment details

Additional environment details

Additional information

Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting

@tangentsoft tangentsoft added the kind/bug Categorizes issue or PR as related to a bug. label Jan 21, 2025
@vrothberg
Copy link
Member

I don't understand the request. man quadlet is a link to man podman-systemd.unit which itself uses the term quadlet everywhere.

@Luap99 Luap99 added the documentation Issue or fix is in project documentation label Jan 21, 2025
@Luap99
Copy link
Member

Luap99 commented Jan 21, 2025

More broadly, the term "Quadlet" is becoming confusing by being still-used yet officially semi-deprecated in favor of bland systemd terminology.

I don't follow that sentence either, quadlet is not/never was deprecated.

However I do agree that we should update the man page links, the man page is NOT called quadlet. It is podman-systemd.unit(5) and quadlet(5) just is a symlink to that. And for the web docs there is https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html but no quadlet page.
So using one page consistently (that we can also properly link on the web site) is much better than just quadlet(5) which is not linked there

@rhatdan
Copy link
Member

rhatdan commented Jan 21, 2025

Please open a PR to change the reference, but the name quadlet should not go away. It is a well known concept and a major feature that driving lots of use of Podman.

@tangentsoft
Copy link
Contributor Author

I don't understand the request. man quadlet is a link to man podman-systemd.unit which itself uses the term quadlet everywhere.

The problem is that not everyone interacts with these documents via man. You can't even have a proper "command line junkies" vs "GUI weenies" type of argument here owing to unfortunate facts like this one:

$ brew list podman | grep -Fc quadlet.5
0

So now you have macOS people like me who love the CLI filing issues like this to point out that "man 5 quadlet" doesn't exist, not realizing that the problem is limited to my particular type of setup. The actual motivation behind me filing the issue was a Discord post from someone performing a search on podman.io and getting broken links in these references. Now we have two separate reasons to fix this.

I will attempt a PR to fix this shortly.

@tangentsoft
Copy link
Contributor Author

the term "Quadlet" is becoming confusing by being still-used yet officially semi-deprecated in favor of bland systemd terminology.

I don't follow that sentence either, quadlet is not/never was deprecated.

That's why I used the term "semi-deprecated". There have been several people asking on the Discord "what's a Quadlet" and then becoming confused when you point them at systemd docs that may not speak of Quadlets at all. It doesn't help that it's a math joke that doesn't tie directly into anything else in the Podman sphere.

But I'm not arguing for removal of "Quadlet" as a term. If anything, we need more mentions, widely spread, to increase the chance that any given investigator will stumble on a path that leads them toward enlightenment.

@rhatdan
Copy link
Member

rhatdan commented Jan 22, 2025

SGTM.

BTW we do not do the brew release. Not sure who does, but they should be told to include the link files, if MAC supports them.

@tangentsoft
Copy link
Contributor Author

they should be told to include the link files, if MAC supports them.

macOS is Unix®, so yes, it does support symlinks.

They've now been told.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue or fix is in project documentation kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants