search for: version_added

...e>.\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"; - let version = api_version f.added in - pr "(Added in %s)\n\n" version; + (match version_added f with + | Some version -> pr "(Added in %s)\n\n" version + | None -> assert false + ); (* Handling of optional argument variants. *) if optargs <> [] then ( @@ -322,8 +324,8 @@ L</KEYS AND PASSPHRASES> for more information.\n\n"; pr "See L</...

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

...l take care of updating the year. --- generator/docstrings.ml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/generator/docstrings.ml b/generator/docstrings.ml index fa7b1668a..b480d036e 100644 --- a/generator/docstrings.ml +++ b/generator/docstrings.ml @@ -68,9 +68,7 @@ let version_added = function Some (sprintf "%d.%d.%d" major minor release) | _ -> None -let copyright_years = - let this_year = 1900 + (localtime (time ())).tm_year in - if this_year > 2009 then sprintf "2009-%04d" this_year else "2009" +let copyright_years = "200...

...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; > + pr "\n\n @since %s" version > + ); > + if !has_tags then > + pr "\n"; > + pr "%s *)\n" indent; > + ) Unfo...

...t 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; + pr "\n\n @since %s" version + ); + if !has_tags then + pr "\n"; + pr "%s *)\n" indent; + ) + in + (* The actions. *) List.iter ( -...

...material. Read the section L</KEYS AND PASSPHRASES> for more information.\n\n"; + (match f.optional with + | None -> () + | Some opt -> + pr "This function depends on the feature C<%s>. See also +L</guestfs_feature_available>.\n\n" opt + ); (match version_added f with | Some version -> pr "(Added in %s)\n\n" version | None -> assert false diff --git a/generator/fish.ml b/generator/fish.ml index 0cbc781..864f65d 100644 --- a/generator/fish.ml +++ b/generator/fish.ml @@ -897,9 +897,17 @@ Guestfish will prompt for these separately.\n\n&...

...match deprecation_notice f with - | None -> doc - | Some txt -> doc ^ "\n\n" ^ txt in let doc = pod2text ~width:60 f.name doc in let doc = String.concat "\n * " 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...

...| 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" ); (match version_added f with | None -> () diff --git a/generator/OCaml.ml b/generator/OCaml.ml index 083e505..38b254d 100644 --- a/generator/OCaml.ml +++ b/generator/OCaml.ml @@ -186,10 +186,13 @@ end opt ); (match f.deprecated_by with - | None -> () - | Some replaceme...

...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 version_added f with + | None -> () + | Some version -> pr " * @since %s\n" version + ); (match f with | { deprecated_by = None } -> () | { deprecated_by = Some alt } -> -- 2.1.0

...gt; generator/docstrings.ml | 4 +--- > 1 file changed, 1 insertion(+), 3 deletions(-) > > diff --git a/generator/docstrings.ml b/generator/docstrings.ml > index fa7b1668a..b480d036e 100644 > --- a/generator/docstrings.ml > +++ b/generator/docstrings.ml > @@ -68,9 +68,7 @@ let version_added = function > Some (sprintf "%d.%d.%d" major minor release) > | _ -> None > > -let copyright_years = > - let this_year = 1900 + (localtime (time ())).tm_year in > - if this_year > 2009 then sprintf "2009-%04d" this_year else "2009" >...

...pr " * Deprecated: In new code, use guestfs_session_%s() instead\n" alt > + | Deprecated_no_replacement -> > + pr " * Deprecated\n" The "Deprecated" tag needs a text, so I'd just note to not use it anymore. > ); > (match version_added f with > | None -> () > diff --git a/generator/OCaml.ml b/generator/OCaml.ml > index 083e505..38b254d 100644 > --- a/generator/OCaml.ml > +++ b/generator/OCaml.ml > @@ -186,10 +186,13 @@ end > opt > ); > (match f.deprecated_by with &gt...

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.

...| OCamlStyle | HaskellStyle + | ErlangStyle | LuaStyle | PODStyle +type license = GPLv2plus | LGPLv2plus + +val progress_message : string + +val protocol_limit_warning : string + +val deprecation_notice : ?prefix:string -> ?replace_underscores:bool -> Types.action -> string option + +val version_added : Types.action -> string option + +val copyright_years : string + +val generate_header : ?extra_inputs:string list -> ?emacs_mode:string -> comment_style -> license -> unit diff --git a/generator/erlang.mli b/generator/erlang.mli new file mode 100644 index 0000000..9d78ef5 --- /dev/n...

...quot; c copyright_years x; + ) copywrites; pr "%s\n" c; (match license with | GPLv2plus -> diff --git a/generator/docstrings.mli b/generator/docstrings.mli index 18d1ae255..e8c13d6ea 100644 --- a/generator/docstrings.mli +++ b/generator/docstrings.mli @@ -31,4 +31,4 @@ val version_added : Types.action -> string option val copyright_years : string -val generate_header : ?inputs:string list -> ?emacs_mode:string -> comment_style -> license -> unit +val generate_header : ?copywrites:string list -> ?inputs:string list -> ?emacs_mode:string -> comment_style -...

...s." @@ -138,7 +139,7 @@ and generate_ruby_c actions () = else doc in let doc = pod2text ~width:60 f.name doc in let doc = String.concat "\n * " doc in - let doc = trim doc in + let doc = String.trim doc in let doc = match version_added f with | None -> doc @@ -157,7 +158,7 @@ and generate_ruby_c actions () = (* Because Ruby documentation appears as C comments, we must * replace any instance of "/*". *) - let doc = replace_str doc "/*" "/ *" in +...

Hi Hiroyuki, sorry for the late reply. Most of the work is definitely nice! There are few notes below, although they are not big issues. I will check this patch once more on monday, especially the rust parts. Otherwise, I'd say that we are close to merging this :) On Tuesday, 23 July 2019 10:37:17 CEST Hiroyuki Katsura wrote: > From: Hiroyuki_Katsura