Commits

Kaspar Schiess committed 1232df9

More documentation

Now keeps the README as README.md (damn you file extensions) - this just
looks nicer on bitbucket. I succumb to user friendliness.

Comments (0)

Files changed (6)

README

-# qemu-toolkit(7) -- A toolkit for running qemu on Illumos / OmniOS
-
-## SYNOPSIS
-
-qemu-toolkit is a small set of scripts to control QEMU kvm virtualised
-machines on a set of illumos hosts. Have a look at 'storadm' and 
-'vmadm' - inline help will show you the possibilities.
-
-## INSTALLATION
-
-qemu-toolkit is a Ruby gem. This means you can install it with one simple
-command: 
-
-    gem install qemu-toolkit
-    
-For full installation instructions, please see qemu-toolkit-install(7). 
-
-## CONTRIBUTE
-
-This project is hosted on
-[bitbucket](https://bitbucket.org/kschiess/qemu-toolkit/src). An issue tracker
-is available at
-[bitbucket](https://bitbucket.org/kschiess/qemu-toolkit/issues).
-
-We value all contributions, provided they
-
- * are tested and have a clear rationale
- * are generally useful
- * come as a clean changeset (pull request or email patch)
-
-Discussion regarding this project via 'qemutoolkit' mailing list. Subscribe by
-sending any kind of message to this
-[address](mailto:qemutoolkit@librelist.com).
-
-## SEE ALSO
-
-qemu-toolkit-overview(7), storadm(1), vmadm(1)
-
-## AUTHORS
-
-Copyright (c) 2012 Kaspar Schiess. 
-
-## COPYRIGHT
-
-This tool is under a MIT license. Please see the LICENSE file in the original
-source.
+# qemu-toolkit(7) -- A toolkit for running qemu on Illumos / OmniOS
+
+## SYNOPSIS
+
+qemu-toolkit is a small set of scripts to control QEMU kvm virtualised
+machines on a set of illumos hosts. Have a look at 'storadm' and 
+'vmadm' - inline help will show you the possibilities.
+
+## INSTALLATION
+
+qemu-toolkit is a Ruby gem. This means you can install it with one simple
+command: 
+
+    gem install qemu-toolkit
+    
+For full installation instructions, please see qemu-toolkit-install(7). 
+
+## CONTRIBUTE
+
+This project is hosted on
+[bitbucket](https://bitbucket.org/kschiess/qemu-toolkit/src). An issue tracker
+is available at
+[bitbucket](https://bitbucket.org/kschiess/qemu-toolkit/issues).
+
+We value all contributions, provided they
+
+ * are tested and have a clear rationale
+ * are generally useful
+ * come as a clean changeset (pull request or email patch)
+
+Discussion regarding this project via 'qemutoolkit' mailing list. Subscribe by
+sending any kind of message to this
+[address](mailto:qemutoolkit@librelist.com).
+
+## SEE ALSO
+
+qemu-toolkit-overview(7), storadm(1), vmadm(1)
+
+## AUTHORS
+
+Copyright (c) 2012 Kaspar Schiess. 
+
+## COPYRIGHT
+
+This tool is under a MIT license. Please see the LICENSE file in the original
+source.
+README(7)     README.7

doc/qemu-toolkit-install.7.ronn

+# qemu-toolkit-install(7) -- Installations instructions for the qemu-toolkit
+
+## PREREQUISITES
+
+For this to run, you need at least one physical host running
+[OmniOS](http://omnios.omniti.com/) or another
+[Illumos](https://en.wikipedia.org/wiki/Illumos)-based distro. The host needs
+to support VT/x extensions to be able to run KVM-based virtualisation. Also, 
+some basic working knowledge of Illumos is of help. 

doc/qemu-toolkit-overview.7.ronn

 
 ## OVERVIEW
 
-This is the toolkit for running qemu on OmniOS/Illumos. Features:
+This is a toolkit for running qemu on OmniOS/Illumos. Features:
 
-  * Run VMs based on local zvols 
-  * Run VMs based on iSCSI targets
-  * Fully use QEMUs options (through a nifty Ruby DSL)
-  * Automatic network configuration based on vnics
-  * Using vnics confined to VLANs
+  * VMs based on local zvols 
+  * VMs based on iSCSI targets
+  * Full access to QEMUs options (through a nifty Ruby DSL)
+  * Automatic vnic creation, supports VLAN tags
   * Secure VNC channel through unix socket
   * Access to VM monitor and serial console
   
 target on B) While this configuration is certainly more complex than the
 all-local one above, it is also more flexible to administer.
 
-## PREREQUISITES
+## BUGS
 
-For this to run, you need at least one physical host running
-[OmniOS](http://omnios.omniti.com/) or another
-[Illumos](https://en.wikipedia.org/wiki/Illumos)-based distro. The host needs
-to support VT/x extensions to be able to run KVM-based virtualisation. Also, 
-some basic working knowledge of Illumos is of help. 
+When using iscsi targets, you have to relaunch the vm twice to get it to 
+start up. We have code in place to work around this, but it is not effective. 
+Work to fix this is underway. 
 
 ## SEE ALSO
 
-qemu-toolkit-overview(7), storadm(1), vmadm(1)
+qemu-toolkit-install(7), storadm(1), vmadm(1), README(7)
 
 
 ENV['RONN_ORGANIZATION'] = 'Kaspar Schiess, Technology Astronauts GmbH'
 
 Dir.chdir(File.dirname(__FILE__)) do
-  FileUtils.cp '../README', '../doc'
+  FileUtils.cp '../README.md', '../doc'
   
   system %Q(ronn --style toc --html \
     ../doc/qemu-toolkit-overview.7.ronn ../doc/storadm.1.ronn \
-    ../doc/vmadm.1.ronn ../doc/README ../doc/qemu-toolkit-install.7.ronn \
+    ../doc/vmadm.1.ronn ../doc/README.md ../doc/qemu-toolkit-install.7.ronn \
     )
 
   Dir['../doc/*.html'].each do |file|