From 7eabfaa3aa3a0bb9402fd43913bdc122bdb1fc64 Mon Sep 17 00:00:00 2001 From: David German Date: Wed, 5 Oct 2016 12:49:01 -0400 Subject: [PATCH] Remove Windows documentation. --- drake/doc/developers.rst | 23 +---- drake/doc/faq.rst | 2 +- drake/doc/from_binary.rst | 15 +-- drake/doc/from_source.rst | 17 ++- drake/doc/issues.rst | 6 +- drake/doc/jenkins.rst | 2 +- drake/doc/sublime_text.rst | 2 +- drake/doc/windows.rst | 207 ------------------------------------- 8 files changed, 18 insertions(+), 256 deletions(-) delete mode 100644 drake/doc/windows.rst diff --git a/drake/doc/developers.rst b/drake/doc/developers.rst index 26c47f6ff022..e41e6064ccff 100644 --- a/drake/doc/developers.rst +++ b/drake/doc/developers.rst @@ -71,8 +71,7 @@ officially supports. Supported configurations are tested in continuous integration. All other configurations are provided on a best-effort basis. On Ubuntu and OS X, the "Unix Makefiles" and "Ninja" CMake generators are -supported. On Windows, the "Visual Studio 14 2015", -"Visual Studio 14 2015 Win64", and "Ninja" CMake generators are supported. +supported. The supported version of MATLAB is R2015b. @@ -98,26 +97,6 @@ and ``WITH_GFLAGS``, which should be set to ``ON``. | | | Java 1.7 | +---------+ | | | | Release | +-----------------------------------------+--------------------+-------------------+---------+ -| | Windows Server 2012 R2 or Windows 8.1 | | MSVC 14 32-bit | Minimal | Debug | -| | Visual Studio 2015 (any edition) | | Java 1.7 | +---------+ -| | | | Release | -| | +-------------------+---------+ -| | | Default | Debug | -| | | +---------+ -| | | | Release | -| | +-------------------+---------+ -| | | Default + MATLAB | Release | -| +--------------------+-------------------+---------+ -| | | MSVC 14 64-bit | Minimal | Debug | -| | | Java 1.7 | +---------+ -| | | | Release | -| | +-------------------+---------+ -| | | Default | Debug | -| | | +---------+ -| | | | Release | -| | +-------------------+---------+ -| | | Default + MATLAB | Release | -+-----------------------------------------+--------------------+-------------------+---------+ | OS X 10.10 | | Apple Clang 7.0 | Minimal | Debug | | | | Java 1.8 | +---------+ | | | | Release | diff --git a/drake/doc/faq.rst b/drake/doc/faq.rst index 237caebf8b32..8c72d9fbb925 100644 --- a/drake/doc/faq.rst +++ b/drake/doc/faq.rst @@ -81,7 +81,7 @@ they will get in sync soon, but for now I've decided the best fix is to edit the Drake tells me I don't have Simulink 3D Animation Toolbox, but I'm sure that I do! ================================================================================== -You might have to actually tell MATLAB to install the tool, running ``vrinstall`` in MATLAB. On windows, use ``vrinstall -install editor``. +You might have to actually tell MATLAB to install the tool, running ``vrinstall`` in MATLAB. .. _faq_undefined_symbol-sincos_stret: diff --git a/drake/doc/from_binary.rst b/drake/doc/from_binary.rst index a8d045c4f7e9..9396a8ceed76 100644 --- a/drake/doc/from_binary.rst +++ b/drake/doc/from_binary.rst @@ -1,6 +1,6 @@ -***************************************** -Binary installation (mac, linux, windows) -***************************************** +******************************** +Binary installation (mac, linux) +******************************** Note: This is still new and relatively untested. Please report any issues you have. @@ -25,15 +25,6 @@ Then ``cd`` into the examples directories and try some things out. Here are a f Please note that you will have to run `addpath_drake` each time you start MATLAB, or `add it to your startup.m `_. - -Windows Specific ----------------- - -In certain cases, Microsoft's redistributable C++ runtime libraries need to be installed for mex files to work correctly in Windows. They can be found here: http://www.microsoft.com/en-us/download/details.aspx?id=40784 - -In order to use the Drake visualizer in Windows, the `drake_visualizer.bat` file must be executed from the `build/` folder within Drake. - - Linux Specific -------------- diff --git a/drake/doc/from_source.rst b/drake/doc/from_source.rst index e8ee57aee8a2..98c1d068c9af 100644 --- a/drake/doc/from_source.rst +++ b/drake/doc/from_source.rst @@ -1,23 +1,23 @@ .. _build_from_source: -***************************************** -Source installation (mac, linux, windows) -***************************************** +******************************** +Source installation (mac, linux) +******************************** Optional: Setting up the MATLAB Compiler ======================================== -If you'd like to build the MATLAB interface, you will need a `C/C++ compiler that is compatible with your MATLAB version `_. Run ``mex -setup`` at the MATLAB command line to set this up. We typically use gcc on linux, clang on mac, or Visual Studio 2015 on Windows. - -Make sure that the MATLAB executable is in your path. (e.g., typing ``matlab`` at the system command line should start an instance of MATLAB). For example, on Mac you might consider ``sudo ln -s /Applications/MATLAB_R2014a.app/bin/matlab /usr/bin/matlab``, or you can actually add the MATLAB/bin directory to your system path. On windows, you should `edit your path environment variable `_ to include e.g. ``C:\Program Files\MATLAB\R2014a\bin``. +Make sure that the MATLAB executable is in your path. (e.g., typing ``matlab`` + at the system command line should start an instance of MATLAB). For example, + on Mac you might consider + ``sudo ln -s /Applications/MATLAB_R2014a.app/bin/matlab /usr/bin/matlab``, + or you can actually add the MATLAB/bin directory to your system path. .. _getting_drake: Getting Drake ============= -Note: If you are using Windows, you will want to make sure that ``git`` is set to `handle cross-platform linefeed issues `_. These options appear to be enabled by default in the cygwin installation of ``git``, but must be set manually on the native windows version. - We recommend that you `setup SSH access to Github.com `_ to avoid needing to type your password each time you access it. The following instructions assume you have uploaded your public SSH key to your Github @@ -87,7 +87,6 @@ setup steps: homebrew ubuntu_trusty ubuntu_xenial - windows .. _build_the_collection: diff --git a/drake/doc/issues.rst b/drake/doc/issues.rst index bce1f64b49a8..cfd4e5e9cefb 100644 --- a/drake/doc/issues.rst +++ b/drake/doc/issues.rst @@ -91,9 +91,9 @@ useful: Configuration ============= -An issue may have configuration ``linux``, ``windows``, and/or ``mac``. It may -additionally have configuration ``matlab``. If no ``configuration`` label is -present, the issue is assumed to affect all configurations. +An issue may have configuration ``linux`` or ``mac``. It may additionally have +configuration ``matlab``. If no ``configuration`` label is present, the issue +is assumed to affect all configurations. Status ====== diff --git a/drake/doc/jenkins.rst b/drake/doc/jenkins.rst index 911e39907aaa..52a5d59df69b 100644 --- a/drake/doc/jenkins.rst +++ b/drake/doc/jenkins.rst @@ -27,7 +27,7 @@ Running an On-Demand Build There are a number of Jenkins builds that do not normally run pre-merge, but do run post-merge or nightly. The post-merge and nightly builds include -long-running tests, lower-priority platforms (e.g. Windows MATLAB), and +long-running tests, lower-priority platforms (e.g. Mac), and specialized options (e.g. `MemorySanitizer `_). Members of the RobotLocomotion organization can manually schedule these builds diff --git a/drake/doc/sublime_text.rst b/drake/doc/sublime_text.rst index 1d36d0b18bc8..4277557cdbac 100644 --- a/drake/doc/sublime_text.rst +++ b/drake/doc/sublime_text.rst @@ -46,7 +46,7 @@ To change your custom user preferences, go to "Sublime Text", "Preferences", Full File Path Display ---------------------- Note that this only needs to be done on OS X since the full path appears by -default on Windows and Linux machines. +default on Linux machines. To display the current file's full path in the title bar on OSX:: diff --git a/drake/doc/windows.rst b/drake/doc/windows.rst deleted file mode 100644 index 7f34dd866ecc..000000000000 --- a/drake/doc/windows.rst +++ /dev/null @@ -1,207 +0,0 @@ -.. _windows-installation-instructions: - -*************************************** -Drake Windows Installation Instructions -*************************************** - -.. contents:: `Table of contents` - :depth: 3 - :local: - -Install Prerequisites -===================== - -.. _windows-installation-matlab: - -Enabling MATLAB Support (Optional) ----------------------------------- - -If you want to use the MATLAB-powered elements of Drake, be sure to: - -1. Follow the instructions `here `_ to setup MATLAB. -2. Within MATLAB, execute ``mex -setup`` to set up a compatible compiler (e.g., `Microsoft Visual Studio 2015 Community `_). -3. Install the `VC++ component `_. -4. Add MATLAB to your system path. - -.. _windows-installation-java: - -Git ---- - -Download and install `Git for Windows `_. Note that this includes a ``bash`` shell, which we will use below. - -Java Development Kit (JDK) --------------------------- - -Download and install `Java's JDK `_. Then add the executable directory, e.g. ``C:\Program Files\Java\jdk[version]\bin``, to your `system path `_. - -.. _windows-installation-cmake: - -CMake ------ - -CMake 3.5 or higher is required. - -Please visit the `CMake Download Page`_ to obtain a Windows binary. -Say yes when the CMake installer offers to add itself to your system path. -Verify that ``C:\Program Files (x86)\CMake\bin`` is added to your path. -This can be done by opening a command prompt by typing:: - - $ cmd - -and executing:: - - $ echo %PATH% - -.. _`CMake Download Page`: https://cmake.org/download/ - -.. _windows-installation-gnu: - -Make for Windows ----------------------- - -Download and install `Make for Windows `_. Be sure to add the directory containing the ``make.exe`` executable to your system path. For example, they are typically installed in ``C:\Program Files (x86)\GnuWin32\bin``. - -.. _windows-installation-pkg-config: - -pkg-config ----------- - -Download and install `pkg-config-lite `_ or another pkg-config win32 implementation of your choosing. Be sure to add ``[...]\pkg-config-lite-0.28-1\bin`` to your path. - -.. _windows-installation-visual-studio: - -Microsoft Visual Studio Community 2015 --------------------------------------- - -Download and install the free `Microsoft Visual Studio Community 2015 `_. This is a free version of Microsoft Visual Studio. - -During the installation process, select the custom install option, then select "Programming Languages / Visual C++". - -.. _windows-compilation: - -Drake Compilation -================= - -.. _windows-obtain-source-code: - -Obtain the Source Code ----------------------- - -Open a ``git`` bash shell. Then clone the master branch of Drake's official repository:: - - $ cd [source code directory] - $ git clone https://github.com/RobotLocomotion/drake.git drake-distro - -At this point, we recommend you update your ``git remotes`` to avoid accidentally pushing to Drake's official repository as described :ref:`here `. - -NOTE: If you want to use the `WITH_SNOPT` build option, you will need to -use ssh rather than https access to github. Follow github's instructions -for setting up ssh key access. - -.. _windows-build-directory: - -Create Build Directory ----------------------- - -Create a directory for holding Drake's compiler artifacts:: - - $ cd drake-distro - $ mkdir build - -.. _windows-configure-build: - -Configure Build ---------------- - -Configure the build system:: - - $ cd drake-distro/build - $ cmake-gui .. - -You should see the following ``CMake`` GUI appear: - -.. image:: images/windows_install/windows-ccmake-blank.png - -Click on the "Configure" button. Select the generator you want to use. The two options available are: - -1. Visual Studio 14 2015 -- For 32-bit builds -2. Visual Studio 14 2015 Win64 -- For 64-bit builds - -The screen shot below shows “Visual Studio 14 2015” being selected, which will compile a 32-bit version of Drake. - -Note: An alternative way to select the generator is via the ``CMAKE_FLAGS`` environment variable. To use the 64-bit Visual Studio generator, set ``CMAKE_FLAGS`` to be ``-G "Visual Studio 14 2015 Win64"``. If you want to build 32-bit binaries, use ``-G "Visual Studio 14 2015"``. - -.. image:: images/windows_install/drake-windows-32bit.png - -Click Finish. Allow the CMake GUI to analyze all of the options. Once done, you should see the following: - -.. image:: images/windows_install/drake-windows-config-red.png - -The options all appear red because you haven't actually configured anything yet. Select the options you want. Then click on the "Configure" button again. The options should all appear white as shown below. - -.. image:: images/windows_install/drake-windows-config-white.png - -Finally, click on “Generate” to produce the make files. You may now close the CMake GUI. - -.. _windows-compile-drake: - -Compile Drake -------------- - -Back in the ``bash`` terminal, start the compilation process. There are many configurations you can compile Drake in. For example, three popular configurations are ``Debug``, ``RelWithDebInfo``, and ``Release``. You specify the mode when compiling Drake, as shown below:: - - $ cd drake-distro/build - $ cmake --build . --target ALL_BUILD --config [build configuration] - -For example, to compile Drake using build configuration ``RelWithDebInfo``, execute:: - - $ cd drake-distro/build - $ cmake --build . --target ALL_BUILD --config RelWithDebInfo - -Sit back. Grab a coffee. The compilation process will take a while. - -Note that after this initial build is done, if you change Drake's code, you can more quickly recompile by executing:: - - $ cd drake-distro/build/drake - $ cmake --build . --target ALL_BUILD --config [build configuration] - -Update PATH Environment Variable --------------------------------- - -The compilation process generates a bunch of installed ``.dll`` libraries. You need to add the path to these libraries to your ``PATH`` environment variable: - -* ``drake-distro/build/install/lib`` -* ``drake-distro/build/install/bin`` - -Test Compilation Results ------------------------- - -To verify Drake was successfully compiled, run the unit tests:: - - $ cd drake-distro/build/drake - $ ctest -VV -C [build mode] - -You can also run a specific unit test:: - - $ cd drake-distro/build/drake - $ ctest -VV -C [build mode] -R [name of unit test] - -For more details on unit testing, see :ref:`here `. - - -.. When you're done with these platform-specific steps, return to :doc:`from_source` to complete and test your installation. - - - -Other Handy Notes -================= - -To compile Fortran pods (e.g. ``avl``, ``xfoil``, ...), I installed Intel Parallel Studio XE Cluster (for ``ifort`` compiler, requires a license). -Would have loved to use ``gfortran``, but my understanding is that it is fundamentally not compatible with the rest of the visual studio building tools. - - -To disable the debug question every time MATLAB crashes running unit tests, execute the following from a terminal:: - - $ reg add "HKCU\Software\Microsoft\Windows\Windows Error Reporting\ExcludedApplications" /v "MATLAB.exe" /t REG_SZ /d 1 /f - $ reg add "HKCU\Software\Microsoft\Windows\Windows Error Reporting" /v "DontShowUI" /t REG_DWORD /d 1 /f