lix/src/libcmd/editor-for.hh

#pragma once
///@file

#include "types.hh"
#include "input-accessor.hh"

namespace nix {

/**
 * Helper function to generate args that invoke $EDITOR on
 * filename:lineno.
 */
Strings editorFor(const SourcePath & file, uint32_t line);

}
Split out `CmdRepl` and `editorFor` The REPL itself and the `nix repl` CLI are conceptually different things, and thus deserve to be in different files. 2023-02-04 03:42:36 +00:00			`#pragma once`
Ensure all headers have `#pragma once` and are in API docs `///@file` makes them show up in the internal API dos. A tiny few were missing `#pragma once`. 2023-04-01 03:18:41 +00:00			`///@file`
Split out `CmdRepl` and `editorFor` The REPL itself and the `nix repl` CLI are conceptually different things, and thus deserve to be in different files. 2023-02-04 03:42:36 +00:00
			`#include "types.hh"`
Backport SourcePath from the lazy-trees branch This introduces the SourcePath type from lazy-trees as an abstraction for accessing files from inputs that may not be materialized in the real filesystem (e.g. Git repositories). Currently, however, it's just a wrapper around CanonPath, so it shouldn't change any behaviour. (On lazy-trees, SourcePath is a <InputAccessor, CanonPath> tuple.) 2023-04-06 11:15:50 +00:00			`#include "input-accessor.hh"`
Split out `CmdRepl` and `editorFor` The REPL itself and the `nix repl` CLI are conceptually different things, and thus deserve to be in different files. 2023-02-04 03:42:36 +00:00
			`namespace nix {`

Finish converting existing comments for internal API docs (#8146) * Finish converting existing comments for internal API docs 99% of this was just reformatting existing comments. Only two exceptions: - Expanded upon `BuildResult::status` compat note - Split up file-level `symbol-table.hh` doc comments to get per-definition docs Also fixed a few whitespace goofs, turning leading tabs to spaces and removing trailing spaces. Picking up from #8133 * Fix two things from comments * Use triple-backtick not indent for `dumpPath` * Convert GNU-style `\`..'` quotes to markdown style in API docs This will render correctly. 2023-04-07 13:55:28 +00:00			`/**`
			`* Helper function to generate args that invoke $EDITOR on`
			`* filename:lineno.`
			`*/`
Backport SourcePath from the lazy-trees branch This introduces the SourcePath type from lazy-trees as an abstraction for accessing files from inputs that may not be materialized in the real filesystem (e.g. Git repositories). Currently, however, it's just a wrapper around CanonPath, so it shouldn't change any behaviour. (On lazy-trees, SourcePath is a <InputAccessor, CanonPath> tuple.) 2023-04-06 11:15:50 +00:00			`Strings editorFor(const SourcePath & file, uint32_t line);`
Split out `CmdRepl` and `editorFor` The REPL itself and the `nix repl` CLI are conceptually different things, and thus deserve to be in different files. 2023-02-04 03:42:36 +00:00
			`}`