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

Improve help of transactional-update + bash completions #12

Open
okurz opened this issue Apr 23, 2018 · 3 comments
Open

Improve help of transactional-update + bash completions #12

okurz opened this issue Apr 23, 2018 · 3 comments

Comments

@okurz
Copy link
Member

okurz commented Apr 23, 2018

I was testing openSUSE Leap 15.0 Beta with the new "transactional server" system role which basically works very convincing. However I found the help text of transactional-update a bit lacking. Also, for such a tool bash completions would be nice.

Please see the above points as very kind feedback in form of feature requests. Feel free to tell me to use a different format to formulate the feature request(s).

@laenion
Copy link
Collaborator

laenion commented Apr 23, 2018

Which help text for transactional-update are you referring to? Do you mean the man pages or the README.md in this repository?
If it's the former: Which information did you miss? If it's the later: I'm currently trying to reorganize the available documentation and find an appropriate place suitable for references. By the way: the doc directory in this repository also contains several helpful documents.

@okurz
Copy link
Member Author

okurz commented Apr 26, 2018

The man page is fine, the README.md here is also ok. Sorry, if I am unclear, I meant the help text of the application in the installed system, so https://github.com/openSUSE/transactional-update/blob/master/sbin/transactional-update.in#L82

laenion added a commit to laenion/transactional-update that referenced this issue May 3, 2018
Synopsis syntax was getting longer and longer using the old format, so split
it into different command types and adjust the documentation accordingly.

This should also solve the help text part of openSUSE#12.
laenion added a commit that referenced this issue May 4, 2018
Synopsis syntax was getting longer and longer using the old format, so split
it into different command types and adjust the documentation accordingly.

This should also solve the help text part of #12.
@kalikiana
Copy link
Member

kalikiana commented Feb 20, 2020

Some thoughts on this:

  • The benefits of the dup, up, migration and pkg * commands as opposed to going into the shell and using zypper directly are not being explained here.
  • --continue is one small item on the list when I might think it should be in your face considering its importance. Getting a message like "will use an older snapshot" in the shell for example is not all that clear and likely ends up losing some of your changes.
  • I'm guessing the "general commands" besides the shell command should be convenience wrappers? I'd suggest moving them into a topic with a brief note on the use case. I don't actually know if or why I would need them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants