similar to: [PATCH] doc: add info on per-function needed feature

There is precisely one such function at the moment (guestfs_wait_ready). --- generator/GObject.ml | 6 +- generator/OCaml.ml | 7 +- generator/actions_core_deprecated.ml | 102 ++++++++++++++--------------- generator/actions_inspection_deprecated.ml | 2 +- generator/actions_properties_deprecated.ml | 12 ++-- generator/c.ml

- fix the syntax of hyperlinks - replace the deprecation text with a simplier named list item, so it's more visible - use a named list item for the pointer to the C documentation of each API - add a named list item for the version of each API --- generator/ruby.ml | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/generator/ruby.ml

The visibility field in action replaces in_fish, in_docs and internal. The defined types are: VPublic: A public API. This is exported and documented in all language bindings, and in guestfish. VStateTest: A public API which queries the library state machine. It is exported and documented in all language bindings, but not guestfish. VBindTest: An internal API used only for testing

Miscellaneous 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. --- generator/ocaml.ml | 84 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 49 insertions(+), 35 deletions(-) diff --git a/generator/ocaml.ml b/generator/ocaml.ml index 465df3c..2be3b7e

Fixes commit 97773d2bbee8e28830fd689deef9e9f63ce0c18e. --- generator/actions_core.ml | 83 ------------------------------------ generator/actions_core_deprecated.ml | 83 ++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 83 deletions(-) diff --git a/generator/actions_core.ml b/generator/actions_core.ml index e662827..ed89f74 100644 --- a/generator/actions_core.ml

On Friday, 3 March 2017 11:18:26 CET Richard W.M. Jones wrote: > There is precisely one such function at the moment > (guestfs_wait_ready). > --- Mostly LGTM, few notes below. > 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

Previously we had lots of types like String, Device, StringList, DeviceList, etc. where Device was just a String with magical properties (but only inside the daemon), and DeviceList was just a list of Device strings. Replace these with some simple top-level types: String StringList and move the magic into a subtype. The change is mechanical, for example: old

On Wednesday 30 September 2015 10:19:10 Richard W.M. Jones wrote: > Miscellaneous 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

--- generator/java.ml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/generator/java.ml b/generator/java.ml index 573f1c2..4c89197 100644 --- a/generator/java.ml +++ b/generator/java.ml @@ -273,6 +273,10 @@ public class GuestFS { pr " * </p><p>\n"; pr " * %s\n" doc; pr " * </p>\n"; + (match

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 @@

Certain functions are intended to be internal only, but we currently export them anyway. This change moves them into a separate section of guestfs.h protected by a GUESTFS_PRIVATE variable. This change also enables private structs, but doesn't implement any. This change only affects the C api. Language bindings aren't affected, but probably should be in the future. --- align/Makefile.am

Be explicit about what is exported from each module in the generator. --- generator/Makefile.am | 26 +++++++++++++++++++++++++- generator/bindtests.mli | 30 ++++++++++++++++++++++++++++++ generator/c.mli | 41 +++++++++++++++++++++++++++++++++++++++++ generator/checks.mli | 18 ++++++++++++++++++ generator/csharp.mli | 19 +++++++++++++++++++ generator/customize.mli

For a very long time we have maintained two sets of utility functions, in mllib/common_utils.ml and generator/utils.ml. This changes things so that the same set of utility functions can be shared with both directories. It's not possible to use common_utils.ml directly in the generator because it provides several functions that use modules outside the OCaml stdlib. Therefore we add some

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

--- 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 ->

Use interfaces files (*.mli files) instead of exporting all symbols randomly. Change the 'file is generated' warnings at the top of generated files so they accurately describe which source file generates each output file. Rich.

Use resize.f2fs (via f2fs_expand) to expand f2fs filesystems, if available. --- resize/resize.ml | 12 ++++++++++-- resize/virt-resize.pod | 10 ++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/resize/resize.ml b/resize/resize.ml index 1a21e4dff..8e4bb1b16 100644 --- a/resize/resize.ml +++ b/resize/resize.ml @@ -136,7 +136,7 @@ let debug_logvol lv = type

Add an optional argument for --machine-readable to select the output, adding a new function to specifically write data to that output stream. The possible choices are: * --machine-readable: to stdout, like before * --machine-readable=file:name-of-file: to the specified file * --machine-readable=stream:stdout: explicitly to stdout * --machine-readable=stream:stderr: explicitly to stderr Adapt all

This rather complex set of patches allow non-optargs functions to gain optional arguments, while preserving source and binary backwards compatibility. The problem is that we cannot add an optional argument to an existing function. For example, we might want to add flags to the 'lvresize' API which currently has no optional arguments.

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)