Update doc comments and readmes for zcl -> HCL.

This commit is contained in:
Martin Atkins 2017-09-11 16:56:31 -07:00
parent a3ec0f1156
commit 46b20d40af
10 changed files with 27 additions and 27 deletions

View File

@ -1,7 +1,7 @@
# zcl Extensions
# HCL Extensions
This directory contains some packages implementing some extensions to zcl
that add features by building on the core API in the main zcl package.
This directory contains some packages implementing some extensions to HCL
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
to specific callers. Generally these make the language more expressive at

View File

@ -1,9 +1,9 @@
// 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:
//
// include {
// path = "./foo.zcl"
// path = "./foo.hcl"
// }
//
// The processing of the given path is delegated to the calling application,

View File

@ -1,8 +1,8 @@
// Package userfunc implements a zcl extension that allows user-defined
// functions in zcl configuration.
// Package userfunc implements a HCL extension that allows user-defined
// functions in HCL configuration.
//
// 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.
//
// The function declaration syntax looks like this:

View File

@ -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
// configuration and then accessing the resulting data via native Go

View File

@ -1,7 +1,7 @@
// Package zclsyntax contains the parser, AST, etc for zcl's native language,
// as opposed to the JSON variant and the HCL/HIL shim.
// Package hclsyntax contains the parser, AST, etc for zcl's native language,
// as opposed to the JSON variant.
//
// In normal use applications should rarely depend on this package directly,
// instead preferring the higher-level interface of the main zcl page and
// its companion zclparse.
// instead preferring the higher-level interface of the main hcl package and
// its companion hclparse.
package hclsyntax

View File

@ -1,8 +1,8 @@
// 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
// Package json is the JSON parser for HCL. It parses JSON files and returns
// implementations of the core HCL structural interfaces in terms of the
// JSON data inside.
//
// 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.
package json

View File

@ -1,12 +1,12 @@
// Package zcldec provides a higher-level API for unpacking the content of
// zcl bodies, implemented in terms of the low-level "Content" API exposed
// Package hcldec provides a higher-level API for unpacking the content of
// HCL bodies, implemented in terms of the low-level "Content" API exposed
// by the bodies themselves.
//
// It allows decoding an entire nested configuration in a single operation
// 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
// 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.
package hcldec

View File

@ -1,4 +1,4 @@
// Package zcled provides functionality intended to help an application
// that embeds zcl to deliver relevant information to a text editor or IDE
// Package hcled provides functionality intended to help an application
// that embeds HCL to deliver relevant information to a text editor or IDE
// for navigating around and analyzing configuration files.
package hcled

View File

@ -1,5 +1,5 @@
// Package zcltest contains utilities that aim to make it more convenient
// to write tests of code that interacts with the zcl API.
// Package hcltest contains utilities that aim to make it more convenient
// 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
// convenience of use over all other concerns.

View File

@ -1,7 +1,7 @@
// Package zclwrite deals with the problem of generating zcl configuration
// and of making specific surgical changes to existing zcl configurations.
// Package hclwrite deals with the problem of generating HCL configuration
// 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
// are preserved when unchanged.
package hclwrite