summaryrefslogtreecommitdiff
path: root/README.markdown
AgeCommit message (Collapse)Author
2013-12-12(maint) Update README stating stdlib 4.x supports Puppet 2.7.xJeff McCune
Without this patch there is a disconnect between the documentation in the README and our decision to not merge pull requests into the 4.x series that break compatibility with Puppet 2.7.x For example: @jeffmccune I think the real issue here is that "policy" is out of sync with the documentation. The README claims that 4.x does not support puppet 2.7.x, yet the "policy" is not to merge patches that break 2.7.x. Due to that I'm sure there are a lot of 2.7.x installations out there that have a 4.x version of stdlib installed. That's going to cause a rather rude surprise if some future version of 4.x stops working where a prior minor release was functioning. I'd like to suggest that the documentation be changed to reflect 4.x supporting 2.7.x and that a new major version bump is made when 2.7.x support can in fact be dropped. An alternative solution would be update the README with a note to developers about the kinda/sorta/maybe/fishy/quasi support of 2.7.x. Please also see this discussion: https://github.com/puppetlabs/puppetlabs-stdlib/pull/176#issuecomment-30251414
2013-12-09(#23381) add is_bool() functionJoshua Hoblitt
2013-11-30Remove unintentional link from READMEGarrett Honeycutt
Markdown interprets [] folowed by () as a link, which was a 404 and not the intention of the original author. This patch ensures that the document reads as intended, without the link.
2013-10-25Fixed 'separator' typosTehmasp Chaudhri
2013-09-11Minor grammar fixSpencer Krum
2013-09-04(maint) fix RST formatting of has_interface_with code examplesfloatingatoll
2013-08-14small fix to delete_values_spec.rb and README.markdownPaweł Tomulik
2013-08-05added delete_values() and delete_undef_values() functionsPaweł Tomulik
2013-06-27ensure_resource: fix documentation typoChris Boot
2013-05-24Adding base64 functionfiddyspence
Adding base64 function and spec test. Included a bonus fix to validate_slength_spec.rb to put the expectation message in the right place.
2013-05-18Trivial documentation fixRohan Sheth
2013-05-13(#20684) Add array comparison functions, difference, intersection and union.Alex Cline
Included is code, tests and documentation for the difference, intersection and union functions for comparing arrays.
2013-05-03(#20548) Allow an array of resource titles to be passed into the ↵Alex Cline
ensure_resource function This patch allows an array of resource titles to be passed into the ensure_resource function. Each item in the array will be checked for existence and will be created if it doesn't already exist.
2013-05-02Add a dirname functionRaphaël Pinson
2013-04-29(maint) Fix a small typo in hash() descriptionMark Smith-Guerrero
2013-04-12adds compatibility matrixGarrett Honeycutt
2013-04-11Fix README function documentationJeff McCune
Without this patch some core puppet functions leaked into the documentation for the functions contained in stdlib. This patch removes them and cleans up some of the formatting.
2013-04-11Update function documentation for 4.0.0Jeff McCune
Without this patch the function documentation is out of sync with the functions contained in the standard library. This commit updates the functions. I generated the list using this sequence: cd ~/src/puppet git checkout 3.1.1 bundle exec puppet doc -r function > /tmp/puppet_functions.txt cd ~/src/stdlib bundle exec puppet doc -r function > /tmp/stdlib_functions.txt diff -U2 puppet_functions.txt stdlib_functions.txt | grep '^+' | perl -ple 's/^\+//' > functions.txt I then replaced the README function documentation with the contents of functions.txt which contains only the functions contained in stdlib.
2013-04-11Update Modulefile, README, CHANGELOG for stdlib-4.0.0Jeff McCune
2013-03-26prefix: fix doc typo Examles -> ExamplesRichard Soderberg
2013-03-26add suffix function to accompany the prefix functionRichard Soderberg
2013-03-19Add floor function implementation and unit testsKristof Willaert
2013-03-04Add missing documentation for validate_augeas and validate_cmd to ↵Raphaël Pinson
README.markdown
2013-02-12(#19201) Add concat function to join two arraysfatmcgav
Without this patch applied there is no easy way to append one array to another. This is a problem because it is often desirable to join two arrays without flattening the contents into a single, one dimensional array. This patch addresses the problem by adding a `concat()` function which takes two arguments. The arguments will be concatenated together and a new array returned to the caller. Reviewed-by: Jeff McCune <jeff@puppetlabs.com>
2013-01-09Add getparam function to get defined resource parametersJaka Hudoklin
As far as i know there's no other puppet-dsl-like way to get parameter of defined resource, so that's why i implemented getparam function, which takes resource reference and parameter name and returns parameter value. Here's another example why this function is really useful: define config($path, $config_param1, $config_param2) { } define example_resource($config) { $path = getparam($config, "path") notice("Path is $path") } define example_resource2($example_resource, $config = getparam($example_resource, "config")) { $config_param1 = getparam($config, "config_param1") notice("Config parameter is $config_param1") } define example_resource3($example_resource, $config = getparam($example_resource, "config")) { $config_param2 = getparam($config, "config_param2") notice("Config parameter is $config_param2") } class test_getparam { config { "config_instance": path => "/some/config/path", config_param1 => "someconfigtext1", config_param2 => "someconfigtext2", } example_resource { "example_resource_instance": config => Config["config_instance"] } example_resource2 { "example_resource_instance": example_resource => Example_resource["example_resource_instance"] } example_resource3 { "example_resource_instance": example_resource => Example_resource2["example_resource_instance"] } } class { "test_getparam": }
2013-01-05(maint) Add Travis CI SupportJeff McCune
Without this patch stdlib has Travis CI configuration files, but they don't seem to completely specify the dependency versions and the build matrix. This patch addresses the problem by putting the dependency information in the conventional Gemfile location. This patch should coincide with enabling Travis CI support for pull requests. A build status image is also included in the project README.
2012-12-04Clarify that stdlib 3 supports Puppet 3Jeff McCune
Minor clarification to the compatibility section of the README.
2012-08-30Merge branch '3.x'Jeff McCune
* 3.x: (Maint) Remove core function documentation from README Conflicts: README.markdown
2012-08-30(Maint) Remove core function documentation from READMEJeff McCune
Without this patch the README contains the documentation for core functions shipped in Puppet in addition to the functions shipped in stdlib. This is a problem because it's confusing for end users trying to get started with puppet. This patch makes it so only the stdlib functions are included.
2012-08-30Fix some logical inconsistencies in READMEPaul Tötterman
2012-08-19(#14422) Update README to include the bug tracker URL.Eric Sorenson
As reported, it is indeed difficult to navigate directly to the correct part of Redmine for a particular sub-project. This commit puts the issue tracker URL front and center.
2012-08-17(#14422) Update README to include the bug tracker URL.Eric Sorenson
As reported, it is indeed difficult to navigate directly to the correct part of Redmine for a particular sub-project. This commit puts the issue tracker URL front and center.
2012-08-16(Maint) Update README for 3.0.0Jeff McCune
This commit updates the README for 3.0.0 by taking a function list produced with `puppet doc -r function` _without_ stdlib in the `$LOAD_PATH` and then filtering out the native functions by executing `puppet doc -r function` _with_ stdlib/lib in the `$LOAD_PATH` and then running `comm -13 core_functions.txt all_functions.txt`
2012-07-12(#2157) Update README about facts_dot_dJeff McCune
2011-12-30(maint) Add semantic versioning info to READMEJeff McCune
This patch adds semantic versioning information to the README of this module. This information is missing and unclear without this patch. This should help clarify the support matrix for the Standard Library as it relates to Puppet Enterprise released versions.
2011-08-18Update CHANGELOG, README and Modulefile for v2.1.1Jeff McCune
2011-08-17Update CHANGELOG, Modulefile and README for 2.1.0Jeff McCune
2011-08-04Update CHANGELOG and README for 1.0.0Jeff McCune
2011-06-21Update README with getvar() and validate_hash()Jeff McCune
The README now provides quick examples of how to take advantage of the getvar() and validate_hash() functions included in this release of the stdlib.
2011-05-24Update README with target versionsJeff McCune
Also add the list of things this module will likely contain.
2011-05-24Initial commitJeff McCune