swiftlang / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.
https://swift.org/documentation/docc
Apache License 2.0
1.19k stars 127 forks source link

[SR-15965] Address slight performance regression caused by emitting JSON navigator index #175

Open ethan-kusters opened 2 years ago

ethan-kusters commented 2 years ago
Previous ID SR-15965
Radar rdar://problem/90348989
Original Reporter @ethan-kusters
Type Bug
Additional Detail from JIRA | | | |------------------|-----------------| |Votes | 0 | |Component/s | Swift-DocC | |Labels | Bug | |Assignee | None | |Priority | Medium | md5: 0f2d9f67b27428207ea630cf28632c51

Issue Description:

We've noticed a slight performance regression caused by emitting a JSON representation of the navigator alongside the LMDB one. We should look into parallelizing there output to address this.

Project Building with Indexing Disabled Building with LMDB Indexing (Current Default) Building With LMDB+JSON Indexing (Proposed Default) Building With JSON Indexing (Future Default)
`Swift Markdown` 1.01 1.10 1.10 1.06
`SwiftSyntax` 23.51 26.37 27.24 25.37

https://forums.swift.org/t/emitting-a-json-representation-of-the-docc-navigator-index/55826/13

ethan-kusters commented 2 years ago

@swift-ci create