-
Notifications
You must be signed in to change notification settings - Fork 195
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
Docs/compose server #2693
Docs/compose server #2693
Conversation
The container docs are nice to know but not the most important thing.
This section is meant to give a broad overview of this doc. First introducing the tool in general. Then showing the distinction between 'compose tree' and the granular approach. Finally transitioning over to the next section.
This section goes into more detail how compose tree can be split up using the other available commands.
Hi @w4tsn. Thanks for your PR. I'm waiting for a coreos member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for working on this! Just a few nits.
docs/compose-server.md
Outdated
Next we can run more postprocessing: | ||
|
||
``` | ||
# rpm-ostree compose postprocess postprocess /var/sysroot/rootfs /path/to/manifest.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# rpm-ostree compose postprocess postprocess /var/sysroot/rootfs /path/to/manifest.yaml | |
# rpm-ostree compose postprocess /var/sysroot/rootfs /path/to/manifest.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please note that this is stated ambiguously in the man pages:
rpm-ostree compose postprocess [OPTION…] postprocess ROOTFS [TREEFILE]
It is not clear what the second postprocess implies or what it stands for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch! Want to inline this? :)
diff --git a/src/app/rpmostree-compose-builtin-tree.cxx b/src/app/rpmostree-compose-builtin-tree.cxx
index 00da5c5e..5474f49e 100644
--- a/src/app/rpmostree-compose-builtin-tree.cxx
+++ b/src/app/rpmostree-compose-builtin-tree.cxx
@@ -1262,7 +1262,7 @@ rpmostree_compose_builtin_postprocess (int argc,
GCancellable *cancellable,
GError **error)
{
- g_autoptr(GOptionContext) context = g_option_context_new ("postprocess ROOTFS [TREEFILE]");
+ g_autoptr(GOptionContext) context = g_option_context_new ("ROOTFS [TREEFILE]");
if (!rpmostree_option_context_parse (context,
postprocess_option_entries,
&argc, &argv,
docs/compose-server.md
Outdated
When we are finished with our manual changes we can now create the commit: | ||
|
||
``` | ||
# rpm-ostree compose tree --repo=/srv/repo /path/to/manifest.yaml /var/sysroot |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# rpm-ostree compose commit --repo=/srv/repo /path/to/manifest.yaml /var/sysroot
docs/compose-server.md
Outdated
Once we have that commit, let's export it: | ||
|
||
``` | ||
# ostree --repo=repo pull-local build-repo exampleos/8/x86_64/stable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like we already passed --repo=/srv/repo
above and weren't using build-repo
right? Let's be consistent here.
In the sections "Granular.." and "Running rpm..." the usage of repo paths was inconsistent.
I've applied your suggestions. After a second look I noticed that this also applies to the section "Running rpm-ostree..." which I updated as well. I noticed another thing: in my personal usage I'm using |
/ok-to-test |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Will let @cgwalters have another look.
I've reworked some of the online documentation on docs/compose-server motivated from #2675.
Changes are: