mirrors/libguestfs
1
0
Fork 0
mirror of https://github.com/libguestfs/libguestfs.git synced 2026-03-22 07:03:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Typos and documentation updates.

Browse Source
This commit is contained in:
Richard Jones
2009-04-14 14:20:47 +01:00
parent 98a43eba2f
commit 5a563bbd9b
5 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
fish/cmds.c
View File

@@ -279,7 +279,7 @@ void display_command (const char *cmd)
pod2text ("file - determine file type", " file <path>\n\nThis call uses the standard L<file(1)> command to determine\nthe type or contents of the file. This also works on devices,\nfor example to find out whether a partition contains a filesystem.\n\nThe exact command which runs is C<file -bsL path>. Note in\nparticular that the filename is not prepended to the output\n(the C<-b> option).");
else
if (strcasecmp (cmd, "command") == 0)
pod2text ("command - run a command from the guest filesystem", " command <arguments>\n\nThis calls runs a command from the guest filesystem. The\nfilesystem must be mounted, and must contain a compatible\noperating system (ie. something Linux, with the same\nor compatible processor architecture).\n\nThe single parameter is an argv-style list of arguments.\nThe first element is the name of the program to run.\nSubsequent elements are parameters. The list must be\nnon-empty (ie. must contain a program name).\n\nThe C<$PATH> environment variable will contain at least\nC</usr/bin> and C</bin>. If you require a program from\nanother location, you should provide the full path in the\nfirst parameter.\n\nShared libraries and data files required by the program\nmust be available on filesystems which are mounted in the\ncorrect places. It is the caller's responsibility to ensure\nall filesystems that are needed are mounted at the right\nlocations.");
pod2text ("command - run a command from the guest filesystem", " command <arguments>\n\nThis call runs a command from the guest filesystem. The\nfilesystem must be mounted, and must contain a compatible\noperating system (ie. something Linux, with the same\nor compatible processor architecture).\n\nThe single parameter is an argv-style list of arguments.\nThe first element is the name of the program to run.\nSubsequent elements are parameters. The list must be\nnon-empty (ie. must contain a program name).\n\nThe C<$PATH> environment variable will contain at least\nC</usr/bin> and C</bin>. If you require a program from\nanother location, you should provide the full path in the\nfirst parameter.\n\nShared libraries and data files required by the program\nmust be available on filesystems which are mounted in the\ncorrect places. It is the caller's responsibility to ensure\nall filesystems that are needed are mounted at the right\nlocations.");
else
if (strcasecmp (cmd, "command_lines") == 0 || strcasecmp (cmd, "command-lines") == 0)
pod2text ("command-lines - run a command, returning lines", " command-lines <arguments>\n\nThis is the same as C<command>, but splits the\nresult into a list of lines.");

2
guestfish-actions.pod
View File

@@ -218,7 +218,7 @@ yourself (Augeas support makes this relatively easy).
command arguments,...
This calls runs a command from the guest filesystem. The
This call runs a command from the guest filesystem. The
filesystem must be mounted, and must contain a compatible
operating system (ie. something Linux, with the same
or compatible processor architecture).

14
guestfs-actions.pod
View File

@@ -84,7 +84,7 @@ On error this function returns -1.
Look up the value associated with C<path>. If C<path>
matches exactly one node, the C<value> is returned.
This function returns a string or NULL on error.
This function returns a string, or NULL on error.
I<The caller must free the returned string after use>.
=head2 guestfs_aug_init
@@ -250,7 +250,7 @@ Note that this function cannot correctly handle binary files
as end of string). For those you need to use the C<guestfs_read_file>
function which has a more complex interface.
This function returns a string or NULL on error.
This function returns a string, or NULL on error.
I<The caller must free the returned string after use>.
Because of the message protocol, there is a transfer limit
@@ -288,7 +288,7 @@ This function returns 0 on success or -1 on error.
char *guestfs_command (guestfs_h *handle,
char * const* const arguments);
This calls runs a command from the guest filesystem. The
This call runs a command from the guest filesystem. The
filesystem must be mounted, and must contain a compatible
operating system (ie. something Linux, with the same
or compatible processor architecture).
@@ -309,7 +309,7 @@ correct places. It is the caller's responsibility to ensure
all filesystems that are needed are mounted at the right
locations.
This function returns a string or NULL on error.
This function returns a string, or NULL on error.
I<The caller must free the returned string after use>.
=head2 guestfs_command_lines
@@ -366,7 +366,7 @@ The exact command which runs is C<file -bsL path>. Note in
particular that the filename is not prepended to the output
(the C<-b> option).
This function returns a string or NULL on error.
This function returns a string, or NULL on error.
I<The caller must free the returned string after use>.
=head2 guestfs_get_autosync
@@ -386,7 +386,7 @@ Return the current search path.
This is always non-NULL. If it wasn't set already, then this will
return the default path.
This function returns a string or NULL on error.
This function returns a string, or NULL on error.
The string is owned by the guest handle and must I<not> be freed.
=head2 guestfs_get_verbose
@@ -481,7 +481,7 @@ there is no cwd) in the format of 'ls -la'.
This command is mostly useful for interactive sessions. It
is I<not> intended that you try to parse the output string.
This function returns a string or NULL on error.
This function returns a string, or NULL on error.
I<The caller must free the returned string after use>.
=head2 guestfs_ls

2
perl/lib/Sys/Guestfs.pm
View File

@@ -273,7 +273,7 @@ yourself (Augeas support makes this relatively easy).
=item $output = $h->command (\@arguments);
This calls runs a command from the guest filesystem. The
This call runs a command from the guest filesystem. The
filesystem must be mounted, and must contain a compatible
operating system (ie. something Linux, with the same
or compatible processor architecture).

6
src/generator.ml
View File

@@ -973,7 +973,7 @@ particular that the filename is not prepended to the output
[], (* XXX how to test? *)
"run a command from the guest filesystem",
"\
This calls runs a command from the guest filesystem. The
This call runs a command from the guest filesystem. The
filesystem must be mounted, and must contain a compatible
operating system (ie. something Linux, with the same
or compatible processor architecture).
@@ -1335,10 +1335,10 @@ let rec generate_actions_pod () =
| RBool _ ->
pr "This function returns a C truth value on success or -1 on error.\n\n"
| RConstString _ ->
pr "This function returns a string or NULL on error.
pr "This function returns a string, or NULL on error.
The string is owned by the guest handle and must I<not> be freed.\n\n"
| RString _ ->
pr "This function returns a string or NULL on error.
pr "This function returns a string, or NULL on error.
I<The caller must free the returned string after use>.\n\n"
| RStringList _ ->
pr "This function returns a NULL-terminated array of strings