Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: only list exported fields in param and export sections #561

Merged
merged 1 commit into from
Dec 27, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/resources/docker.container.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "docker.container"
slug: "docker-container"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/docker.image.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "docker.image"
slug: "docker-image"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/docker.network.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "docker.network"
slug: "docker-network"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/docker.volume.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "docker.volume"
slug: "docker-volume"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/file.content.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "file.content"
slug: "file-content"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/file.directory.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "file.directory"
slug: "file-directory"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/file.fetch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "file.fetch"
slug: "file-fetch"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/file.mode.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "file.mode"
slug: "file-mode"
date: "2016-12-19T14:58:57-06:00"
date: "2016-12-22T11:43:14-06:00"
menu:
main:
parent: resources
Expand Down
18 changes: 9 additions & 9 deletions docs/content/resources/file.owner.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "file.owner"
slug: "file-owner"
date: "2016-12-19T11:36:04-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand All @@ -11,7 +11,10 @@ menu:
Owner sets the file and group ownership of a file or directory. If
`recursive` is set to true and `destination` is a directory, then it will
also recursively change ownership of all files and subdirectories. Symlinks
are ignored.
are ignored. If the file or directory does not exist during the plan phase
of application the differences will be calculated during application.
Otherwise changes will be limited to the files identified during the plan
phase of application.


## Example
Expand All @@ -21,7 +24,7 @@ are ignored.
new file, then changing the ownership of that file to a different group. */

file.content "to-change" {
destination = "to-change"
destination = "tochange"
}

task.query "existing-group" {
Expand Down Expand Up @@ -64,21 +67,21 @@ recursively. Symlinks are not followed.
- `uid` (optional int)


Only one of `user` may be set.
Only one of `user` or `uid` may be set.

UID specifies user-ownership by UID

- `group` (string)


Only one of `gid` may be set.
Only one of `group` or `gid` may be set.

Groupname specifies group-ownership by groupname

- `gid` (optional int)


Only one of `group` may be set.
Only one of `group` or `gid` may be set.

GID specifies group ownership by gid

Expand All @@ -87,9 +90,6 @@ recursively. Symlinks are not followed.
Verbose specifies that when performing recursive updates, a diff should be
shown for each file to be changed

- osProxy (OSProxy)



## Exported Fields

Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/filesystem.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "filesystem"
slug: "filesystem"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/lvm.logicalvolume.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "lvm.logicalvolume"
slug: "lvm-logicalvolume"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/lvm.volumegroup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "lvm.volumegroup"
slug: "lvm-volumegroup"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/module.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "module"
slug: "module"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/package.apt.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "package.apt"
slug: "package-apt"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/package.rpm.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "package.rpm"
slug: "package-rpm"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/param.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "param"
slug: "param"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/task.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "task"
slug: "task"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/task.query.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "task.query"
slug: "task-query"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/user.group.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "user.group"
slug: "user-group"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/user.user.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "user.user"
slug: "user-user"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/wait.port.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "wait.port"
slug: "wait-port"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
2 changes: 1 addition & 1 deletion docs/content/resources/wait.query.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "wait.query"
slug: "wait-query"
date: "2016-12-19T14:58:58-06:00"
date: "2016-12-22T11:43:15-06:00"
menu:
main:
parent: resources
Expand Down
12 changes: 8 additions & 4 deletions docs/extract.go
Original file line number Diff line number Diff line change
Expand Up @@ -212,13 +212,13 @@ func (e *ExportExtractor) Visit(node ast.Node) (w ast.Visitor) {
}
return e
case *ast.Field:
typ := stringify(n.Type, "")
doc := (&TypeExtractor{}).Docs(n.Doc, n.Comment)

if n.Names == nil {
if n.Names == nil || !ast.IsExported(n.Names[0].String()) {
return e
}

typ := stringify(n.Type, "")
doc := (&TypeExtractor{}).Docs(n.Doc, n.Comment)

field := &Field{
Name: n.Names[0].String(),
Type: typ,
Expand Down Expand Up @@ -314,6 +314,10 @@ func (te *TypeExtractor) Visit(node ast.Node) (w ast.Visitor) {
return te

case *ast.Field:
if !ast.IsExported(n.Names[0].String()) {
return te
}

typ := stringify(n.Type, "optional")
doc := te.Docs(n.Doc, n.Comment)
if strings.Contains(typ, "duration") {
Expand Down