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

dnf5-group: add page #14958

Merged
merged 14 commits into from
Nov 26, 2024
Merged

dnf5-group: add page #14958

merged 14 commits into from
Nov 26, 2024

Conversation

sohang3112
Copy link
Contributor

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known): dnf5 version 5.2.7.0

@sohang3112 sohang3112 requested a review from cyqsimon as a code owner November 24, 2024 05:59
@github-actions github-actions bot added new command Issues requesting creation of a new page. page edit Changes to an existing page(s). labels Nov 24, 2024
Copy link
Collaborator

@cyqsimon cyqsimon left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM with a few comments.

pages/linux/dnf-group.md Outdated Show resolved Hide resolved
pages/linux/dnf-group.md Outdated Show resolved Hide resolved
sohang3112 and others added 2 commits November 24, 2024 15:22
Co-authored-by: cyqsimon <28627918+cyqsimon@users.noreply.github.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
pages/linux/dnf-group.md Outdated Show resolved Hide resolved
pages/linux/dnf-group.md Show resolved Hide resolved
sohang3112 and others added 3 commits November 24, 2024 16:13
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
@sohang3112 sohang3112 changed the title dnf-group: add page dnf5-group: add page Nov 24, 2024
@cyqsimon
Copy link
Collaborator

cyqsimon commented Nov 24, 2024

It's worth noting that dnf v5 only just became the default on Fedora 41. There are still many derivative distros out there (RHEL being the prime example) still on dnf v4, and due to their stability guarantees this will continue to be the case for a loooong time into the future.

For those unaware, there are quite a number of breaking changes from v4 to v5. Two in particular that are pertinent to the CLI are:

  1. Some compound word long options (e.g. --nobest) are now hyphen-separated (--no-best).
  2. Some deprecated commands (e.g. dnf grouplist) have been removed (superceded by dnf group list).

In short, I do not think it is a great idea to state that these two are equivalent at this moment in time. At minimum, there should be a notice/warning about how this may not be the case.

@cyqsimon cyqsimon self-requested a review November 24, 2024 15:02
Copy link
Collaborator

@cyqsimon cyqsimon left a comment

Choose a reason for hiding this comment

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

As explained in my comment.

@sohang3112
Copy link
Contributor Author

@cyqsimon So what would be appropriate according to you - just delete dnf-group.md alias page and leave rest as it is?

@sebastiaanspeck also what are your thoughts on this?

@cyqsimon
Copy link
Collaborator

With a bit more in-depth consideration, it's not as straight-forward as I thought. Sorry about making it sound easier than it actually is.

Here's a table to summarise the current situation. The strike-through ones are EOL:

Distro dnf v4 dnf v5
RHEL 8 & 9 dnf microdnf
Fedora 36 & lower dnf microdnf
Fedora 37 & 38 & 39 dnf dnf5
Fedora 40 dnf dnf5
Fedora 41 & higher N/A dnf (symlinked to dnf5), dnf5

On how microdnf became dnf5 and other related details, see Fedora Wiki.

Also related: #12316. The situation is slightly different but still very relevant.

@sohang3112
Copy link
Contributor Author

@cyqsimon I tested with dnf 4 also in docker (docker run -it fedora:40 /bin/bash) - all the documented commands worked, only slight difference in dnf group list that dnf5 had tabular output while dnf 4 didn't.

Since dnf either points to dnf 4 or 5, how about simply making identical pages for dnf group and dnf5 group without alias, just copying whole content with command names changed?

@cyqsimon
Copy link
Collaborator

cyqsimon commented Nov 25, 2024

I tested with dnf 4 also in docker (docker run -it fedora:40 /bin/bash) - all the documented commands worked, only slight difference in dnf group list that dnf5 had tabular output while dnf 4 didn't.

That's reassuring to hear. Knowing this, I feel less worried about using an alias page.

Since dnf either points to dnf 4 or 5, how about simply making identical pages for dnf group and dnf5 group without alias, just copying whole content with command names changed?

In light of your verification, this would be redundant. Under the current situation, I think it's best we view the install name dnf5 as a temporary name during the transition period, i.e. the "aliaser", with a note on potential incompatibilities on different distros. The main page(s) stay with dnf. Maybe something like this?

Note: between Fedora 37 and 40 (inclusive), DNF v4 is installed as dnf while DNF v5 is installed as dnf5.

What I suspect eventually will happen is Fedora 44 or something installs v5 as dnf directly and gets rid of the install name dnf5. If we do it like this, it will be easier to either deprecate or remove the page(s) for dnf5 when that happens.

Apologies for the back and forth and all the hassle. Different install names is always a PITA to deal with.

@sohang3112 sohang3112 requested a review from cyqsimon November 25, 2024 11:47
@sohang3112
Copy link
Contributor Author

@cyqsimon Now I made dnf5 group an alias of dnf group instead of other way around - please check it now.

pages/linux/dnf5-group.md Show resolved Hide resolved
pages/linux/dnf.md Outdated Show resolved Hide resolved
sohang3112 and others added 3 commits November 26, 2024 12:41
Co-authored-by: cyqsimon <28627918+cyqsimon@users.noreply.github.com>
Co-authored-by: cyqsimon <28627918+cyqsimon@users.noreply.github.com>
@sohang3112
Copy link
Contributor Author

@cyqsimon Changes you suggested are done, please merge now

@cyqsimon cyqsimon merged commit 7b66eb9 into tldr-pages:main Nov 26, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page. page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants