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

First shot at rpm-ostree command reference #89

Merged
merged 3 commits into from
Mar 1, 2018

Conversation

miabbott
Copy link
Contributor

No description provided.

OS distribution. This means it is possible to switch your Fedora 26 Atomic Host
to a version of CentOS Atomic Host. While this is not likely to be done on a
production system, it can be useful in certain testing scenrios.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We should add a relative link here to the package layering doc. Maybe something like:

See the link:../using_ostree/ostree_mutations/package_layering.adoc[package layering section] for more information on package layering. 

?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea

@jlebon
Copy link
Collaborator

jlebon commented Aug 31, 2017

Minor nit, otherwise LGTM! 👍

Copy link
Contributor

@yuqi-zhang yuqi-zhang left a comment

Choose a reason for hiding this comment

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

Looks good so far.

The `rebase` command also allows you to switch your system to an entirely new
OS distribution. This means it is possible to switch your Fedora 26 Atomic Host
to a version of CentOS Atomic Host. While this is not likely to be done on a
production system, it can be useful in certain testing scenrios.
Copy link
Contributor

Choose a reason for hiding this comment

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

"scenrios"

@miabbott miabbott changed the title First shot at rpm-ostree command reference WIP: First shot at rpm-ostree command reference Aug 31, 2017
@miabbott
Copy link
Contributor Author

There are some additional commands that need to be fleshed out, so I labeled this as WIP

@miabbott miabbott changed the title WIP: First shot at rpm-ostree command reference First shot at rpm-ostree command reference Aug 31, 2017
@miabbott
Copy link
Contributor Author

I managed to fill out something for all the rpm-ostree subcommands. I think this is ready to be fully reviewed in its current form.

Removing WIP designation.

=== `rpm-ostree compose tree`


== Experimental interface
Copy link
Member

Choose a reason for hiding this comment

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

Let's drop this section; the ex livefs and ex override are going to be covered elsewhere. The other two are really experimental.

=== `rpm-ostree db version`


== Composing an ostree commit
Copy link
Member

Choose a reason for hiding this comment

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

This one is also going to live elsewhere, right?

@@ -0,0 +1,251 @@
[[rpm-ostree-command-ref]]
= {product-title} rpm-ostree Command Reference
Copy link
Member

Choose a reason for hiding this comment

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

This all seems fine to me...I am just uncertain about the big picture here versus the docs that live in rpm-ostree upstream.

Offhand...it feels like upstream should be more detailed, but this doc covers a high level? And we link to upstream?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jlebon and I were discussing ideas on how to have these docs co-exist, especially stuff like this that is in the category of 'command reference'. Mirroring the upstream docs here might be a solution.

I'm happy to keep this high-level and make changes to adjust; the original content was from upstream, so I was just massaging it a bit. If you think any changes here should be moved to the rpm-ostree repo (or readthedocs), just let me know.

@jberkus Any thoughts on the subject of command reference docs (like this) and where they should live?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I opened an issue to talk about this here: #95.

@jasonbrooks jasonbrooks merged commit c7fbe27 into projectatomic:master Mar 1, 2018
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

Successfully merging this pull request may close these issues.

5 participants