Move things around a bit

Author: avik-pal

docs/LocalPreferences.toml

@@ -0,0 +1,2 @@
+[NonlinearSolve]
+enable_timer_outputs = true

docs/pages.jl

@@ -21,11 +21,12 @@ pages = ["index.md",
         "solvers/steady_state_solvers.md",
         "solvers/nonlinear_least_squares_solvers.md",
         "solvers/fixed_point_solvers.md"],
-    "Native Solver APIs" => Any["native/solvers.md",
+    "Native Functionalities" => Any["native/solvers.md",
         "native/simplenonlinearsolve.md",
         "native/steadystatediffeq.md",
         "native/descent.md",
-        "native/globalization.md"],
+        "native/globalization.md",
+        "native/diagnostics.md",],
     "Wrapped Solver APIs" => Any["api/fastlevenbergmarquardt.md",
         "api/fixedpointacceleration.md",
         "api/leastsquaresoptim.md",

docs/src/basics/diagnostics_api.md

@@ -1,5 +1,8 @@
 # [Diagnostics API](@id diagnostics_api)
 
+Detailed API Documentation is provided at
+[Diagonstics API Reference](@ref diagnostics_api_reference).
+
 # Logging the Solve Process
 
 All NonlinearSolve.jl native solvers allow storing and displaying the trace of the nonlinear
@@ -56,11 +59,3 @@ sol.trace
 
     For `iteration == 0` only the `norm(fu, Inf)` is guaranteed to be meaningful. The other
     values being meaningful are solver dependent.
-
-## API
-
-```@docs
-TraceMinimal
-TraceWithJacobianConditionNumber
-TraceAll
-```

docs/src/native/diagnostics.md

@@ -0,0 +1,22 @@
+# [Diagnostics API](@id diagnostics_api_reference)
+
+## Timer Outputs
+
+These functions are not exported since the names have a potential for conflict.
+
+```@docs
+NonlinearSolve.enable_timer_outputs
+NonlinearSolve.disable_timer_outputs
+NonlinearSolve.@static_timeit
+```
+
+## Tracing API
+
+```@docs
+TraceAll
+TraceWithJacobianConditionNumber
+TraceMinimal
+```
+
+For details about the arguments refer to the documentation of
+[`NonlinearSolve.AbstractNonlinearSolveTraceLevel`](@ref).

src/globalization/trust_region.jl

@@ -292,7 +292,7 @@ function reinit_cache!(cache::GenericTrustRegionSchemeCache, args...; u0 = nothi
     if u0 !== nothing
         u0_norm = cache.internalnorm(u0)
         cache.trust_region = __initial_trust_radius(cache.alg.initial_trust_radius, T,
-            cache.alg.method, cache.max_trust_radius, u0_norm)  # FIXME: scheme specific
+            cache.alg.method, cache.max_trust_radius, u0_norm, u0_norm)  # FIXME: scheme specific
     end
     cache.last_step_accepted = false
     cache.shrink_counter = 0

src/timer_outputs.jl

@@ -4,7 +4,7 @@
 const TIMER_OUTPUTS_ENABLED = @load_preference("enable_timer_outputs", false)
 
 @static if TIMER_OUTPUTS_ENABLED
-    import TimerOutputs
+    using TimerOutputs
 end
 
 """
@@ -31,7 +31,7 @@ end
 
 function get_timer_output()
     @static if TIMER_OUTPUTS_ENABLED
-        return TimerOutputs.TimerOutput()
+        return TimerOutput()
     else
         return nothing
     end
@@ -41,17 +41,16 @@ end
     @static_timeit to name expr
 
 Like `TimerOutputs.@timeit_debug` but has zero overhead if `TimerOutputs` is disabled via
-`disable_timer_outputs()`.
+[`NonlinearSolve.disable_timer_outputs()`](@ref).
 """
 macro static_timeit(to, name, expr)
     @static if TIMER_OUTPUTS_ENABLED
-        return TimerOutputs.timer_expr(__module__, true, to, name, expr)
+        return TimerOutputs.timer_expr(__module__, false, to, name, expr)
     else
         return esc(expr)
     end
 end
 
-@inline reset_timer!(::Nothing) = nothing
-@static if TIMER_OUTPUTS_ENABLED
-    @inline reset_timer!(timer::TimerOutputs.TimerOutput) = TimerOutputs.reset_timer!(timer)
+@static if !TIMER_OUTPUTS_ENABLED
+    @inline reset_timer!(::Nothing) = nothing
 end