Skip to content

Commit

Permalink
Merge pull request #1929 from nickanderson/better-xref-common-attribu…
Browse files Browse the repository at this point in the history
…tes/3.10

Swap common-body-attributes-include with See also xref
  • Loading branch information
nickanderson committed Sep 13, 2018
2 parents 34f8124 + 29cff8f commit 96d27c9
Show file tree
Hide file tree
Showing 18 changed files with 34 additions and 38 deletions.
2 changes: 2 additions & 0 deletions reference/promise-types/access.markdown
Expand Up @@ -442,6 +442,8 @@ Here are the built-in `report_data_select` bodies `default_data_select_host()` a

[%CFEngine_include_snippet(controls/reports.cf, .+default_data_select_policy_hub, \})%]

**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

**History:** Introduced in Enterprise 3.5.0

#### metatags_exclude
Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/commands.markdown
Expand Up @@ -181,7 +181,7 @@ as a non-privileged user inside an isolated directory tree.
}
```

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### useshell

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/databases.markdown
Expand Up @@ -152,7 +152,7 @@ a hierarchy of depth 1.

**Type:** `body database_server`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### db_server_owner

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/edit_line.markdown
Expand Up @@ -273,7 +273,7 @@ and `select_end` regular expressions. If the beginning and ending regular
expressions match more than one region only the first region will be
selected for editing.

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### include_start_delimiter

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/edit_line/delete_lines.markdown
Expand Up @@ -44,7 +44,7 @@ promise.

**Type:** `body delete_select`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### delete_if_startwith_from_list

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/edit_line/field_edits.markdown
Expand Up @@ -115,7 +115,7 @@ ordering the items within them.
}
```

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### allow_blank_fields

Expand Down
10 changes: 2 additions & 8 deletions reference/promise-types/edit_line/insert_lines.markdown
Expand Up @@ -204,7 +204,7 @@ file:

**Type:** `body insert_select`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### insert_if_startwith_from_list

Expand Down Expand Up @@ -360,13 +360,7 @@ found in the secondary file, it is inserted into the file being edited.

**Type:** `body location`

**See Also:**
[`location` bodies in the standard library](reference-standard-library-files.html#location-bodies)
[`start` location body in the standard library](reference-standard-library-files.html#location-bodies)
[`before(srt)` location body in the standard library](reference-standard-library-files.html#before)
[`after(srt)` location body in the standard library](reference-standard-library-files.html#after)

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes], [`location` bodies in the standard library](reference-standard-library-files.html#location-bodies), [`start` location body in the standard library](reference-standard-library-files.html#location-bodies), [`before(srt)` location body in the standard library](reference-standard-library-files.html#before), [`after(srt)` location body in the standard library](reference-standard-library-files.html#after)

#### before_after

Expand Down
Expand Up @@ -49,7 +49,7 @@ pattern will match.

**Type:** `body replace_with`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### occurrences

Expand Down
22 changes: 11 additions & 11 deletions reference/promise-types/files.markdown
Expand Up @@ -295,7 +295,7 @@ body perms null_perms_body {
}
```

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### aces

Expand Down Expand Up @@ -617,7 +617,7 @@ that do not have a clear inheritance policy.

**Type:** `body changes`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### hash

Expand Down Expand Up @@ -739,7 +739,7 @@ The copy_from body specifies the details for making remote copies.
are re-used. Currently connection caching is done per pass in each bundle
activation.

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### source

Expand Down Expand Up @@ -900,7 +900,7 @@ body copy_from example
}
```

**See also:** [`default_repository` in ```body agent control```][cf-agent#default_repository], [`edit_backup` in ```body edit_defaults```][files#edit_backup]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes], [`default_repository` in ```body agent control```][cf-agent#default_repository], [`edit_backup` in ```body edit_defaults```][files#edit_backup]

#### encrypt

Expand Down Expand Up @@ -1372,7 +1372,7 @@ comparison or linking operations).

**Type:** `body delete`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### dirlinks

Expand Down Expand Up @@ -1477,7 +1477,7 @@ present. If there is no `delete` body then files (and directories) are

**Type:** `body depth_search`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### depth

Expand Down Expand Up @@ -1630,7 +1630,7 @@ devices

**Type:** `body edit_defaults`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### edit_backup

Expand Down Expand Up @@ -2316,7 +2316,7 @@ Seas include caribbean, dead, black, coral,.

**Type:** `body file_select`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### leaf_name

Expand Down Expand Up @@ -2732,7 +2732,7 @@ specifying `fifo` in `file_type`.

**Type:** `body link_from`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### copy_patterns

Expand Down Expand Up @@ -3012,7 +3012,7 @@ separator.

**Type:** `body perms`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### bsdflags

Expand Down Expand Up @@ -3146,7 +3146,7 @@ This is ignored on Windows, as the permission model uses ACLs.

**Type:** `body rename`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### disable

Expand Down
4 changes: 2 additions & 2 deletions reference/promise-types/guest_environments.markdown
Expand Up @@ -87,7 +87,7 @@ This attribute is required.

**Type:** `body environment_interface`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### env_addresses

Expand Down Expand Up @@ -175,7 +175,7 @@ identifier used as 'promiser' by the virtualization manager.

**Type:** `body environment_resources`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### env_cpus

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/measurements.markdown
Expand Up @@ -211,7 +211,7 @@ This is an arbitrary string used in documentation only.

**Type:** `body match_value`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### select_line_matching

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/packages-deprecated.markdown
Expand Up @@ -265,7 +265,7 @@ packages:

**Type:** `body package_method`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### package_add_command

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/packages.markdown
Expand Up @@ -156,7 +156,7 @@ platform dependent, see
and Common Control. The name of the body is expected to be the same as the name
of the package module inside `/var/cfengine/modules/packages`.

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### default_options

Expand Down
4 changes: 2 additions & 2 deletions reference/promise-types/processes.markdown
Expand Up @@ -99,7 +99,7 @@ promise together with that class.

**Type:** `body process_count`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### in_range_define

Expand Down Expand Up @@ -168,7 +168,7 @@ failure to be kept.

**Type:** `body process_select`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### command

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/reports.markdown
Expand Up @@ -91,7 +91,7 @@ and has no effect. Deprecated in CFEngine 3.4.

**Type:** `body printfile`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### file_to_print

Expand Down
4 changes: 2 additions & 2 deletions reference/promise-types/services.markdown
Expand Up @@ -302,13 +302,13 @@ services:

**Type:** `body service_method`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]

`service_method` bodies have access to `$(this.promiser)` (the promised service)
and `$(this.service_policy)` (the policy state the service should have).

**Notes:** `service_bundle` is not used when `service_type` is ```windows```.

**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### service_args

**Description:** Parameters for starting the service as command
Expand Down
4 changes: 2 additions & 2 deletions reference/promise-types/storage.markdown
Expand Up @@ -56,7 +56,7 @@ Storage promises refer to disks and filesystem properties.

**Type:** `body mount`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### edit_fstab

Expand Down Expand Up @@ -183,7 +183,7 @@ options must be legal options for the system mount commands.

**Type:** `body volume`

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### check_foreign

Expand Down
2 changes: 1 addition & 1 deletion reference/promise-types/users.markdown
Expand Up @@ -205,7 +205,7 @@ that contains information about a user's password.
}
```

[%CFEngine_include_markdown(common-body-attributes-include.markdown)%]
**See also:** [Common Body Attributes][Promise Types and Attributes#Common Body Attributes]

#### format

Expand Down

0 comments on commit 96d27c9

Please sign in to comment.