Skip to content

[SR-2025] "swift build" usage text should specify defaults #5249

@modocache

Description

@modocache
mannequin
Previous ID SR-2025
Radar None
Original Reporter @modocache
Type Improvement
Status Resolved
Resolution Done
Additional Detail from JIRA
Votes 0
Component/s Package Manager
Labels Improvement, StarterBug
Assignee czechboy0 (JIRA)
Priority Medium

md5: e23a6d16db5a9614574682308f22c7b9

Issue Description:

Kudos on the very helpful help text for "swift build":

$ swift-build --help
OVERVIEW: Build sources into binary products

USAGE: swift build [mode] [options]

MODES:
  -c, --configuration <value>   Build with configuration (debug|release)
  --clean <mode>                Delete artifacts (build|dist)

OPTIONS:
  -C, --chdir <path>       Change working directory before any other operation
  --build-path <path>      Specify build directory
  --color <mode>           Specify color mode (auto|always|never)
  -v, --verbose            Increase verbosity of informational output
  -Xcc <flag>              Pass flag through to all C compiler invocations
  -Xlinker <flag>          Pass flag through to all linker invocations
  -Xswiftc <flag>          Pass flag through to all Swift compiler invocations

NOTE: Use `swift package` to perform other functions on packages

I feel this can be improved by specifying what the defaults are for some of these options. For example, the default path for build-path is the current directory. The default configuration is debug.

/cc @aciidb0mb3r, @abertelrud

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions