search for: is_documented

Generate proper deprecation markers for API documentation and introspection annotations. --- generator/gobject.ml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/generator/gobject.ml b/generator/gobject.ml index 5b07edd..e563610 100644 --- a/generator/gobject.ml +++ b/generator/gobject.ml @@ -961,7 +961,8 @@ guestfs_session_close (GuestfsSession *session, GError **err)

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

...improvements to the ocamldoc: > > - Generate more sub-headings. > > - Document the object-oriented API. > > - Use a common function to generate the doc for module and OO APIs. > --- Mostly OK, except ... > + 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 U...

...tor/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 ( + if need_doc then ( pr "(** %s" shortdesc; (match deprecated_by with | None -> () @@ -155,14 +160,18...

...there was no errno). Note that the returned integer is the @@ -149,41 +155,45 @@ module Errno : sig pr "\ end +(** {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 +...

...rg) (type_hint_of_optargt optarg)) + optargs ^ + ") -> " ^ ret_type_hint ^ ":" in pr "\n"; - pr " def %s(%s):\n" + pr " def %s(%s\n" f.name (indent_python decl_string (9 + len_name) 78); if is_documented f then ( -- 2.27.0.212.ge8ba1cc988-goog

...ns +let is_external = + fun x -> match x.visibility with + | VPublic | VStateTest | VBindTest | VDebug -> true + | VInternal -> false + +let is_internal = + fun x -> match x.visibility with + | VPublic | VStateTest | VBindTest | VDebug -> false + | VInternal -> true + +let is_documented = + fun x -> match x.visibility with + | VPublic | VStateTest -> true + | VBindTest | VDebug | VInternal -> false + +let is_fish = + fun x -> match x.visibility with + | VPublic | VDebug -> true + | VStateTest | VBindTest | VInternal -> false + let external_functions = - L...

...+ optargs ^ > + ") -> " ^ ret_type_hint ^ ":" in > pr "\n"; > - pr " def %s(%s):\n" > + pr " def %s(%s\n" > f.name (indent_python decl_string (9 + len_name) 78); > > if is_documented f then ( > -- > 2.27.0.212.ge8ba1cc988-goog > > _______________________________________________ > Libguestfs mailing list > Libguestfs@redhat.com > https://www.redhat.com/mailman/listinfo/libguestfs -- Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~r...

...k #%s} instead\n" alt + (* Don't link to an undocumented function as javadoc will + * give a hard error. + *) + let f_alt = try List.find (fun { name = n } -> n = alt) actions + with Not_found -> assert false in + if is_documented f_alt then + pr " * @deprecated In new code, use {@link #%s} instead\n" alt + else + pr " * @deprecated In new code, use method %s instead\n" alt | { deprecated_by = Deprecated_no_replacement } -> pr " * @deprecate...

By splitting up large C files we can make parallel compiles a bit faster. Rich.

...") -> " ^ ret_type_hint ^ ":" in > > pr "\n"; > > - pr " def %s(%s):\n" > > + pr " def %s(%s\n" > > f.name (indent_python decl_string (9 + len_name) 78); > > > > if is_documented f then ( > > -- > > 2.27.0.212.ge8ba1cc988-goog > > > > _______________________________________________ > > Libguestfs mailing list > > Libguestfs@redhat.com > > https://www.redhat.com/mailman/listinfo/libguestfs > > -- > Richard Jones, Virtualizat...

...x;\n" (String.uppercase name) bitmask; + pr " public static final long EVENT_%s = 0x%x;\n" + (String.uppercase_ascii name) bitmask; pr "\n"; ) events; @@ -259,7 +261,7 @@ public class GuestFS { let ret, args, optargs = f.style in if is_documented f then ( - let doc = replace_str f.longdesc "C<guestfs_" "C<g." in + let doc = String.replace f.longdesc "C<guestfs_" "C<g." in let doc = if optargs <> [] then doc ^ "\n\nOptional arguments...

This is only lightly tested at the moment. For context see: https://bugzilla.redhat.com/show_bug.cgi?id=1138203#c40 https://bugzilla.redhat.com/show_bug.cgi?id=1075143 https://bugzilla.redhat.com/show_bug.cgi?id=1075164 Note this is not a complete fix. At least one more libguestfs patch is required (to implement virDomainPtr in the python bindings). Plus a virt-manager patch. Rich.

This completes the implementation on the libguestfs side, allowing python-libvirt dom pointers to be passed to guestfs_add_libvirt_dom. For context see: https://bugzilla.redhat.com/show_bug.cgi?id=1138203#c40 https://bugzilla.redhat.com/show_bug.cgi?id=1075143 https://bugzilla.redhat.com/show_bug.cgi?id=1075164 Rich.

A hopefully cleaner implementation this time. It doesn't require any special insights into how libvirt-python is implemented. Instead, it requires a change to libvirt-python to add a .c_pointer() method: https://www.redhat.com/archives/libvir-list/2014-December/msg00615.html Rich.

Since v3: - Fix labelling over overlays (see 6/6) - Tested it with a test program which simulates what virt-manager will do. See the attachment here: https://bugzilla.redhat.com/show_bug.cgi?id=1075164#c7 Rich.

Hi, attached there is the second version of the patch series adding copy_in and copy_out in the library, mostly moving them from guestfish. It also adds the copy_in usage in virt-customize, as aid in a new image building. Thanks, Pino Toscano (7): cmd: add a way to run (and wait) asynchronously commands cmd: add a child-setup callback cmd: add the possibility to get a fd to the process

--- src/command.c | 64 +++++++++++++++++++++++++++++++++++++++++++------- src/guestfs-internal.h | 3 +++ 2 files changed, 58 insertions(+), 9 deletions(-) diff --git a/src/command.c b/src/command.c index 4bb469b..e26573d 100644 --- a/src/command.c +++ b/src/command.c @@ -360,7 +360,7 @@ debug_command (struct command *cmd) } static int -run_command (struct command *cmd)

Hi, this series cleans up the Python sources, either static or generated, including also tests, to make them PEP 8 compliant; see https://www.python.org/dev/peps/pep-0008/ and tools like pep8. Almost all the issues reported by pep8 are fixed, reducing the issues from 3818 to 7. The changes should have no effect on the actual code, while it will help Python users with consistency with other

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