New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Heat Documentation Update and Re-organization #5841

Open
ryatpronk opened this Issue Jun 27, 2018 · 1 comment

Comments

Projects
None yet
2 participants
@ryatpronk
Copy link

ryatpronk commented Jun 27, 2018

Feature requests

If this issue is a feature request:

  • Describe the scenario and benefits that the feature supports.

(Provide lots of specific detail so we understand the context around the feature.)
Clarify how to use heat to avoid build errors.

  • Describe how you're accomplishing the feature today (if possible).

(Be as specific as you can and err on the side of providing too much information.)
Guess-and-test until something builds.

  • Describe what you'd like the new feature to do.

(There's no need to design it but suggestions are appreciated.)

  1. Update http://wixtoolset.org/documentation/manual/v3/overview/heat.html so that it correctly doesn't have colons in the arguments.

  2. Re-organize the switches so that the required ones are marked and are listed under the harvest type they apply to (if they are exclusive). Small example:

project
-configuration (required)
-platform (required)

optional switches for all harvest types
-ag

You could possibly just add a third column for the switches that groups them by harvest type while still retaining alpha order within each group.

  1. Be sure to update the examples and make sure they are buildable. It would be nice to explain how to integrate the newly generated file into a VS wix project.

@barnson barnson added this to the v3.x milestone Jul 19, 2018

@barnson

This comment has been minimized.

Copy link
Member

barnson commented Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment