Update doc comments and readmes for zcl -> HCL.
This commit is contained in:
parent
a3ec0f1156
commit
46b20d40af
@ -1,7 +1,7 @@
|
|||||||
# zcl Extensions
|
# HCL Extensions
|
||||||
|
|
||||||
This directory contains some packages implementing some extensions to zcl
|
This directory contains some packages implementing some extensions to HCL
|
||||||
that add features by building on the core API in the main zcl package.
|
that add features by building on the core API in the main `hcl` package.
|
||||||
|
|
||||||
These serve as optional language extensions for use-cases that are limited only
|
These serve as optional language extensions for use-cases that are limited only
|
||||||
to specific callers. Generally these make the language more expressive at
|
to specific callers. Generally these make the language more expressive at
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
// Package include implements a zcl extension that allows inclusion of
|
// Package include implements a zcl extension that allows inclusion of
|
||||||
// one zcl body into another using blocks of type "include", with the following
|
// one HCL body into another using blocks of type "include", with the following
|
||||||
// structure:
|
// structure:
|
||||||
//
|
//
|
||||||
// include {
|
// include {
|
||||||
// path = "./foo.zcl"
|
// path = "./foo.hcl"
|
||||||
// }
|
// }
|
||||||
//
|
//
|
||||||
// The processing of the given path is delegated to the calling application,
|
// The processing of the given path is delegated to the calling application,
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
// Package userfunc implements a zcl extension that allows user-defined
|
// Package userfunc implements a HCL extension that allows user-defined
|
||||||
// functions in zcl configuration.
|
// functions in HCL configuration.
|
||||||
//
|
//
|
||||||
// Using this extension requires some integration effort on the part of the
|
// Using this extension requires some integration effort on the part of the
|
||||||
// calling application, to pass any declared functions into a zcl evaluation
|
// calling application, to pass any declared functions into a HCL evaluation
|
||||||
// context after processing.
|
// context after processing.
|
||||||
//
|
//
|
||||||
// The function declaration syntax looks like this:
|
// The function declaration syntax looks like this:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Package gozcl allows decoding zcl configurations into Go data structures.
|
// Package gohcl allows decoding HCL configurations into Go data structures.
|
||||||
//
|
//
|
||||||
// It provides a convenient and concise way of describing the schema for
|
// It provides a convenient and concise way of describing the schema for
|
||||||
// configuration and then accessing the resulting data via native Go
|
// configuration and then accessing the resulting data via native Go
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// Package zclsyntax contains the parser, AST, etc for zcl's native language,
|
// Package hclsyntax contains the parser, AST, etc for zcl's native language,
|
||||||
// as opposed to the JSON variant and the HCL/HIL shim.
|
// as opposed to the JSON variant.
|
||||||
//
|
//
|
||||||
// In normal use applications should rarely depend on this package directly,
|
// In normal use applications should rarely depend on this package directly,
|
||||||
// instead preferring the higher-level interface of the main zcl page and
|
// instead preferring the higher-level interface of the main hcl package and
|
||||||
// its companion zclparse.
|
// its companion hclparse.
|
||||||
package hclsyntax
|
package hclsyntax
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
// Package json is the JSON parser for hcl. It parses JSON files and returns
|
// Package json is the JSON parser for HCL. It parses JSON files and returns
|
||||||
// implementations of the core ZCL structural interfaces in terms of the
|
// implementations of the core HCL structural interfaces in terms of the
|
||||||
// JSON data inside.
|
// JSON data inside.
|
||||||
//
|
//
|
||||||
// This is not a generic JSON parser. Instead, it deals with the mapping from
|
// This is not a generic JSON parser. Instead, it deals with the mapping from
|
||||||
// the JSON information model to the ZCL information model, using a number
|
// the JSON information model to the HCL information model, using a number
|
||||||
// of hard-coded structural conventions.
|
// of hard-coded structural conventions.
|
||||||
package json
|
package json
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
// Package zcldec provides a higher-level API for unpacking the content of
|
// Package hcldec provides a higher-level API for unpacking the content of
|
||||||
// zcl bodies, implemented in terms of the low-level "Content" API exposed
|
// HCL bodies, implemented in terms of the low-level "Content" API exposed
|
||||||
// by the bodies themselves.
|
// by the bodies themselves.
|
||||||
//
|
//
|
||||||
// It allows decoding an entire nested configuration in a single operation
|
// It allows decoding an entire nested configuration in a single operation
|
||||||
// by providing a description of the intended structure.
|
// by providing a description of the intended structure.
|
||||||
//
|
//
|
||||||
// For some applications it may be more convenient to use the "gozcl"
|
// For some applications it may be more convenient to use the "gohcl"
|
||||||
// package, which has a similar purpose but decodes directly into native
|
// package, which has a similar purpose but decodes directly into native
|
||||||
// Go data types. zcldec instead targets the cty type system, and thus allows
|
// Go data types. hcldec instead targets the cty type system, and thus allows
|
||||||
// a cty-driven application to remain within that type system.
|
// a cty-driven application to remain within that type system.
|
||||||
package hcldec
|
package hcldec
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
// Package zcled provides functionality intended to help an application
|
// Package hcled provides functionality intended to help an application
|
||||||
// that embeds zcl to deliver relevant information to a text editor or IDE
|
// that embeds HCL to deliver relevant information to a text editor or IDE
|
||||||
// for navigating around and analyzing configuration files.
|
// for navigating around and analyzing configuration files.
|
||||||
package hcled
|
package hcled
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
// Package zcltest contains utilities that aim to make it more convenient
|
// Package hcltest contains utilities that aim to make it more convenient
|
||||||
// to write tests of code that interacts with the zcl API.
|
// to write tests for code that interacts with the HCL API.
|
||||||
//
|
//
|
||||||
// This package is intended for use only in test code. It is optimized for
|
// This package is intended for use only in test code. It is optimized for
|
||||||
// convenience of use over all other concerns.
|
// convenience of use over all other concerns.
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
// Package zclwrite deals with the problem of generating zcl configuration
|
// Package hclwrite deals with the problem of generating HCL configuration
|
||||||
// and of making specific surgical changes to existing zcl configurations.
|
// and of making specific surgical changes to existing HCL configurations.
|
||||||
//
|
//
|
||||||
// It operates at a different level of abstraction that the main zcl parser
|
// It operates at a different level of abstraction than the main HCL parser
|
||||||
// and AST, since details such as the placement of comments and newlines
|
// and AST, since details such as the placement of comments and newlines
|
||||||
// are preserved when unchanged.
|
// are preserved when unchanged.
|
||||||
package hclwrite
|
package hclwrite
|
||||||
|
Loading…
Reference in New Issue
Block a user