From 10a68cd26b82489898d81cb5c6e5121e0de31222 Mon Sep 17 00:00:00 2001 From: Jonathan Lebon Date: Mon, 17 Aug 2020 09:48:15 -0400 Subject: [PATCH] lib/deploy: Clarify comment re. staging API Don't mention deprecation in the description for `ostree_sysroot_deploy_tree` since there are legitimate use cases for it (e.g. to create the first deployment via `ostree admin deploy`). Instead, make the comment clearly redirect to the staging API when booted into the sysroot. --- src/libostree/ostree-sysroot-deploy.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/libostree/ostree-sysroot-deploy.c b/src/libostree/ostree-sysroot-deploy.c index c4a0ca92..8488111d 100644 --- a/src/libostree/ostree-sysroot-deploy.c +++ b/src/libostree/ostree-sysroot-deploy.c @@ -2856,8 +2856,8 @@ sysroot_finalize_deployment (OstreeSysroot *self, * Check out deployment tree with revision @revision, performing a 3 * way merge with @provided_merge_deployment for configuration. * - * While this API is not deprecated, you most likely want to use the - * ostree_sysroot_stage_tree() API. + * When booted into the sysroot, you should use the + * ostree_sysroot_stage_tree() API instead. */ gboolean ostree_sysroot_deploy_tree (OstreeSysroot *self,