mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-21 22:53:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

generator: Allow actions to be deprecated with no replacement.

Browse Source 
There is precisely one such function at the moment
(guestfs_wait_ready).
This commit is contained in:
Richard W.M. Jones
2017-03-02 12:39:57 +00:00
parent df6cd83872
commit 67ce5342c2
11 changed files with 118 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
generator/docstrings.ml
View File

@@ -39,8 +39,9 @@ of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
let deprecation_notice ?(prefix = "") ?(replace_underscores = false) =
function
| { deprecated_by = None } -> None
| { deprecated_by = Some alt } ->
| { deprecated_by = Not_deprecated } -> None
| { deprecated_by = Replaced_by alt } ->
let alt =
if replace_underscores then String.replace_char alt '_' '-' else alt in
let txt =
@@ -52,6 +53,15 @@ fact that they are deprecated indicates that there are problems
with correct use of these functions." prefix alt in
Some txt
| { deprecated_by = Deprecated_no_replacement } ->
Some "I<This function is deprecated.>
There is no replacement. Consult the API documentation in
L<guestfs(3)> for further information.
Deprecated functions will not be removed from the API, but the
fact that they are deprecated indicates that there are problems
with correct use of these functions."
let version_added = function
| { added = (0, 0, release) } -> Some (sprintf "0.%d" release)
| { added = ((0|1) as major, minor, release) } ->