From 46b20d40afa426280172aa48e070b16bbb5727b9 Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Mon, 11 Sep 2017 16:56:31 -0700 Subject: [PATCH] Update doc comments and readmes for zcl -> HCL. --- ext/README.md | 6 +++--- ext/include/doc.go | 4 ++-- ext/userfunc/doc.go | 6 +++--- gohcl/doc.go | 2 +- hcl/hclsyntax/doc.go | 8 ++++---- hcl/json/doc.go | 6 +++--- hcldec/doc.go | 8 ++++---- hcled/doc.go | 4 ++-- hcltest/doc.go | 4 ++-- hclwrite/doc.go | 6 +++--- 10 files changed, 27 insertions(+), 27 deletions(-) diff --git a/ext/README.md b/ext/README.md index 655e571..f7f2bc9 100644 --- a/ext/README.md +++ b/ext/README.md @@ -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 diff --git a/ext/include/doc.go b/ext/include/doc.go index efcf0af..374911f 100644 --- a/ext/include/doc.go +++ b/ext/include/doc.go @@ -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, diff --git a/ext/userfunc/doc.go b/ext/userfunc/doc.go index b8cdf09..e4461d4 100644 --- a/ext/userfunc/doc.go +++ b/ext/userfunc/doc.go @@ -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: diff --git a/gohcl/doc.go b/gohcl/doc.go index b7a939f..6535416 100644 --- a/gohcl/doc.go +++ b/gohcl/doc.go @@ -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 diff --git a/hcl/hclsyntax/doc.go b/hcl/hclsyntax/doc.go index c4ec785..8db1157 100644 --- a/hcl/hclsyntax/doc.go +++ b/hcl/hclsyntax/doc.go @@ -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 diff --git a/hcl/json/doc.go b/hcl/json/doc.go index 6b42ba4..4943f9b 100644 --- a/hcl/json/doc.go +++ b/hcl/json/doc.go @@ -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 diff --git a/hcldec/doc.go b/hcldec/doc.go index 8a89817..23bfe54 100644 --- a/hcldec/doc.go +++ b/hcldec/doc.go @@ -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 diff --git a/hcled/doc.go b/hcled/doc.go index d5916f1..1a80144 100644 --- a/hcled/doc.go +++ b/hcled/doc.go @@ -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 diff --git a/hcltest/doc.go b/hcltest/doc.go index ccb4e1c..3abad00 100644 --- a/hcltest/doc.go +++ b/hcltest/doc.go @@ -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. diff --git a/hclwrite/doc.go b/hclwrite/doc.go index 148a8d7..6f4109d 100644 --- a/hclwrite/doc.go +++ b/hclwrite/doc.go @@ -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