forked from hashicorp/hcl
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update doc comments and readmes for zcl -> HCL.
- Loading branch information
1 parent
a3ec0f1
commit 46b20d4
Showing
10 changed files
with
27 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |