Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit bedc0b3

Browse files
authored
Merge pull request #100 from SwiftDocOrg/handle-posix-errors
Log warning message when failing to generate graph
2 parents 7c341a9 + f85fd68 commit bedc0b3

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ as well as top-level type aliases, functions, and variables.
1717
## Requirements
1818

1919
- Swift 5.2
20+
- [GraphViz][graphviz] _(optional)_
2021

2122
## Command-Line Utility
2223

Sources/swift-doc/Supporting Types/Components/Relationships.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ struct Relationships: Component {
4949
do {
5050
return try HypertextLiteral.HTML(String(data: graph.render(using: algorithm, to: .svg), encoding: .utf8) ?? "")
5151
} catch {
52-
logger.error("\(error)")
52+
logger.warning("Failed to generate relationship graph for \(symbol.id). Please ensure that GraphViz binaries are accessible from your PATH. (\(error))")
5353
return nil
5454
}
5555
}

0 commit comments

Comments
 (0)