hcl/ext/include/doc.go

// Package include implements a HCL extension that allows inclusion of
// one HCL body into another using blocks of type "include", with the following
// structure:
//
//     include {
//       path = "./foo.hcl"
//     }
//
// The processing of the given path is delegated to the calling application,
// allowing it to decide how to interpret the path and which syntaxes to
// support for referenced files.
package include
ext/include: update stale reference to "zcl" 2018-01-27 10:33:20 -08:00			`// Package include implements a HCL extension that allows inclusion of`
Update doc comments and readmes for zcl -> HCL. 2017-09-11 16:56:31 -07:00			`// one HCL body into another using blocks of type "include", with the following`
ext/include: extension for including bodies into other bodies This package implements a language extension that allows configuration authors to include the content of another file into a body, using syntax like this: include { path = "./foo.zcl" } This is implemented as a transform.Transformer so that it can be used as part of a transform chain when decoding nested block structures to allow includes at any arbitrary point. This capability is not built into the language because certain applications will offer higher-level constructs for connecting multiple separate config files, which may e.g. have a separate evaluation scope for each file, etc. 2017-07-27 18:15:56 -07:00			`// structure:`
			`//`
			`// include {`
Update doc comments and readmes for zcl -> HCL. 2017-09-11 16:56:31 -07:00			`// path = "./foo.hcl"`
ext/include: extension for including bodies into other bodies This package implements a language extension that allows configuration authors to include the content of another file into a body, using syntax like this: include { path = "./foo.zcl" } This is implemented as a transform.Transformer so that it can be used as part of a transform chain when decoding nested block structures to allow includes at any arbitrary point. This capability is not built into the language because certain applications will offer higher-level constructs for connecting multiple separate config files, which may e.g. have a separate evaluation scope for each file, etc. 2017-07-27 18:15:56 -07:00			`// }`
			`//`
			`// The processing of the given path is delegated to the calling application,`
			`// allowing it to decide how to interpret the path and which syntaxes to`
			`// support for referenced files.`
			`package include`