Hostinfo day 4: Implement command processing code.

[virt-hostinfo.git] / hostinfod / hostinfo.pod

diff --git a/hostinfod/hostinfo.pod b/hostinfod/hostinfo.pod
index 0f700eb..9bebced 100644 (file)
--- a/hostinfod/hostinfo.pod
+++ b/hostinfod/hostinfo.pod
@@ -31,19 +31,21 @@ The system administrator (of the host) must:
 
 =item *
 
-explicitly enable the hostinfo feature,
+explicitly enable the hostinfo feature (see below),
 
 =item *
 
-select which virtual machines can see any data,
+select which virtual machines can see any data (see L<hostinfo-set(8)>),
 
 =item *
 
-select which data they wish to disclose to virtual machines, and
+select which data they wish to disclose to virtual machines
+(C<guests.conf> below), and
 
 =item *
 
-select the frequency that virtual machines can ask for data.
+select the frequency that virtual machines can ask for data
+(C<guests.conf>).
 
 =back
 
@@ -205,7 +207,7 @@ controlling the security of the hostinfo system.
 Edits to this file take effect as soon as the next request is received
 from any guest.  You do not need to restart the daemon.
 
-B<However if this file contains any mistakes, then the daemon will
+However B<if this file contains any mistakes, then the daemon will
 exit> (ie. the default becomes no access).  The reason for the error
 will be sent to a system log file.  So after editing this file, you
 should check that hostinfo is available end-to-end (ie. from a guest),
@@ -264,7 +266,9 @@ available to it, every N seconds, which means in total there could up
 to M requests every N seconds per guest.
 
 If a guest exceeds the rate at which it is allowed to make requests,
-then the daemon sleeps before replying (just for that guest).
+then the daemon will after some number of violations stop talking to
+the guest.  The only way to restore service to the guest will be to
+reboot the guest or restart the daemon.
 
 Setting this to C<any> means there is no limit.  Guests can flood the
 host with requests.
@@ -380,29 +384,29 @@ Use the L<hostinfo-test(8)> program in the guest to test this.
 
 =back
 
+Note that serial port settings like speed, parity etc. make no
+difference for these emulated serial ports, so that won't be a factor.
+
 =head1 FILES
 
 =over 4
 
 =item /etc/hostinfo/hostinfo.conf
 
-
 =item /etc/hostinfo/guests.conf
 
-
 =item /var/lib/hostinfo/
 
-
-
 =back
 
 =head1 SEE ALSO
 
 L<hostinfo-set(8)>,
 L<hostinfo-status(8)>,
-L<hostinfo-test(8)>,
+L<hostinfo-test(1)>,
 L<virt-install(1)>,
 L<virt-manager(1)>,
+L<hostinfo-protocol(5)>,
 L<http://fedoraproject.org/wiki/Features/Hostinfo>,
 L<http://libvirt.org/>.