From ef6f877b9df261fad1fbf361b8ce7af1055dfbb7 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Tue, 17 May 2011 20:57:56 +0100 Subject: [PATCH] Document that guestfs_file output depends on file(1) command. And therefore practically it cannot be part of the ABI since the output of file(1) itself changes from time to time. --- generator/generator_actions.ml | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/generator/generator_actions.ml b/generator/generator_actions.ml index 9c5aefd..44f47df 100644 --- a/generator/generator_actions.ml +++ b/generator/generator_actions.ml @@ -2268,15 +2268,12 @@ The exact command which runs is C. Note in particular that the filename is not prepended to the output (the I<-b> option). -This command can also be used on C devices -(and partitions, LV names). You can for example use this -to determine if a device contains a filesystem, although -it's usually better to use C. - -If the C does not begin with C then -this command only works for the content of regular files. -For other file types (directory, symbolic link etc) it -will just return the string C etc."); +The output depends on the output of the underlying L +command and it can change in future in ways beyond our control. +In other words, the output is not guaranteed by the ABI. + +See also: L, C, C, +C, C (etc)."); ("command", (RString "output", [StringList "arguments"], []), 50, [ProtocolLimitWarning], [InitScratchFS, Always, TestOutput ( -- 1.8.3.1