search for: longdesc

As contrast to shortdesc which is forced to begin with lowercase, this patch forces longdesc to begin with uppercase. Signed-off-by: Hu Tao <hutao@cn.fujitsu.com> --- generator/checks.ml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/generator/checks.ml b/generator/checks.ml index b57134b..376de3b 100644 --- a/generator/checks.ml +++ b/generator/checks.ml @@...

Split up the huge generator/actions.ml into several smaller files. Rich.

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

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

- refactor memoization code - pass pod as stdin rather than files Pino Toscano (3): generator: isolate memoized cache in own module generator: adjust variable names generator: improve pod2text invocation generator/Makefile.am | 3 ++ generator/memoized_cache.ml | 62 +++++++++++++++++++++ generator/memoized_cache.mli | 29 ++++++++++ generator/utils.ml | 101

This works. I'm in the middle of testing whether there is any noticable benefit. Rich.

...let params = args @ List.map (fun (n, def) -> n ^ "=" ^ def) optargs in - let params = List.map ((^) ", ") params in - let params = String.concat "" params in - pr " def %s (self%s):\n" name params in - let () = - let longdesc = Str.global_replace py_fn_rex "C<nbd." longdesc in - let longdesc = Str.global_replace py_const_rex "C<" longdesc in - let longdesc = pod2text longdesc in - pr " '''▶ %s\n\n%s'''\n" - shortdesc (Strin...

...f --git a/generator/actions.ml b/generator/actions.ml index a97b867..8d31317 100644 --- a/generator/actions.ml +++ b/generator/actions.ml @@ -27,8 +27,8 @@ open Utils let defaults = { name = ""; 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; +...

...ch, so ACK. I do wonder if we should make the notify parameter mandatory (and therefore avoid the duplicate functions). Another trick you might do if feeling really keen is to programmatically generate the notify variants of commands, something like this: let make_notify_variant_of_call ({ args; longdesc } as call) = let args = List.rev args in let flags, args = List.hd args, List.tl args in assert (flags = Flags "flags"); let args = flags :: CallbackPersist ("notify", [ etc ]) :: args in let args = List.rev args in let longdesc = longdesc ^ "\nThe C<notify&g...

This doesn't yet work. However it does make me more convinced than ever that we really need to sort out persistent buffer lifetimes in the library (similar to what we did for closures). Rich.

...s = [ BytesOut ("buf", "count"); UInt64 "offset"; UInt32 "flags" ]; + args = [ BytesOut ("buf", "count"); UInt64 "offset"; Flags "flags" ]; ret = RErr; shortdesc = "read from the NBD server"; longdesc = "\ @@ -1241,7 +1242,7 @@ protocol extensions)."; "pwrite", { default_call with - args = [ BytesIn ("buf", "count"); UInt64 "offset"; UInt32 "flags" ]; + args = [ BytesIn ("buf", "count"); UInt64 "...

...me = "wait_ready"; added = (0, 0, 3); style = RErr, [], []; visibility = VStateTest; - deprecated_by = Some "launch"; + deprecated_by = Deprecated_no_replacement; blocking = false; shortdesc = "wait until the hypervisor launches (no op)"; longdesc = "\ @@ -46,7 +46,7 @@ versions of the API." }; { defaults with name = "kill_subprocess"; added = (0, 0, 3); style = RErr, [], []; - deprecated_by = Some "shutdown"; + deprecated_by = Replaced_by "shutdown"; shortdesc = "kill the...

...already exist. --- generator/rust.ml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/generator/rust.ml b/generator/rust.ml index 1f5cefa62..3a07c3b53 100644 --- a/generator/rust.ml +++ b/generator/rust.ml @@ -52,6 +52,14 @@ let translate_bad_symbols s = else s +(* output longdesc to the rust file *) +let pr_longdesc name longdesc indent_depth = + let l = pod2text name longdesc in + List.iter (fun x -> + indent indent_depth; + pr "/// %s\n" x; + ) l + let generate_rust () = generate_header ~copyrights CStyle LGPLv2plus; @@ -398,6 +406,8 @@ e...

...r"; added = (0, 0, 7); - style = RInt "nrnodes", [String "name"; OptString "expr"], []; + style = RInt "nrnodes", [String (PlainString, "name"); OptString "expr"], []; shortdesc = "define an Augeas variable"; longdesc = "\ Defines an Augeas variable C<name> whose value is the result @@ -111,7 +111,7 @@ C<0> if C<expr> evaluates to something which is not a nodeset." }; { defaults with name = "aug_defnode"; added = (0, 0, 7); - style = RStruct ("nrnodescreat...

Very large but mechanical change to the generator. Rich.

...uot;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 is the same as the L<stat(2)> system call." }; - - { defaults with - name = "lstat"; added = (1, 9, 2); - style = RStruct ("statbuf", "stat"), [Pathname "path"], []; -...

This applies on top of patches 1 & 2 here (instead of patch 3): https://www.redhat.com/archives/libguestfs/2019-May/msg00206.html https://www.redhat.com/archives/libguestfs/2019-May/msg00207.html Rich.

> Can you explain which errors did you get? I tried pod2markdown on a > couple of API longdesc's, and the result seemed OK. > Most probably we will need to write our own pod2markdown though, as > pod2markdown does not allow users to customize all the options that > the Pod::Markdown module has. Yes. Most of the results seemed OK. But, for example, translating 'docs/guestfs-...

Hi, This series adds new APIs to support btrfs scrub, balance, rescue and inspect. Some of them don't have tests because: - btrfs_scrub and btrfs_balance completes too early before we can test btrfs_scrub_cancel, btrfs_scrub_resume, btrfs_scrub_status, btrfs_balance_pause, btrfs_balance_cancel, btrfs_balance_resume and btrfs_balance_status. - can't

...t; C<expr>, C<val>. C<name> will be the nodeset containing that single node. On success this returns a pair containing the @@ -146,7 +146,7 @@ matches exactly one node, the C<value> is returned." }; ]; shortdesc = "set Augeas path to value"; longdesc = "\ -Set the value associated with C<path> to C<val>. +Set the value associated with C<augpath> to C<val>. In the Augeas API, it is possible to clear a node by setting the value to NULL. Due to an oversight in the libguestfs API diff --git a/generator/actions_core...