mirror of
https://codeberg.org/ziglang/zig.git
synced 2026-05-30 12:56:37 +03:00
std.Build: improve documentation for UpdateSourceFiles step
This commit is contained in:
@@ -966,6 +966,16 @@ pub fn addWriteFiles(b: *Build) *Step.WriteFile {
|
||||
return Step.WriteFile.create(b);
|
||||
}
|
||||
|
||||
/// Creates a step for writing data to paths relative to the build root,
|
||||
/// mutating the project's source files.
|
||||
///
|
||||
/// This build step was designed not to be used during the normal build
|
||||
/// process, but rather as a utility run by a developer with intention to
|
||||
/// update source files, which will then be committed to version control.
|
||||
///
|
||||
/// Example use cases:
|
||||
/// * precompiling assets which are tracked by version control
|
||||
/// * snapshot testing
|
||||
pub fn addUpdateSourceFiles(b: *Build) *Step.UpdateSourceFiles {
|
||||
return Step.UpdateSourceFiles.create(b);
|
||||
}
|
||||
|
||||
@@ -1,8 +1,3 @@
|
||||
//! Writes data to paths relative to the package root, effectively mutating the
|
||||
//! package's source files. Be careful with the latter functionality; it should
|
||||
//! not be used during the normal build process, but as a utility run by a
|
||||
//! developer with intention to update source files, which will then be
|
||||
//! committed to version control.
|
||||
const UpdateSourceFiles = @This();
|
||||
|
||||
const std = @import("std");
|
||||
|
||||
Reference in New Issue
Block a user