opentofu/internal/replacefile/doc.go

// Package replacefile is a small helper package focused directly at the
// problem of atomically "renaming" one file over another one.
//
// On Unix systems this is the standard behavior of the rename function, but
// the equivalent operation on Windows requires some specific operation flags
// which this package encapsulates.
//
// This package uses conditional compilation to select a different
// implementation for Windows vs. all other platforms. It may therefore
// require further fiddling in future if Terraform is ported to another
// OS that is neither Unix-like nor Windows.
package replacefile
internal/depsfile: Factor out our atomic file replacement logic This originated in the cliconfig code to write out credentials files. The Windows implementation of this in particular was quite onerous to get right because it needs a very specific sequence of operations to avoid running into exclusive file locks, and so by factoring this out with only cosmetic modification we can avoid repeating all of that engineering effort for other atomic file writing use-cases. 2020-10-12 19:15:42 -05:00			`// Package replacefile is a small helper package focused directly at the`
			`// problem of atomically "renaming" one file over another one.`
			`//`
			`// On Unix systems this is the standard behavior of the rename function, but`
			`// the equivalent operation on Windows requires some specific operation flags`
			`// which this package encapsulates.`
			`//`
			`// This package uses conditional compilation to select a different`
			`// implementation for Windows vs. all other platforms. It may therefore`
			`// require further fiddling in future if Terraform is ported to another`
			`// OS that is neither Unix-like nor Windows.`
			`package replacefile`