nixos/nix
1
1
Fork 0
mirror of https://github.com/NixOS/nix.git synced 2025-11-30 06:01:00 +01:00
Code Activity

EvalState: add doc comment

Browse source
This commit is contained in:
Robert Hensing 2025-10-13 13:14:05 +02:00
parent 6db86389ce
commit 48a5e2dde2
2 changed files with 15 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/libexpr/include/nix/expr/eval.hh
View file

@ -508,8 +508,15 @@ private:
public: public:
/**
* @param lookupPath Only used during construction.
* @param store The store to use for instantiation
* @param fetchSettings Must outlive the lifetime of this EvalState!
* @param settings Must outlive the lifetime of this EvalState!
* @param buildStore The store to use for builds ("import from derivation", C API `nix_string_realise`)
*/
EvalState( EvalState(
const LookupPath & _lookupPath, const LookupPath & lookupPath,
ref<Store> store, ref<Store> store,
const fetchers::Settings & fetchSettings, const fetchers::Settings & fetchSettings,
const EvalSettings & settings, const EvalSettings & settings,

10
src/libutil/include/nix/util/error.hh
View file

@ -193,7 +193,9 @@ public:
} }
/** /**
* @param pos Nullable `shared_ptr<Pos>` * Prepends an item to the error trace, as is usual for extra context.
*
* @param pos Nullable source position to put in trace item
* @param fs Format string, see `HintFmt` * @param fs Format string, see `HintFmt`
* @param args... Format string arguments. * @param args... Format string arguments.
*/ */
@ -204,9 +206,11 @@ public:
} }
/** /**
* @param pos Nullable `shared_ptr<Pos>` * Prepends an item to the error trace, as is usual for extra context.
*
* @param pos Nullable source position to put in trace item
* @param hint Formatted error message * @param hint Formatted error message
* @param print Optional, whether to always print (e.g. `addErrorContext`) * @param print Optional, whether to always print (used by `addErrorContext`)
*/ */
void addTrace(std::shared_ptr<const Pos> && pos, HintFmt hint, TracePrint print = TracePrint::Default); void addTrace(std::shared_ptr<const Pos> && pos, HintFmt hint, TracePrint print = TracePrint::Default);