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

docs: Fix function names in deprecation notices.

Browse Source 
(cherry picked from commit 60adf092a8)
This commit is contained in:
Richard W.M. Jones
2011-08-06 15:57:21 +01:00
parent a41040be6f
commit 340a13f991
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
generator/generator_c.ml
View File

@@ -255,7 +255,7 @@ I<The caller must free the returned buffer after use>.\n\n"
pr "This function takes a key or passphrase parameter which
could contain sensitive material. Read the section
L</KEYS AND PASSPHRASES> for more information.\n\n";
(match deprecation_notice flags with
(match deprecation_notice ~prefix:"guestfs_" flags with
| None -> ()
| Some txt -> pr "%s\n\n" txt
);

6
generator/generator_docstrings.ml
View File

@@ -40,17 +40,17 @@ let danger_will_robinson =
"B<This command is dangerous. Without careful use you
can easily destroy all your data>."
let deprecation_notice flags =
let deprecation_notice ?(prefix = "") flags =
try
let alt =
find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
let txt =
sprintf "This function is deprecated.
In new code, use the C<%s> call instead.
In new code, use the L</%s%s> call instead.
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." alt in
with correct use of these functions." prefix alt in
Some txt
with
Not_found -> None