File: .lake/packages/lean4/src/lean/lake/Lake/Build/Basic.lean

full_name: Lake.noBuildCode
code: /-- Exit code to return if `--no-build` is set and a build is required. -/
def noBuildCode : ExitCode 
goal: Lake.ExitCode

full_name: Lake.BuildConfig.trustHash
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Bool

full_name: Lake.BuildConfig.noBuild
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Bool

full_name: Lake.BuildConfig
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Type

full_name: Lake.BuildConfig.failLv
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Lake.LogLevel

full_name: Lake.BuildConfig.oldMode
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Bool

full_name: Lake.BuildConfig.out
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Lake.OutStream

full_name: Lake.BuildConfig.verbosity
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Lake.Verbosity

full_name: Lake.BuildConfig.ansiMode
code: /-- Configuration options for a Lake build. -/
structure BuildConfig where
  oldMode : Bool := false
  trustHash : Bool := true
  /-- Early exit if a target has to be rebuilt. -/
  noBuild : Bool := false
  verbosity : Verbosity := .normal
  /--
  Fail the top-level build if entries of at least this level have been logged.

  Unlike some build systems, this does **NOT** convert such log entries to
  errors, and it does not abort jobs when warnings are logged (i.e.,
  dependent jobs will still continue unimpeded).
  -/
  failLv : LogLevel := .error
  /--
  The stream to which Lake reports build progress.
  By default, Lake uses `stderr`.
  -/
  out : OutStream := .stderr
  /-- Whether to use ANSI escape codes in build output. -/
  ansiMode : AnsiMode := .auto
goal: Lake.AnsiMode

full_name: Lake.BuildConfig.outLv
code: /-- The minimum log level for an log entry to be reported. -/
@[inline] def BuildConfig.outLv (cfg : BuildConfig) : LogLevel 
goal: Lake.LogLevel

full_name: Lake.BuildConfig.showProgress
code: /--
Whether the build should show progress information.

`Verbosity.quiet` hides progress and, for a `noBuild`,
`Verbosity.verbose` shows progress.
-/
def BuildConfig.showProgress (cfg : BuildConfig) : Bool 
goal: Bool

full_name: Lake.OpaqueJob.nonemptyType
code: /-- A Lake job with an opaque value type in `Type`. -/
declare_opaque_type OpaqueJob
goal: NonemptyType

full_name: Lake.instNonemptyOpaqueJob
code: /-- A Lake job with an opaque value type in `Type`. -/
declare_opaque_type OpaqueJob
goal: Nonempty Lake.OpaqueJob

full_name: Lake.OpaqueJob
code: /-- A Lake job with an opaque value type in `Type`. -/
declare_opaque_type OpaqueJob
goal: Type

full_name: Lake.BuildContext.leanTrace
code: /-- A Lake context with a build configuration and additional build data. -/
structure BuildContext extends BuildConfig, Context where
  leanTrace : BuildTrace
  registeredJobs : IO.Ref (Array OpaqueJob)
goal: Lake.BuildTrace

full_name: Lake.BuildContext.registeredJobs
code: /-- A Lake context with a build configuration and additional build data. -/
structure BuildContext extends BuildConfig, Context where
  leanTrace : BuildTrace
  registeredJobs : IO.Ref (Array OpaqueJob)
goal: IO.Ref (Array Lake.OpaqueJob)

full_name: Lake.BuildContext
code: /-- A Lake context with a build configuration and additional build data. -/
structure BuildContext extends BuildConfig, Context where
  leanTrace : BuildTrace
  registeredJobs : IO.Ref (Array OpaqueJob)
goal: Type

full_name: Lake.BuildT
code: /-- A transformer to equip a monad with a `BuildContext`. -/
abbrev BuildT 
goal: Type u_1

full_name: Lake.MonadBuild
code: /-- A monad equipped with a Lake build context. -/
abbrev MonadBuild (m : Type → Type u) 
goal: Type u

full_name: Lake.getBuildContext
code: @[inline] def getBuildContext [MonadBuild m] : m BuildContext 
goal: m Lake.BuildContext

full_name: Lake.getLeanTrace
code: @[inline] def getLeanTrace [Functor m] [MonadBuild m] : m BuildTrace 
goal: m Lake.BuildTrace

full_name: Lake.getBuildConfig
code: @[inline] def getBuildConfig [Functor m] [MonadBuild m] : m BuildConfig 
goal: m Lake.BuildConfig

full_name: Lake.getIsOldMode
code: @[inline] def getIsOldMode [Functor m] [MonadBuild m] : m Bool 
goal: m Bool

full_name: Lake.getTrustHash
code: @[inline] def getTrustHash [Functor m] [MonadBuild m] : m Bool 
goal: m Bool

full_name: Lake.getNoBuild
code: @[inline] def getNoBuild [Functor m] [MonadBuild m] : m Bool 
goal: m Bool

full_name: Lake.getVerbosity
code: @[inline] def getVerbosity [Functor m] [MonadBuild m] : m Verbosity 
goal: m Lake.Verbosity

full_name: Lake.getIsVerbose
code: @[inline] def getIsVerbose [Functor m] [MonadBuild m] : m Bool 
goal: m Bool

full_name: Lake.getIsQuiet
code: @[inline] def getIsQuiet [Functor m] [MonadBuild m] : m Bool 
goal: m Bool

full_name: Lake.CoreBuildM
code: /-- The internal core monad of Lake builds.  Not intended for user use. -/
abbrev CoreBuildM 
goal: Type

full_name: Lake.logStep
code: /--
Logs a build step with `message`.

**Deprecated:**  Build steps are now managed by a top-level build monitor.
As a result, this no longer functions the way it used to. It now just logs the
`message` via `logVerbose`.
-/
@[deprecated, inline] def logStep [Monad m] [MonadLog m] (message : String) : m Unit 
goal: m Unit