diff mbox series

[ovs-dev] Documentation, windows: Document how to generate the Windows installer

Message ID 20200824230504.672-1-aserdean@cloudbasesolutions.com
State Superseded
Headers show
Series [ovs-dev] Documentation, windows: Document how to generate the Windows installer | expand

Commit Message

Alin Serdean Aug. 24, 2020, 11:05 p.m. UTC 
This patch adds information on how to generate the Windows installer
which can be used to easily deploy the userspace binaries, kernel module
and create services on new environments.

Signed-off-by: Alin Gabriel Serdean <aserdean@cloudbasesolutions.com>
---
 Documentation/intro/install/windows.rst | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

Comments

0-day Robot Aug. 25, 2020, 12:01 a.m. UTC | #1 
Bleep bloop.  Greetings Alin Gabriel Serdean, I am a robot and I have tried out your patch.
Thanks for your contribution.

I encountered some error that I wasn't expecting.  See the details below.


checkpatch:
WARNING: Line is 80 characters long (recommended limit is 79)
#26 FILE: Documentation/intro/install/windows.rst:76:
  `WiX Toolset <https://wixtoolset.org/>`__ and also be able to build the kernel

WARNING: Line is 80 characters long (recommended limit is 79)
#38 FILE: Documentation/intro/install/windows.rst:328:
To generate the Windows installler run the following command from the top source

WARNING: Line is 82 characters long (recommended limit is 79)
#46 FILE: Documentation/intro/install/windows.rst:336:
   This will generate the Windows installer in the following location (relative to

Lines checked: 62, Warnings: 3, Errors: 0


Please check this out.  If you feel there has been an error, please email aconole@redhat.com

Thanks,
0-day Robot
diff mbox series

Patch

diff --git a/Documentation/intro/install/windows.rst b/Documentation/intro/install/windows.rst
index 394572f00..e7b97e31c 100644
--- a/Documentation/intro/install/windows.rst
+++ b/Documentation/intro/install/windows.rst
@@ -71,7 +71,10 @@  The following explains the steps in some detail.
 
   You will need at least Visual Studio 2013 (update 4) to compile userspace
   binaries.  In addition to that, if you want to compile the kernel module you
-  will also need to install Windows Driver Kit (WDK) 8.1 Update.
+  will also need to install Windows Driver Kit (WDK) 8.1 Update or later.
+  To generate the Windows installer you need
+  `WiX Toolset <https://wixtoolset.org/>`__ and also be able to build the kernel
+  module.
 
   It is important to get the Visual Studio related environment variables and to
   have the $PATH inside the bash to point to the proper compiler and linker.
@@ -319,6 +322,21 @@  An alternative way to do the same is to run the following command:
    seconds has been observed for the change to be reflected in the UI.  This is
    not a bug in Open vSwitch.
 
+Generate the Windows installer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To generate the Windows installler run the following command from the top source
+directory:
+
+::
+
+   $ make windows_installer
+
+.. note::
+   This will generate the Windows installer in the following location (relative to
+   the top source directory):
+   windows/ovs-windows-installer/bin/Release/OpenvSwitch.msi
+
 Starting
 --------
 
@@ -797,5 +815,4 @@  TODO
 
 * Investigate and add the feature to provide QoS.
 
-* Sign the driver & create an MSI for installing the different Open vSwitch
-  components on Windows.
+* Sign the driver.