Skip to content

features.json is missing from Windows installer for docc #337

@jakepetroules

Description

@jakepetroules

We probably need a section similar to this, but for docc:

<ComponentGroup Id="SwiftFeatures" Directory="_usr_share_swift">
  <Component>
    <File Source="$(TOOLCHAIN_ROOT)\usr\share\swift\features.json" />
  </Component>
</ComponentGroup>

Activity

compnerd

compnerd commented on Sep 7, 2024

@compnerd
Member

DocC currently isn't usable on windows due to the missing pending change (CC: @FranzBusch). I'm happy to add the features.json for clang though.

compnerd

compnerd commented on Sep 9, 2024

@compnerd
Member

https://github.com/swiftlang/swift-installer-scripts/blob/main/platforms/Windows/bld/bld.wxs#L158-L162

It seems that the clang features.json is already present. @jakepetroules is there something that I'm missing here?

jakepetroules

jakepetroules commented on Sep 9, 2024

@jakepetroules
Author

It's referenced in the WiX sources but doesn't actually get installed on the system. Does WiX not error out if it references a file that doesn't exist when building the installer?

compnerd

compnerd commented on Sep 9, 2024

@compnerd
Member

Yes, if the file is missing the installer will fail to build.

jakepetroules

jakepetroules commented on Sep 9, 2024

@jakepetroules
Author

Oh, looks like you fixed clang in fe35b36, but that's not in the 6.0 branch. I'll update the title to reflect that this is only an issue for docc, then.

What's the docc usability issue you were referencing above?

changed the title [-]features.json is missing from Windows installer for clang and docc[/-] [+]features.json is missing from Windows installer for docc[/+] on Sep 9, 2024
compnerd

compnerd commented on Sep 9, 2024

@compnerd
Member

DocC cannot generate the documentation on Windows due to the use of : in the filenames. There is an existing PR (swiftlang/swift-docc#668) that adjusts that, but I think that there is still lack of clarity on how to migrate to that.

jakepetroules

jakepetroules commented on Sep 9, 2024

@jakepetroules
Author

Thanks for the reference. I think those two issues could be resolved in parallel, though.

compnerd

compnerd commented on Sep 9, 2024

@compnerd
Member

Yeah, I suppose that we could start building it. The one issue is the build times - I think that using CMake resulted in a 7% build time improvement as well as alleviated some bloat due to being able to do dynamic linking against other toolchain components.

jakepetroules

jakepetroules commented on Sep 13, 2024

@jakepetroules
Author

To be clear, we are currently shipping docc.exe as part of the Swift Windows installer already. Just the features.json is missing.

compnerd

compnerd commented on Sep 13, 2024

@compnerd
Member

To be clear, we are currently shipping docc.exe as part of the Swift Windows installer already. Just the features.json is missing.

Interesting, I don't remember getting that enabled, but that is great!

jakepetroules

jakepetroules commented on Sep 16, 2024

@jakepetroules
Author

Oh, you may be right. I remember seeing it in some toolchain build at least, maybe that was an older version and it's since been removed again.

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

Metadata

Metadata

Assignees

Labels

WindowsPlatform: Windows

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @compnerd@jakepetroules

      Issue actions

        features.json is missing from Windows installer for docc · Issue #337 · swiftlang/swift-installer-scripts