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.

diff --git a/src/libostree/ostree-sysroot-deploy.c b/src/libostree/ostree-sysroot-deploy.c
index c4a0ca923426f63d203f1f2f63a9fd6723fea196..8488111dcf0078761e67ec9f03f4a9fdde205941 100644 (file)
--- 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,