Timothy Hildred has posted comments on this change. Change subject: doc: adding man pages ......................................................................
Patch Set 4: (7 comments) Hey Sandro, I am sorry to be late to the party, it took me a while to figure out gerrit. I've suggested some changes, you can take or leave them. They are all intended to make it very clear and simple for the customer. .................................................... File man/hosted-engine.8 Line 6: \fBhosted\-engine\fP [options] Line 7: .PP Line 8: .SH "DESCRIPTION" Line 9: .PP Line 10: The \fBhosted\-engine\fP command can be used for deploying a VM that will host "The hosted-engine command deploys a virtual machine that you can install Red Hat Enterprise Virtualization on to. The Manager installation on your hosted-engine virtual machine can manage the host it is running on. The hosted-engine command can also be used to start, stop and access the hosted-engine virtual machine." Line 11: an Enterprise Virtualization Manager that will be able to manage the same host Line 12: running the VM. The command can also be used for starting, stopping and Line 13: accessing the VM. Line 14: \& Line 17: The following are general options you can use with this command:\& Line 18: .IP "\fB\-\-help\fP" Line 19: Show the help message and exit.\& Line 20: .IP "\fB\-\-deploy\fP" Line 21: Run ovirt-hosted-engine-setup for deploying the VM.\& I would say "Run the ovirt-hosted-engine-setup command to deploy the hosted-engine virtual machine." Line 22: .IP "\fB\-\-vm-start\fP" Line 23: Start VM on this host.\& Line 24: .IP "\fB\-\-vm-shutdown\fP" Line 25: Gracefully shutdown the VM on this host.\& Line 27: Forcefully poweroff the VM on this host.\& Line 28: .IP "\fB\-\-vm-status\fP" Line 29: Show the VM status.\& Line 30: .IP "\fB\-\-add-console-password=<password>\fP" Line 31: Create a temporary password for vnc/spice connection.\& "Create a temporary password for vnc/SPICE connections to the hosted-engine virtual machine" Better to be as specific as possible, and I think SPICE is meant to be capitalized. Line 32: .IP "\fB\-\-console\fP" Line 33: Open the configured console using remote-viewer on localhost.\& Line 34: .IP "\fB\-\-check-liveliness\fP" Line 35: Checks liveliness page of engine.\& Line 33: Open the configured console using remote-viewer on localhost.\& Line 34: .IP "\fB\-\-check-liveliness\fP" Line 35: Checks liveliness page of engine.\& Line 36: .IP "\fB\-\-connect-storage\fP" Line 37: Connect the storage domain manually.\& Connect the storage pool to what? The hosted-engine virtual machine? The host it runs on? Line 38: .IP "\fB\-\-start-pool\fP" Line 39: Start the storage pool manually.\& Line 40: Line 41: .SH "SEE ALSO" .................................................... File man/ovirt-hosted-engine-setup.8 Line 8: .SH "DESCRIPTION" Line 9: .PP Line 10: The \fBovirt\-hosted\-engine\-setup\fP command can be used for deploying a VM Line 11: that will host an Enterprise Virtualization Manager that will be able to Line 12: manage the same host running the VM. The ovirt-hosted-engine-setup command deploys a virtual machine that you can install Red Hat Enterprise Virtualization on to. The Manager installation on your hosted-engine virtual machine can manage the host it is running on. Line 13: \& Line 14: Line 15: .SH "GENERAL OPTIONS" Line 16: The following are general options you can use with this command:\& Line 16: The following are general options you can use with this command:\& Line 17: .IP "\fB\-\-help\fP" Line 18: Show the help message and exit.\& Line 19: .IP "\fB\-\-config-append=file\fP" Line 20: Load extra configuration files.\& Can we provide an example of a extra configuration file a customer might want to use with this? Line 21: .IP "\fB\-\-generate-answer=file\fP" Line 22: Generate answer file.\& Line 23: Line 24: .SH "SEE ALSO" Line 18: Show the help message and exit.\& Line 19: .IP "\fB\-\-config-append=file\fP" Line 20: Load extra configuration files.\& Line 21: .IP "\fB\-\-generate-answer=file\fP" Line 22: Generate answer file.\& Why generate an answer file? To aid with disaster recovery? Other reasons? Line 23: Line 24: .SH "SEE ALSO" Line 25: .BR hosted\-engine (8) Line 26: -- To view, visit http://gerrit.ovirt.org/18215 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: comment Gerrit-Change-Id: I58f3e0420cbb9cc93821f65c0935b83a6c12f8bf Gerrit-PatchSet: 4 Gerrit-Project: ovirt-hosted-engine-setup Gerrit-Branch: master Gerrit-Owner: Sandro Bonazzola <[email protected]> Gerrit-Reviewer: Alex Lourie <[email protected]> Gerrit-Reviewer: Eyal Edri <[email protected]> Gerrit-Reviewer: Greg Padgett <[email protected]> Gerrit-Reviewer: Lev Veyde <[email protected]> Gerrit-Reviewer: Ofer Schreiber <[email protected]> Gerrit-Reviewer: Oved Ourfali <[email protected]> Gerrit-Reviewer: Sandro Bonazzola <[email protected]> Gerrit-Reviewer: Timothy Hildred <[email protected]> Gerrit-Reviewer: Yedidyah Bar David <[email protected]> Gerrit-HasComments: Yes _______________________________________________ Engine-patches mailing list [email protected] http://lists.ovirt.org/mailman/listinfo/engine-patches
