-
Notifications
You must be signed in to change notification settings - Fork 295
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
minimal DocC markdown to order Logger.Levels (#225)
* minimal DocC markdown to order Logger.Levels Motivation: When viewed in documentation generated by DocC, the enumeration levels are ordered alphabetically, removintg the implied ordering in the source. The written overview of the enum relies on that ordering to make sense. Modifications: Adding a single file that provides structure to Logging/Logger/Levels within DocC generated documentation. Result: When imported into a project that leverages Swift 5.6 (such as Vapor), the generated documentation for the levels provided by Logging/Logger/Levels are displayed in the order intended/expected by the documentation. * Adding a Swift 5.6 version of Package.swift Motivation: Per DocC team, an updated version is required for the DocC changes to be picked up and reflected in generated dcumentation, even for upstream projects already using swift 5.6 or later. Modifications: Adding Package.Swift@5.6 with the swift version updated. Result: Hopefully, documentation updates in DocC generated content will be reflected. * Updating linuxmain test generation for <swift5.6 Motivation: To appease CI, added #if statements into generated LinuxMain content to handle conditional compilation with Swift 5.6 and later. Modifications: Added #if statements to test generating script and re-ran the script Result: CI will hopefully pass. * also guard the LinuxMain file * Force using test discovery on 5.6+ even though tools version is latest but LinuxMain exists * cleanup * simplify docc links * formatting revert * ignore Package-swift5.6.swift from soundness license check Co-authored-by: Konrad `ktoso` Malawski <konrad_malawski@apple.com>
- Loading branch information
Showing
7 changed files
with
54 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
// swift-tools-version:5.6 | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the Swift Logging API open source project | ||
// | ||
// Copyright (c) 2018-2019 Apple Inc. and the Swift Logging API project authors | ||
// Licensed under Apache License v2.0 | ||
// | ||
// See LICENSE.txt for license information | ||
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors | ||
// | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
import PackageDescription | ||
|
||
let package = Package( | ||
name: "swift-log", | ||
products: [ | ||
.library(name: "Logging", targets: ["Logging"]), | ||
], | ||
targets: [ | ||
.target( | ||
name: "Logging", | ||
dependencies: [] | ||
), | ||
.testTarget( | ||
name: "LoggingTests", | ||
dependencies: ["Logging"] | ||
), | ||
] | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# ``Logging/Logger/Level`` | ||
|
||
## Topics | ||
|
||
### Log levels | ||
|
||
- ``trace`` | ||
- ``debug`` | ||
- ``info`` | ||
- ``notice`` | ||
- ``warning`` | ||
- ``error`` | ||
- ``critical`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters