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.
This commit is contained in:
Jonathan Lebon 2020-08-17 09:48:15 -04:00
parent 5de3a9759f
commit 10a68cd26b
1 changed files with 2 additions and 2 deletions

View File

@ -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,