search for: deprecated_by

...ns(+), 85 deletions(-) diff --git a/generator/GObject.ml b/generator/GObject.ml index eada33c..fd2c07c 100644 --- a/generator/GObject.ml +++ b/generator/GObject.ml @@ -1118,9 +1118,11 @@ guestfs_session_close (GuestfsSession *session, GError **err) ); pr "\n"; (match deprecated_by with - | None -> () - | Some alt -> + | Not_deprecated -> () + | Replaced_by alt -> pr " * Deprecated: In new code, use guestfs_session_%s() instead\n" alt + | Deprecated_no_replacement -> + pr " * Deprecated\n" );...

...a/generator/GObject.ml b/generator/GObject.ml > index eada33c..fd2c07c 100644 > --- a/generator/GObject.ml > +++ b/generator/GObject.ml > @@ -1118,9 +1118,11 @@ guestfs_session_close (GuestfsSession *session, GError **err) > ); > pr "\n"; > (match deprecated_by with > - | None -> () > - | Some alt -> > + | Not_deprecated -> () > + | Replaced_by alt -> > pr " * Deprecated: In new code, use guestfs_session_%s() instead\n" alt > + | Deprecated_no_replacement -> > + pr &quo...

...name = name; style = (ret, args, optargs as style); cancellable = cancellable; c_function = c_function; c_optarg_prefix = c_optarg_prefix; - shortdesc = shortdesc; longdesc = longdesc } as f) -> + shortdesc = shortdesc; longdesc = longdesc; + deprecated_by = deprecated_by } as f) -> pr "\n"; let longdesc = Str.global_substitute urls ( @@ -1103,6 +1104,11 @@ guestfs_session_close (GuestfsSession *session, GError **err) pr "(transfer full) (array zero-terminated=1) (element-type Guestfs%s): an array of %s obj...

...at this call does not add the new disk to the handle. You may need to call C<guestfs_add_drive_opts> separately." }; { defaults with - name = "stat"; added = (1, 9, 2); - style = RStruct ("statbuf", "stat"), [Pathname "path"], []; - deprecated_by = Some "statns"; - tests = [ - InitISOFS, Always, TestResult ( - [["stat"; "/empty"]], "ret->size == 0"), [] - ]; - shortdesc = "get file information"; - longdesc = "\ -Returns file information for the given C<path...

This way the version string of each API can be used also in other generator modules. Mostly code motion, no actual behaviour changes. --- generator/c.ml | 21 ++++++++++----------- generator/docstrings.ml | 6 ++++++ 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/generator/c.ml b/generator/c.ml index 63dc09a..a2b9c94 100644 --- a/generator/c.ml +++ b/generator/c.ml @@

Using 'ocamlfind ocamldoc' is much faster than running 'ocamldoc' directly, because ocamlfind will run the native code program 'ocamldoc.opt' if it is available. This change approximately halves the time taken to compile the ocaml bindings. --- ocaml/Makefile.am | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ocaml/Makefile.am b/ocaml/Makefile.am index

...{3 Structs} *) + "; generate_ocaml_structure_decls (); + pr "\ + +(** {3 Actions} *) + +"; + + let generate_doc ?(indent = "") f = + if is_documented f then ( + let has_tags = ref false in + + pr "%s(** %s" indent f.shortdesc; + (match f.deprecated_by with + | None -> () + | Some replacement -> + has_tags := true; + pr "\n\n @deprecated Use {!%s} instead" replacement + ); + (match version_added f with + | None -> () + | Some version -> + has_tags := true; +...

--- generator/utils.ml | 8 +++++++- generator/utils.mli | 3 +++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/generator/utils.ml b/generator/utils.ml index b24ba8c..3a62084 100644 --- a/generator/utils.ml +++ b/generator/utils.ml @@ -360,4 +360,10 @@ let args_of_optargs optargs = | OInt64 n -> Int64 n | OString n -> String n | OStringList n ->

--- generator/ocaml.ml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/generator/ocaml.ml b/generator/ocaml.ml index f8707ae..9284005 100644 --- a/generator/ocaml.ml +++ b/generator/ocaml.ml @@ -144,9 +144,14 @@ end fun ({ name = name; style = style; deprecated_by = deprecated_by; non_c_aliases = non_c_aliases; shortdesc = shortdesc } as f) -> + let need_doc = is_documented f in + + if not need_doc then + pr "(**/**)\n"; + generate_ocaml_prototype name style; - if is_documented f then ( +...

...t. --- generator/java.ml | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/generator/java.ml b/generator/java.ml index 83f2e65..732cbe6 100644 --- a/generator/java.ml +++ b/generator/java.ml @@ -299,7 +299,15 @@ public class GuestFS { (match f with | { deprecated_by = Not_deprecated } -> () | { deprecated_by = Replaced_by alt } -> - pr " * @deprecated In new code, use {@link #%s} instead\n" alt + (* Don't link to an undocumented function as javadoc will + * give a hard error. + *) +...

This is a follow-up to the other generator changes in: https://www.redhat.com/archives/libguestfs/2017-February/msg00217.html Rich.

...* " doc in let doc = trim doc in + let doc = + match version_added f with + | None -> doc + | Some version -> doc ^ (sprintf "\n *\n * [Since] Added in version %s." version) in + let doc = + match f with + | { deprecated_by = None } -> doc + | { deprecated_by = Some alt } -> + doc ^ (sprintf "\n *\n * [Deprecated] In new code, use rdoc-ref:%s instead." alt) in (* Because Ruby documentation appears as C comments, we must * replace any instance of "/*"....

...-- a/generator/actions.ml +++ b/generator/actions.ml @@ -645,6 +645,7 @@ Use C<guestfs_available> or C<guestfs_feature_available> instead." }; style = RErr, [Bool "selinux"], []; fish_alias = ["selinux"]; config_only = true; blocking = false; + deprecated_by = None; shortdesc = "set SELinux enabled or disabled at appliance boot"; longdesc = "\ This sets the selinux flag that is passed to the appliance @@ -660,6 +661,7 @@ see L<guestfs(3)>." }; name = "get_selinux"; added = (1, 0, 67); style = RBo...

...-- a/generator/actions.ml +++ b/generator/actions.ml @@ -645,6 +645,7 @@ Use C<guestfs_available> or C<guestfs_feature_available> instead." }; style = RErr, [Bool "selinux"], []; fish_alias = ["selinux"]; config_only = true; blocking = false; + deprecated_by = Some "setfiles"; shortdesc = "set SELinux enabled or disabled at appliance boot"; longdesc = "\ This sets the selinux flag that is passed to the appliance @@ -660,6 +661,7 @@ see L<guestfs(3)>." }; name = "get_selinux"; added = (1, 0,...

...{!%s}" indent f.name; + (match f.optional with + | None -> () + | Some opt -> + has_tags := true; + pr "\n\n This function depends on the feature \"%s\". See also {!feature_available}." + opt + ); (match f.deprecated_by with | None -> () | Some replacement -> diff --git a/generator/perl.ml b/generator/perl.ml index f11477b..19cabb6 100644 --- a/generator/perl.ml +++ b/generator/perl.ml @@ -895,6 +895,12 @@ errnos: pr "%s\n\n" longdesc; if f.protocol_limit_warning then...

If we want to permit more than 255 drives to be added, then we will have to add the disks to the same virtio-scsi target using different unit (LUN) numbers. Unfortunately SCSI LUN enumeration in the Linux is not deterministic (eg. two disks with target=0, lun=[0,1] can be enumerated as /dev/sda or /dev/sdb randomly). Dealing with that will require some very complex device name translation on the

...recated.ml @@ -55,7 +55,7 @@ Do not call this. See: C<guestfs_shutdown> instead." }; { defaults with name = "add_cdrom"; added = (0, 0, 3); - style = RErr, [String "filename"], []; + style = RErr, [String (PlainString, "filename")], []; deprecated_by = Replaced_by "add_drive_ro"; config_only = true; blocking = false; shortdesc = "add a CD-ROM disk image to examine"; @@ -67,7 +67,7 @@ of C<guestfs_add_drive_ro>." }; { defaults with name = "add_drive_with_if"; added = (1, 0, 84); - s...

Patch to fix: https://bugzilla.redhat.com/show_bug.cgi?id=1262983 Note this won't help until the first two patches get backported to the stable branches, since <guestfs.h> won't define the necessary GUESTFS_HAVE_* macros. Rich.

Very large but mechanical change to the generator. Rich.

..."; style = RErr, [], []; proc_nr = None; tests = []; shortdesc = ""; longdesc = ""; protocol_limit_warning = false; fish_alias = []; - fish_output = None; in_fish = true; in_docs = true; - internal = false; deprecated_by = None; optional = None; + fish_output = None; visibility = VPublic; + deprecated_by = None; optional = None; progress = false; camel_name = ""; cancellable = false; config_only = false; once_had_no_opta...