Skip to content

Commit

Permalink
Update REFERENCE.md with pre-release version of Puppet Strings.
Browse files Browse the repository at this point in the history
  • Loading branch information
danielparks committed Sep 27, 2022
1 parent 9f3d363 commit 94bacd8
Showing 1 changed file with 15 additions and 33 deletions.
48 changes: 15 additions & 33 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,12 @@

### Resource types

#### Public Resource types


#### Private Resource types

* `rustup_internal`: Manage a user’s Rust installation with `rustup`

### Functions

#### Public Functions


#### Private Functions

* `rustup::home`: Return the default home directory for a user on this OS
Expand Down Expand Up @@ -95,23 +89,23 @@ Data type: `Boolean`

Whether or not to manage `$user` user.

Default value: ``true``
Default value: `true`

##### <a name="-rustup--global--purge_toolchains"></a>`purge_toolchains`

Data type: `Boolean`

Whether or not to uninstall toolchains that aren’t managed by Puppet.

Default value: ``false``
Default value: `false`

##### <a name="-rustup--global--purge_targets"></a>`purge_targets`

Data type: `Boolean`

Whether or not to uninstall targets that aren’t managed by Puppet.

Default value: ``false``
Default value: `false`

##### <a name="-rustup--global--dist_server"></a>`dist_server`

Expand All @@ -120,7 +114,7 @@ Data type: `Optional[Stdlib::HTTPUrl]`
Override `RUSTUP_DIST_SERVER`. Set to `'https://dev-static.rust-lang.org'`
to install pre-release toolchains.

Default value: ``undef``
Default value: `undef`

##### <a name="-rustup--global--home"></a>`home`

Expand Down Expand Up @@ -220,7 +214,7 @@ Data type: `Optional[String[1]]`

Which toolchain should be the default.

Default value: ``undef``
Default value: `undef`

##### <a name="-rustup--toolchains"></a>`toolchains`

Expand All @@ -236,7 +230,7 @@ Data type: `Boolean`

Whether or not to uninstall toolchains that aren’t managed by Puppet.

Default value: ``false``
Default value: `false`

##### <a name="-rustup--targets"></a>`targets`

Expand All @@ -257,7 +251,7 @@ Data type: `Boolean`

Whether or not to uninstall targets that aren’t managed by Puppet.

Default value: ``false``
Default value: `false`

##### <a name="-rustup--dist_server"></a>`dist_server`

Expand All @@ -266,7 +260,7 @@ Data type: `Optional[Stdlib::HTTPUrl]`
Override `RUSTUP_DIST_SERVER`. Set to `'https://dev-static.rust-lang.org'`
to install pre-release toolchains.

Default value: ``undef``
Default value: `undef`

##### <a name="-rustup--home"></a>`home`

Expand Down Expand Up @@ -300,7 +294,7 @@ Data type: `Boolean`
Whether or not to let `rustup` modify the user’s `PATH` in their shell init
scripts. This only affects the initial installation and removal.

Default value: ``true``
Default value: `true`

##### <a name="-rustup--installer_source"></a>`installer_source`

Expand Down Expand Up @@ -363,7 +357,7 @@ Data type: `Optional[String[1]]`

Only run when if this path does not exist. (See [`exec`] documentation.)

Default value: ``undef``
Default value: `undef`

##### <a name="-rustup--exec--environment"></a>`environment`

Expand All @@ -380,23 +374,23 @@ Data type: `Rustup::OptionalStringOrArray`

Only run when `$onlyif` returns success. (See [`exec`] documentation.)

Default value: ``undef``
Default value: `undef`

##### <a name="-rustup--exec--refreshonly"></a>`refreshonly`

Data type: `Boolean`

Only run this when it receives an event. (See [`exec`] documentation.)

Default value: ``false``
Default value: `false`

##### <a name="-rustup--exec--unless"></a>`unless`

Data type: `Rustup::OptionalStringOrArray`

Only run when `$unless` returns failure. (See [`exec`] documentation.)

Default value: ``undef``
Default value: `undef`

##### <a name="-rustup--exec--home"></a>`home`

Expand Down Expand Up @@ -650,29 +644,17 @@ it causes an update, i.e. when `ensure => latest` is set.

Default value: `'default'`

## Resource types

## Functions

## Data types

### <a name="Rustup--OptionalStringOrArray"></a>`Rustup::OptionalStringOrArray`

Convenience type to make params easier to read

Alias of

```puppet
Variant[Undef, String[1], Array[String[1]]]
```
Alias of `Variant[Undef, String[1], Array[String[1]]]`

### <a name="Rustup--Profile"></a>`Rustup::Profile`

`default` is a keyword in Puppet, so it must always be wrapped in quotes.

Alias of

```puppet
Enum[minimal, 'default', complete]
```
Alias of `Enum[minimal, 'default', complete]`

0 comments on commit 94bacd8

Please sign in to comment.