Skip to content

Commit d64b351

Browse files
committed
Merge pull request #592 from sbt/docs/windows
FIX #590 fixed irritating windows documentation
2 parents 00d6cf9 + d9c5eda commit d64b351

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

src/sphinx/formats/windows.rst

+16-15
Original file line numberDiff line numberDiff line change
@@ -40,45 +40,46 @@ Build
4040
Required Settings
4141
~~~~~~~~~~~~~~~~~
4242

43-
A rpm package needs some mandatory settings to be valid. Make sure
43+
A windows package needs some mandatory settings to be valid. Make sure
4444
you have these settings in your build:
4545

4646
.. code-block:: scala
4747
48-
rpmRelease := "1"
49-
50-
rpmVendor := "typesafe"
51-
52-
rpmUrl := Some("http://github.com/paulp/sbt-extras")
53-
54-
rpmLicense := Some("BSD")
48+
// general package information (can be scoped to Windows)
49+
maintainer := "Josh Suereth <[email protected]>"
50+
packageSummary := "test-windows"
51+
packageDescription := """Test Windows MSI."""
52+
53+
// wix build information
54+
wixProductId := "ce07be71-510d-414a-92d4-dff47631848a"
55+
wixProductUpgradeId := "4552fb0e-e257-4dbd-9ecb-dba9dbacf424"
5556
5657
5758
1.0 or higher
5859
~~~~~~~~~~~~~
5960

60-
Enables the rpm plugin
61+
Enables the windows plugin
6162

6263
.. code-block:: scala
6364
64-
enablePlugins(RpmPlugin)
65+
enablePlugins(WindowsPlugin)
6566
6667
6768
0.8 or lower
6869
~~~~~~~~~~~~
6970

70-
For this versions rpm packaging is automatically activated.
71+
For this versions windows packaging is automatically activated.
7172
See the :doc:`Getting Started </gettingstarted>` page for information
7273
on how to enable sbt native packager.
7374

7475
Configuration
7576
-------------
7677

77-
Settings and Tasks inherited from parent plugins can be scoped with ``Rpm``.
78+
Settings and Tasks inherited from parent plugins can be scoped with ``Universal``.
7879

7980
.. code-block:: scala
8081
81-
linuxPackageMappings in Rpm := linuxPackageMappings.value
82+
mappings in Windows := (mappings in Universal).value
8283
8384
Now, let's look at the full set of windows settings.
8485

@@ -155,8 +156,8 @@ Customize
155156
Feature configuration
156157
~~~~~~~~~~~~~~~~~~~~~
157158

158-
The abstraction over wix allows you to configure "features" that users may optionally install. These feature are higher level things, like a set of files or menu links.
159-
The currently supported components of features are:
159+
The abstraction over wix allows you to configure "features" that users may optionally install. These feature are higher level things,
160+
like a set of files or menu links. The currently supported components of features are:
160161

161162
1. Files (``ComponentFile``)
162163
2. Path Configuration (``AddDirectoryToPath``)

0 commit comments

Comments
 (0)