diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2011-08-06 15:57:21 +0100 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2011-08-07 22:04:53 +0100 |
| commit | 1541c3381a512076b9d89db2df5175640ba0ee8f (patch) | |
| tree | 67e441a25188f8213e29049befd519ef6fc8dc88 | |
| parent | c039ce86da94275ffe35f23a87f62586e7b23f49 (diff) | |
| download | libguestfs-1541c3381a512076b9d89db2df5175640ba0ee8f.tar.gz libguestfs-1541c3381a512076b9d89db2df5175640ba0ee8f.tar.xz libguestfs-1541c3381a512076b9d89db2df5175640ba0ee8f.zip | |
docs: Fix function names in deprecation notices.
(cherry picked from commit 60adf092a8900323c048c94f3f0934be416a3eb6)
| -rw-r--r-- | generator/generator_c.ml | 2 | ||||
| -rw-r--r-- | generator/generator_docstrings.ml | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/generator/generator_c.ml b/generator/generator_c.ml index 64ddf9b7..8e43ea4b 100644 --- a/generator/generator_c.ml +++ b/generator/generator_c.ml @@ -253,7 +253,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 ); diff --git a/generator/generator_docstrings.ml b/generator/generator_docstrings.ml index 44f92c05..173ca8e1 100644 --- a/generator/generator_docstrings.ml +++ b/generator/generator_docstrings.ml @@ -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 |